@itentialopensource/adapter-google_drive
Version:
This adapter integrates with system described as: google drive
1,539 lines • 251 kB
YAML
openapi: 3.0.0
info:
title: Drive API
description: Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
contact:
name: Google
url: https://google.com
version: 'v3'
servers:
- url: https://www.googleapis.com/drive/v3
variables: {}
- url: https://accounts.google.com/o/oauth2
variables: {}
paths:
/about:
get:
tags:
- about
summary: drive.about.get
description: Gets information about the user, the user's Drive, and system capabilities.
operationId: drive.about.get
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/About'
- description: Information about the user, the user's Drive, and system capabilities.
deprecated: false
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
/changes:
get:
tags:
- changes
summary: drive.changes.list
description: Lists the changes for a user or shared drive.
operationId: drive.changes.list
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: pageToken
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: driveId
in: query
description: The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
style: form
explode: true
schema:
type: string
- name: includeCorpusRemovals
in: query
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.
style: form
explode: true
schema:
type: boolean
- name: includeItemsFromAllDrives
in: query
description: Whether both My Drive and shared drive items should be included in results.
style: form
explode: true
schema:
type: boolean
- name: includePermissionsForView
in: query
description: Specifies which additional view's permissions to include in the response. Only 'published' is supported.
style: form
explode: true
schema:
type: string
- name: includeRemoved
in: query
description: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
style: form
explode: true
schema:
type: boolean
- name: includeTeamDriveItems
in: query
description: Deprecated use includeItemsFromAllDrives instead.
style: form
explode: true
schema:
type: boolean
- name: pageSize
in: query
description: The maximum number of changes to return per page.
style: form
explode: true
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
- name: restrictToMyDrive
in: query
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.
style: form
explode: true
schema:
type: boolean
- name: spaces
in: query
description: A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
style: form
explode: true
schema:
type: string
- name: supportsAllDrives
in: query
description: Whether the requesting application supports both My Drives and shared drives.
style: form
explode: true
schema:
type: boolean
- name: supportsTeamDrives
in: query
description: Deprecated use supportsAllDrives instead.
style: form
explode: true
schema:
type: boolean
- name: teamDriveId
in: query
description: Deprecated use driveId instead.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeList'
- description: A list of changes for a user.
deprecated: false
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
/changes/startPageToken:
get:
tags:
- changes
summary: drive.changes.getStartPageToken
description: Gets the starting pageToken for listing future changes.
operationId: drive.changes.getStartPageToken
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: driveId
in: query
description: The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.
style: form
explode: true
schema:
type: string
- name: supportsAllDrives
in: query
description: Whether the requesting application supports both My Drives and shared drives.
style: form
explode: true
schema:
type: boolean
- name: supportsTeamDrives
in: query
description: Deprecated use supportsAllDrives instead.
style: form
explode: true
schema:
type: boolean
- name: teamDriveId
in: query
description: Deprecated use driveId instead.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/StartPageToken'
deprecated: false
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
/changes/watch:
post:
tags:
- changes
summary: drive.changes.watch
description: Subscribes to changes for a user.
operationId: drive.changes.watch
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: pageToken
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: driveId
in: query
description: The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
style: form
explode: true
schema:
type: string
- name: includeCorpusRemovals
in: query
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.
style: form
explode: true
schema:
type: boolean
- name: includeItemsFromAllDrives
in: query
description: Whether both My Drive and shared drive items should be included in results.
style: form
explode: true
schema:
type: boolean
- name: includePermissionsForView
in: query
description: Specifies which additional view's permissions to include in the response. Only 'published' is supported.
style: form
explode: true
schema:
type: string
- name: includeRemoved
in: query
description: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
style: form
explode: true
schema:
type: boolean
- name: includeTeamDriveItems
in: query
description: Deprecated use includeItemsFromAllDrives instead.
style: form
explode: true
schema:
type: boolean
- name: pageSize
in: query
description: The maximum number of changes to return per page.
style: form
explode: true
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
- name: restrictToMyDrive
in: query
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.
style: form
explode: true
schema:
type: boolean
- name: spaces
in: query
description: A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
style: form
explode: true
schema:
type: string
- name: supportsAllDrives
in: query
description: Whether the requesting application supports both My Drives and shared drives.
style: form
explode: true
schema:
type: boolean
- name: supportsTeamDrives
in: query
description: Deprecated use supportsAllDrives instead.
style: form
explode: true
schema:
type: boolean
- name: teamDriveId
in: query
description: Deprecated use driveId instead.
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Channel'
required: false
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Channel'
- description: An notification channel used to watch for resource changes.
deprecated: false
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
/channels/stop:
post:
tags:
- channels
summary: drive.channels.stop
description: Stop watching resources through this channel
operationId: drive.channels.stop
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Channel'
required: false
responses:
'200':
description: Successful response
headers: {}
content: {}
deprecated: false
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
/files/{fileId}/comments:
get:
tags:
- comments
summary: drive.comments.list
description: Lists a file's comments.
operationId: drive.comments.list
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: fileId
in: path
description: The ID of the file.
required: true
style: simple
schema:
type: string
- name: includeDeleted
in: query
description: Whether to include deleted comments. Deleted comments will not include their original content.
style: form
explode: true
schema:
type: boolean
- name: pageSize
in: query
description: The maximum number of comments to return per page.
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
format: int32
- name: pageToken
in: query
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.
style: form
explode: true
schema:
type: string
- name: startModifiedTime
in: query
description: The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CommentList'
- description: A list of comments on a file.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.file
Oauth2c:
- https://www.googleapis.com/auth/drive.file
- Oauth2:
- https://www.googleapis.com/auth/drive.readonly
Oauth2c:
- https://www.googleapis.com/auth/drive.readonly
post:
tags:
- comments
summary: drive.comments.create
description: Creates a new comment on a file.
operationId: drive.comments.create
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: fileId
in: path
description: The ID of the file.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
required: false
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Comment'
- description: A comment on a file.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.file
Oauth2c:
- https://www.googleapis.com/auth/drive.file
/files/{fileId}/comments/{commentId}:
delete:
tags:
- comments
summary: drive.comments.delete
description: Deletes a comment.
operationId: drive.comments.delete
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: fileId
in: path
description: The ID of the file.
required: true
style: simple
schema:
type: string
- name: commentId
in: path
description: The ID of the comment.
required: true
style: simple
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content: {}
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.file
Oauth2c:
- https://www.googleapis.com/auth/drive.file
get:
tags:
- comments
summary: drive.comments.get
description: Gets a comment by ID.
operationId: drive.comments.get
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: fileId
in: path
description: The ID of the file.
required: true
style: simple
schema:
type: string
- name: commentId
in: path
description: The ID of the comment.
required: true
style: simple
schema:
type: string
- name: includeDeleted
in: query
description: Whether to return deleted comments. Deleted comments will not include their original content.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Comment'
- description: A comment on a file.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.file
Oauth2c:
- https://www.googleapis.com/auth/drive.file
- Oauth2:
- https://www.googleapis.com/auth/drive.readonly
Oauth2c:
- https://www.googleapis.com/auth/drive.readonly
patch:
tags:
- comments
summary: drive.comments.update
description: Updates a comment with patch semantics.
operationId: drive.comments.update
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: fileId
in: path
description: The ID of the file.
required: true
style: simple
schema:
type: string
- name: commentId
in: path
description: The ID of the comment.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
required: false
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Comment'
- description: A comment on a file.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.file
Oauth2c:
- https://www.googleapis.com/auth/drive.file
/drives:
get:
tags:
- drives
summary: drive.drives.list
description: Lists the user's shared drives.
operationId: drive.drives.list
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: pageSize
in: query
description: Maximum number of shared drives to return per page.
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
format: int32
- name: pageToken
in: query
description: Page token for shared drives.
style: form
explode: true
schema:
type: string
- name: q
in: query
description: Query string for searching shared drives.
style: form
explode: true
schema:
type: string
- name: useDomainAdminAccess
in: query
description: Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DriveList'
- description: A list of shared drives.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
- Oauth2:
- https://www.googleapis.com/auth/drive.readonly
Oauth2c:
- https://www.googleapis.com/auth/drive.readonly
post:
tags:
- drives
summary: drive.drives.create
description: Creates a new shared drive.
operationId: drive.drives.create
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: requestId
in: query
description: An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Drive'
required: false
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Drive'
- description: Representation of a shared drive.
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
/drives/{driveId}:
delete:
tags:
- drives
summary: drive.drives.delete
description: Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
operationId: drive.drives.delete
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
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.
style: form
explode: true
schema:
type: string
- name: oauth_token
in: query
description: OAuth 2.0 token for the current user.
style: form
explode: true
schema:
type: string
- name: prettyPrint
in: query
description: Returns response with indentations and line breaks.
style: form
explode: true
schema:
type: boolean
- name: quotaUser
in: query
description: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
style: form
explode: true
schema:
type: string
- name: userIp
in: query
description: Deprecated. Please use quotaUser instead.
style: form
explode: true
schema:
type: string
- name: driveId
in: path
description: The ID of the shared drive.
required: true
style: simple
schema:
type: string
responses:
'200':
description: Successful response
headers: {}
content: {}
deprecated: false
security:
- Oauth2:
- https://www.googleapis.com/auth/drive
Oauth2c:
- https://www.googleapis.com/auth/drive
get:
tags:
- drives
summary: drive.drives.get
description: Gets a shared drive's metadata by ID.
operationId: drive.drives.get
parameters:
- name: alt
in: query
description: Data format for the response.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/alt'
- description: Data format for the response.
- name: fields
in: query
description: Selector specifying which fields to include in a partial response.
style: form
explode: true
schema:
type: string
- name: key
in: query
description: API key. Your API key identifies your project and provides you with