{ "version": "v3", "kind": "discovery#restDescription", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/drive.file": { "description": "See, edit, create, and delete only the specific Google Drive files you use with this app" }, "https://www.googleapis.com/auth/drive.meet.readonly": { "description": "See and download your Google Drive files that were created or edited by Google Meet." }, "https://www.googleapis.com/auth/drive.metadata.readonly": { "description": "See information about your Google Drive files" }, "https://www.googleapis.com/auth/drive.photos.readonly": { "description": "View the photos, videos and albums in your Google Photos" }, "https://www.googleapis.com/auth/drive": { "description": "See, edit, create, and delete all of your Google Drive files" }, "https://www.googleapis.com/auth/drive.metadata": { "description": "View and manage metadata of files in your Google Drive" }, "https://www.googleapis.com/auth/drive.appdata": { "description": "See, create, and delete its own configuration data in your Google Drive" }, "https://www.googleapis.com/auth/drive.scripts": { "description": "Modify your Google Apps Script scripts' behavior" }, "https://www.googleapis.com/auth/drive.apps.readonly": { "description": "View your Google Drive apps" }, "https://www.googleapis.com/auth/drive.readonly": { "description": "See and download all your Google Drive files" } } } }, "mtlsRootUrl": "https://www.mtls.googleapis.com/", "servicePath": "drive/v3/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://developers.google.com/workspace/drive/", "name": "drive", "parameters": { "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "prettyPrint": { "location": "query", "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "alt": { "description": "Data format for response.", "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "quotaUser": { "type": "string", "location": "query", "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." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "key": { "location": "query", "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." } }, "baseUrl": "https://www.googleapis.com/drive/v3/", "protocol": "rest", "revision": "20260407", "basePath": "/drive/v3/", "resources": { "approvals": { "methods": { "get": { "description": "Gets an Approval by ID.", "parameterOrder": [ "fileId", "approvalId" ], "path": "files/{fileId}/approvals/{approvalId}", "parameters": { "fileId": { "location": "path", "type": "string", "description": "Required. The ID of the file the Approval is on.", "required": true }, "approvalId": { "description": "Required. The ID of the Approval.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.approvals.get", "response": { "$ref": "Approval" }, "httpMethod": "GET", "flatPath": "files/{fileId}/approvals/{approvalId}" }, "list": { "httpMethod": "GET", "flatPath": "files/{fileId}/approvals", "response": { "$ref": "ApprovalList" }, "path": "files/{fileId}/approvals", "parameters": { "fileId": { "type": "string", "location": "path", "description": "Required. The ID of the file the Approval is on.", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response." }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of Approvals to return. When not set, at most 100 Approvals will be returned.", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.approvals.list", "parameterOrder": [ "fileId" ], "description": "Lists the Approvals on a file." } } }, "apps": { "methods": { "get": { "description": "Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).", "parameterOrder": [ "appId" ], "path": "apps/{appId}", "parameters": { "appId": { "description": "The ID of the app.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.apps.readonly", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.apps.get", "response": { "$ref": "App" }, "httpMethod": "GET", "flatPath": "apps/{appId}" }, "list": { "flatPath": "apps", "httpMethod": "GET", "response": { "$ref": "AppList" }, "id": "drive.apps.list", "path": "apps", "parameters": { "appFilterExtensions": { "location": "query", "default": "", "type": "string", "description": "A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given file extensions are included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists." }, "appFilterMimeTypes": { "description": "A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given MIME types will be included in the response. If `appFilterExtensions` are provided as well, the result is a union of the two resulting app lists.", "default": "", "type": "string", "location": "query" }, "languageCode": { "description": "A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive.apps.readonly" ], "parameterOrder": [], "description": "Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info)." } } }, "comments": { "methods": { "update": { "response": { "$ref": "Comment" }, "request": { "$ref": "Comment" }, "httpMethod": "PATCH", "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "description": "Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "path": "files/{fileId}/comments/{commentId}", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "commentId": { "location": "path", "type": "string", "description": "The ID of the comment.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.comments.update" }, "list": { "description": "Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "parameterOrder": [ "fileId" ], "path": "files/{fileId}/comments", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "pageToken": { "type": "string", "location": "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." }, "startModifiedTime": { "description": "The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).", "type": "string", "location": "query" }, "includeDeleted": { "description": "Whether to include deleted comments. Deleted comments will not include their original content.", "default": "false", "type": "boolean", "location": "query" }, "pageSize": { "description": "The maximum number of comments to return per page.", "minimum": "1", "default": "20", "type": "integer", "maximum": "100", "format": "int32", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.comments.list", "response": { "$ref": "CommentList" }, "httpMethod": "GET", "flatPath": "files/{fileId}/comments" }, "create": { "parameterOrder": [ "fileId" ], "description": "Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "path": "files/{fileId}/comments", "parameters": { "fileId": { "location": "path", "type": "string", "description": "The ID of the file.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.comments.create", "response": { "$ref": "Comment" }, "request": { "$ref": "Comment" }, "httpMethod": "POST", "flatPath": "files/{fileId}/comments" }, "delete": { "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "parameterOrder": [ "fileId", "commentId" ], "id": "drive.comments.delete", "flatPath": "files/{fileId}/comments/{commentId}", "path": "files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "parameters": { "commentId": { "type": "string", "location": "path", "description": "The ID of the comment.", "required": true }, "fileId": { "type": "string", "location": "path", "description": "The ID of the file.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "get": { "response": { "$ref": "Comment" }, "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "GET", "description": "Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "parameterOrder": [ "fileId", "commentId" ], "id": "drive.comments.get", "path": "files/{fileId}/comments/{commentId}", "parameters": { "commentId": { "description": "The ID of the comment.", "required": true, "type": "string", "location": "path" }, "fileId": { "type": "string", "location": "path", "description": "The ID of the file.", "required": true }, "includeDeleted": { "description": "Whether to return deleted comments. Deleted comments will not include their original content.", "default": "false", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ] } } }, "files": { "methods": { "emptyTrash": { "path": "files/trash", "httpMethod": "DELETE", "parameters": { "enforceSingleParent": { "default": "false", "type": "boolean", "description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "location": "query", "deprecated": true }, "driveId": { "location": "query", "type": "string", "description": "If set, empties the trash of the provided shared drive." } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.files.emptyTrash", "flatPath": "files/trash", "parameterOrder": [], "description": "Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete)." }, "download": { "parameterOrder": [ "fileId" ], "description": "Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.", "id": "drive.files.download", "path": "files/{fileId}/download", "parameters": { "fileId": { "type": "string", "location": "path", "description": "Required. The ID of the file to download.", "required": true }, "mimeType": { "description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", "location": "query", "type": "string" }, "revisionId": { "description": "Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "Operation" }, "flatPath": "files/{fileId}/download", "httpMethod": "POST" }, "create": { "supportsMediaUpload": true, "description": " Creates a file. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "parameterOrder": [], "path": "files", "parameters": { "ocrLanguage": { "description": "A language hint for OCR processing during image import (ISO 639-1 code).", "type": "string", "location": "query" }, "useContentAsIndexableText": { "description": "Whether to use the uploaded content as indexable text.", "default": "false", "type": "boolean", "location": "query" }, "enforceSingleParent": { "deprecated": true, "location": "query", "description": "Deprecated: Creating files in multiple folders is no longer supported.", "default": "false", "type": "boolean" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "supportsAllDrives": { "location": "query", "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "default": "false", "type": "boolean", "location": "query" }, "ignoreDefaultVisibility": { "location": "query", "default": "false", "type": "boolean", "description": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.files.create", "mediaUpload": { "accept": [ "*/*" ], "maxSize": "5497558138880", "protocols": { "simple": { "multipart": true, "path": "/upload/drive/v3/files" }, "resumable": { "path": "/resumable/upload/drive/v3/files", "multipart": true } } }, "response": { "$ref": "File" }, "request": { "$ref": "File" }, "httpMethod": "POST", "flatPath": "files" }, "list": { "id": "drive.files.list", "path": "files", "parameters": { "driveId": { "description": "ID of the shared drive to search.", "location": "query", "type": "string" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "type": "boolean", "location": "query" }, "q": { "description": "A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).", "type": "string", "location": "query" }, "includeLabels": { "location": "query", "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "includeItemsFromAllDrives": { "location": "query", "default": "false", "type": "boolean", "description": "Whether both My Drive and shared drive items should be included in results." }, "pageToken": { "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.", "type": "string", "location": "query" }, "spaces": { "default": "drive", "type": "string", "location": "query", "description": "A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization)." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "orderBy": { "description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", "location": "query", "type": "string" }, "corpora": { "location": "query", "type": "string", "description": "Specifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization)." }, "pageSize": { "description": "The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.", "minimum": "1", "default": "100", "type": "integer", "maximum": "1000", "format": "int32", "location": "query" }, "corpus": { "type": "string", "description": "Deprecated: The source of files to list. Use `corpora` instead.", "location": "query", "enum": [ "domain", "user" ], "deprecated": true, "enumDescriptions": [ "Files shared to the user's domain.", "Files owned by or shared to the user." ] }, "includePermissionsForView": { "type": "string", "location": "query", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported." }, "includeTeamDriveItems": { "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "teamDriveId": { "location": "query", "type": "string", "deprecated": true, "description": "Deprecated: Use `driveId` instead." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "parameterOrder": [], "description": " Lists the user's files. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "response": { "$ref": "FileList" } }, "modifyLabels": { "response": { "$ref": "ModifyLabelsResponse" }, "request": { "$ref": "ModifyLabelsRequest" }, "httpMethod": "POST", "flatPath": "files/{fileId}/modifyLabels", "parameterOrder": [ "fileId" ], "description": "Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.", "path": "files/{fileId}/modifyLabels", "parameters": { "fileId": { "type": "string", "location": "path", "description": "The ID of the file to which the labels belong.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "id": "drive.files.modifyLabels" }, "export": { "flatPath": "files/{fileId}/export", "httpMethod": "GET", "parameterOrder": [ "fileId", "mimeType" ], "useMediaDownloadService": true, "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.", "id": "drive.files.export", "supportsMediaDownload": true, "path": "files/{fileId}/export", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "mimeType": { "description": "Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).", "required": true, "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ] }, "generateIds": { "httpMethod": "GET", "flatPath": "files/generateIds", "response": { "$ref": "GeneratedIds" }, "path": "files/generateIds", "parameters": { "count": { "location": "query", "format": "int32", "maximum": "1000", "default": "10", "type": "integer", "description": "The number of IDs to return.", "minimum": "1" }, "type": { "description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "default": "files", "type": "string" }, "space": { "description": "The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "default": "drive", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.files.generateIds", "description": "Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "parameterOrder": [] }, "copy": { "path": "files/{fileId}/copy", "parameters": { "supportsTeamDrives": { "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "deprecated": true }, "includeLabels": { "location": "query", "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "supportsAllDrives": { "default": "false", "type": "boolean", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." }, "enforceSingleParent": { "deprecated": true, "location": "query", "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", "default": "false", "type": "boolean" }, "ocrLanguage": { "description": "A language hint for OCR processing during image import (ISO 639-1 code).", "type": "string", "location": "query" }, "ignoreDefaultVisibility": { "description": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.", "default": "false", "type": "boolean", "location": "query" }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "default": "false", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.photos.readonly" ], "id": "drive.files.copy", "description": "Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "parameterOrder": [ "fileId" ], "httpMethod": "POST", "flatPath": "files/{fileId}/copy", "response": { "$ref": "File" }, "request": { "$ref": "File" } }, "update": { "request": { "$ref": "File" }, "mediaUpload": { "maxSize": "5497558138880", "protocols": { "simple": { "multipart": true, "path": "/upload/drive/v3/files/{fileId}" }, "resumable": { "path": "/resumable/upload/drive/v3/files/{fileId}", "multipart": true } }, "accept": [ "*/*" ] }, "response": { "$ref": "File" }, "flatPath": "files/{fileId}", "httpMethod": "PATCH", "description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads).", "parameterOrder": [ "fileId" ], "supportsMediaUpload": true, "id": "drive.files.update", "path": "files/{fileId}", "parameters": { "addParents": { "description": "A comma-separated list of parent IDs to add.", "type": "string", "location": "query" }, "keepRevisionForever": { "description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "default": "false", "type": "boolean", "location": "query" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "removeParents": { "description": "A comma-separated list of parent IDs to remove.", "type": "string", "location": "query" }, "enforceSingleParent": { "default": "false", "type": "boolean", "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "deprecated": true }, "ocrLanguage": { "location": "query", "type": "string", "description": "A language hint for OCR processing during image import (ISO 639-1 code)." }, "useContentAsIndexableText": { "description": "Whether to use the uploaded content as indexable text.", "location": "query", "default": "false", "type": "boolean" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.scripts" ] }, "delete": { "description": "Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.", "parameterOrder": [ "fileId" ], "id": "drive.files.delete", "flatPath": "files/{fileId}", "path": "files/{fileId}", "httpMethod": "DELETE", "parameters": { "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "enforceSingleParent": { "deprecated": true, "location": "query", "description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "default": "false", "type": "boolean" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ] }, "listLabels": { "id": "drive.files.listLabels", "path": "files/{fileId}/listLabels", "parameters": { "fileId": { "type": "string", "location": "path", "description": "The ID for the file.", "required": true }, "maxResults": { "location": "query", "maximum": "100", "format": "int32", "default": "100", "type": "integer", "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "minimum": "1" }, "pageToken": { "type": "string", "location": "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." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "description": "Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).", "parameterOrder": [ "fileId" ], "flatPath": "files/{fileId}/listLabels", "httpMethod": "GET", "response": { "$ref": "LabelList" } }, "generateCseToken": { "response": { "$ref": "GenerateCseTokenResponse" }, "flatPath": "files/generateCseToken", "httpMethod": "GET", "description": "Generates a CSE token which can be used to create or update CSE files.", "parameterOrder": [], "id": "drive.files.generateCseToken", "path": "files/generateCseToken", "parameters": { "fileId": { "description": "The ID of the file for which the JWT should be generated. If not provided, an id will be generated.", "location": "query", "type": "string" }, "parent": { "location": "query", "type": "string", "description": "The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request." } }, "scopes": [ "https://www.googleapis.com/auth/drive" ] }, "watch": { "supportsSubscription": true, "parameterOrder": [ "fileId" ], "description": "Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "path": "files/{fileId}/watch", "parameters": { "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "acknowledgeAbuse": { "location": "query", "default": "false", "type": "boolean", "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides." }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "fileId": { "type": "string", "location": "path", "description": "The ID of the file.", "required": true }, "supportsTeamDrives": { "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "deprecated": true }, "includePermissionsForView": { "location": "query", "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.files.watch", "response": { "$ref": "Channel" }, "request": { "parameterName": "resource", "$ref": "Channel" }, "httpMethod": "POST", "flatPath": "files/{fileId}/watch" }, "get": { "path": "files/{fileId}", "parameters": { "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "fileId": { "location": "path", "type": "string", "description": "The ID of the file.", "required": true }, "acknowledgeAbuse": { "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "default": "false", "type": "boolean" }, "includeLabels": { "type": "string", "location": "query", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.files.get", "supportsMediaDownload": true, "supportsSubscription": true, "parameterOrder": [ "fileId" ], "useMediaDownloadService": true, "description": " Gets a file's metadata or content by ID. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](https://developers.google.com/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads).", "httpMethod": "GET", "flatPath": "files/{fileId}", "response": { "$ref": "File" } } } }, "about": { "methods": { "get": { "response": { "$ref": "About" }, "httpMethod": "GET", "flatPath": "about", "parameterOrder": [], "description": "Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "path": "about", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.about.get" } } }, "channels": { "methods": { "stop": { "path": "channels/stop", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.channels.stop", "parameterOrder": [], "description": "Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "httpMethod": "POST", "flatPath": "channels/stop", "request": { "$ref": "Channel", "parameterName": "resource" } } } }, "operations": { "methods": { "get": { "flatPath": "operations/{name}", "httpMethod": "GET", "response": { "$ref": "Operation" }, "id": "drive.operations.get", "path": "operations/{name}", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] } } }, "permissions": { "methods": { "create": { "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "flatPath": "files/{fileId}/permissions", "httpMethod": "POST", "parameterOrder": [ "fileId" ], "description": "Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "id": "drive.permissions.create", "path": "files/{fileId}/permissions", "parameters": { "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "moveToNewOwnersRoot": { "description": "This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.", "default": "false", "type": "boolean", "location": "query" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "location": "query", "description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators)." }, "enforceSingleParent": { "description": "Deprecated: See `moveToNewOwnersRoot` for details.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "fileId": { "description": "The ID of the file or shared drive.", "required": true, "type": "string", "location": "path" }, "sendNotificationEmail": { "description": "Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.", "location": "query", "type": "boolean" }, "transferOwnership": { "location": "query", "default": "false", "type": "boolean", "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file)." }, "emailMessage": { "description": "A plain text custom message to include in the notification email.", "location": "query", "type": "string" }, "enforceExpansiveAccess": { "default": "false", "type": "boolean", "description": "Deprecated: All requests use the expansive access rules.", "location": "query", "deprecated": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "delete": { "parameterOrder": [ "fileId", "permissionId" ], "description": "Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "id": "drive.permissions.delete", "flatPath": "files/{fileId}/permissions/{permissionId}", "path": "files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "parameters": { "useDomainAdminAccess": { "description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).", "default": "false", "type": "boolean", "location": "query" }, "permissionId": { "location": "path", "type": "string", "description": "The ID of the permission.", "required": true }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "fileId": { "type": "string", "location": "path", "description": "The ID of the file or shared drive.", "required": true }, "enforceExpansiveAccess": { "deprecated": true, "location": "query", "description": "Deprecated: All requests use the expansive access rules.", "default": "false", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "update": { "path": "files/{fileId}/permissions/{permissionId}", "parameters": { "enforceExpansiveAccess": { "deprecated": true, "location": "query", "description": "Deprecated: All requests use the expansive access rules.", "default": "false", "type": "boolean" }, "permissionId": { "type": "string", "location": "path", "description": "The ID of the permission.", "required": true }, "supportsAllDrives": { "default": "false", "type": "boolean", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." }, "removeExpiration": { "description": "Whether to remove the expiration date.", "location": "query", "default": "false", "type": "boolean" }, "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators)." }, "fileId": { "location": "path", "type": "string", "description": "The ID of the file or shared drive.", "required": true }, "transferOwnership": { "default": "false", "type": "boolean", "location": "query", "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file)." }, "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.permissions.update", "parameterOrder": [ "fileId", "permissionId" ], "description": "Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permissions operations on the same file aren't supported; only the last update is applied.", "httpMethod": "PATCH", "flatPath": "files/{fileId}/permissions/{permissionId}", "response": { "$ref": "Permission" }, "request": { "$ref": "Permission" } }, "list": { "httpMethod": "GET", "flatPath": "files/{fileId}/permissions", "response": { "$ref": "PermissionList" }, "path": "files/{fileId}/permissions", "parameters": { "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "deprecated": true, "location": "query" }, "fileId": { "location": "path", "type": "string", "description": "The ID of the file or shared drive.", "required": true }, "pageToken": { "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.", "location": "query", "type": "string" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "location": "query", "description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators)." }, "supportsAllDrives": { "default": "false", "type": "boolean", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." }, "includePermissionsForView": { "type": "string", "location": "query", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported." }, "pageSize": { "description": "The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.", "minimum": "1", "type": "integer", "format": "int32", "maximum": "100", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.permissions.list", "parameterOrder": [ "fileId" ], "description": "Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing)." }, "get": { "description": "Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).", "parameterOrder": [ "fileId", "permissionId" ], "id": "drive.permissions.get", "path": "files/{fileId}/permissions/{permissionId}", "parameters": { "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators)." }, "permissionId": { "description": "The ID of the permission.", "required": true, "type": "string", "location": "path" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "type": "boolean", "location": "query" }, "supportsTeamDrives": { "deprecated": true, "location": "query", "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean" }, "fileId": { "type": "string", "location": "path", "description": "The ID of the file.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "Permission" }, "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "GET" } } }, "teamdrives": { "methods": { "get": { "response": { "$ref": "TeamDrive" }, "httpMethod": "GET", "flatPath": "teamdrives/{teamDriveId}", "description": "Deprecated: Use `drives.get` instead.", "parameterOrder": [ "teamDriveId" ], "path": "teamdrives/{teamDriveId}", "parameters": { "teamDriveId": { "location": "path", "type": "string", "description": "The ID of the Team Drive", "required": true }, "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.teamdrives.get" }, "update": { "path": "teamdrives/{teamDriveId}", "parameters": { "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs." }, "teamDriveId": { "description": "The ID of the Team Drive", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.teamdrives.update", "description": "Deprecated: Use `drives.update` instead.", "parameterOrder": [ "teamDriveId" ], "httpMethod": "PATCH", "flatPath": "teamdrives/{teamDriveId}", "response": { "$ref": "TeamDrive" }, "request": { "$ref": "TeamDrive" } }, "list": { "response": { "$ref": "TeamDriveList" }, "flatPath": "teamdrives", "httpMethod": "GET", "parameterOrder": [], "description": "Deprecated: Use `drives.list` instead.", "id": "drive.teamdrives.list", "path": "teamdrives", "parameters": { "pageSize": { "format": "int32", "maximum": "100", "location": "query", "description": "Maximum number of Team Drives to return.", "minimum": "1", "default": "10", "type": "integer" }, "q": { "description": "Query string for searching Team Drives.", "type": "string", "location": "query" }, "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned." }, "pageToken": { "description": "Page token for Team Drives.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ] }, "create": { "request": { "$ref": "TeamDrive" }, "response": { "$ref": "TeamDrive" }, "flatPath": "teamdrives", "httpMethod": "POST", "description": "Deprecated: Use `drives.create` instead.", "parameterOrder": [ "requestId" ], "id": "drive.teamdrives.create", "path": "teamdrives", "parameters": { "requestId": { "location": "query", "type": "string", "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive" ] }, "delete": { "path": "teamdrives/{teamDriveId}", "httpMethod": "DELETE", "parameters": { "teamDriveId": { "description": "The ID of the Team Drive", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.teamdrives.delete", "flatPath": "teamdrives/{teamDriveId}", "description": "Deprecated: Use `drives.delete` instead.", "parameterOrder": [ "teamDriveId" ] } } }, "drives": { "methods": { "list": { "response": { "$ref": "DriveList" }, "flatPath": "drives", "httpMethod": "GET", "parameterOrder": [], "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.", "id": "drive.drives.list", "path": "drives", "parameters": { "pageSize": { "description": "Maximum number of shared drives to return per page.", "minimum": "1", "default": "10", "type": "integer", "format": "int32", "maximum": "100", "location": "query" }, "q": { "description": "Query string for searching shared drives.", "location": "query", "type": "string" }, "useDomainAdminAccess": { "location": "query", "default": "false", "type": "boolean", "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." }, "pageToken": { "type": "string", "location": "query", "description": "Page token for shared drives." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ] }, "hide": { "parameterOrder": [ "driveId" ], "description": "Hides a shared drive from the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "id": "drive.drives.hide", "path": "drives/{driveId}/hide", "parameters": { "driveId": { "description": "The ID of the shared drive.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "response": { "$ref": "Drive" }, "flatPath": "drives/{driveId}/hide", "httpMethod": "POST" }, "update": { "parameterOrder": [ "driveId" ], "description": "Updates the metadata for a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "id": "drive.drives.update", "path": "drives/{driveId}", "parameters": { "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", "default": "false", "type": "boolean", "location": "query" }, "driveId": { "type": "string", "location": "path", "description": "The ID of the shared drive.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "request": { "$ref": "Drive" }, "response": { "$ref": "Drive" }, "flatPath": "drives/{driveId}", "httpMethod": "PATCH" }, "delete": { "id": "drive.drives.delete", "flatPath": "drives/{driveId}", "path": "drives/{driveId}", "httpMethod": "DELETE", "parameters": { "driveId": { "type": "string", "location": "path", "description": "The ID of the shared drive.", "required": true }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", "location": "query", "default": "false", "type": "boolean" }, "allowItemDeletion": { "location": "query", "default": "false", "type": "boolean", "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`." } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "description": "Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "parameterOrder": [ "driveId" ] }, "unhide": { "response": { "$ref": "Drive" }, "httpMethod": "POST", "flatPath": "drives/{driveId}/unhide", "parameterOrder": [ "driveId" ], "description": "Restores a shared drive to the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "path": "drives/{driveId}/unhide", "parameters": { "driveId": { "description": "The ID of the shared drive.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.drives.unhide" }, "create": { "path": "drives", "parameters": { "requestId": { "type": "string", "location": "query", "description": "Required. 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 } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.drives.create", "description": "Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "parameterOrder": [ "requestId" ], "httpMethod": "POST", "flatPath": "drives", "response": { "$ref": "Drive" }, "request": { "$ref": "Drive" } }, "get": { "parameterOrder": [ "driveId" ], "description": "Gets a shared drive's metadata by ID. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "path": "drives/{driveId}", "parameters": { "driveId": { "description": "The ID of the shared drive.", "required": true, "location": "path", "type": "string" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "location": "query", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.drives.get", "response": { "$ref": "Drive" }, "httpMethod": "GET", "flatPath": "drives/{driveId}" } } }, "revisions": { "methods": { "get": { "parameterOrder": [ "fileId", "revisionId" ], "useMediaDownloadService": true, "description": "Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).", "id": "drive.revisions.get", "supportsMediaDownload": true, "path": "files/{fileId}/revisions/{revisionId}", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "revisionId": { "type": "string", "location": "path", "description": "The ID of the revision.", "required": true }, "acknowledgeAbuse": { "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "default": "false", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "Revision" }, "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "GET" }, "list": { "response": { "$ref": "RevisionList" }, "flatPath": "files/{fileId}/revisions", "httpMethod": "GET", "description": "Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions). **Important:** The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.", "parameterOrder": [ "fileId" ], "id": "drive.revisions.list", "path": "files/{fileId}/revisions", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "pageToken": { "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.", "location": "query", "type": "string" }, "pageSize": { "default": "200", "type": "integer", "description": "The maximum number of revisions to return per page.", "minimum": "1", "location": "query", "maximum": "1000", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ] }, "update": { "id": "drive.revisions.update", "path": "files/{fileId}/revisions/{revisionId}", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "revisionId": { "type": "string", "location": "path", "description": "The ID of the revision.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "description": "Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).", "parameterOrder": [ "fileId", "revisionId" ], "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "PATCH", "request": { "$ref": "Revision" }, "response": { "$ref": "Revision" } }, "delete": { "parameterOrder": [ "fileId", "revisionId" ], "description": "Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see [Manage file revisions](https://developers.google.com/drive/api/guides/manage-revisions).", "id": "drive.revisions.delete", "flatPath": "files/{fileId}/revisions/{revisionId}", "path": "files/{fileId}/revisions/{revisionId}", "httpMethod": "DELETE", "parameters": { "fileId": { "description": "The ID of the file.", "required": true, "location": "path", "type": "string" }, "revisionId": { "description": "The ID of the revision.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ] } } }, "replies": { "methods": { "get": { "response": { "$ref": "Reply" }, "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "GET", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Gets a reply by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "id": "drive.replies.get", "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameters": { "commentId": { "description": "The ID of the comment.", "required": true, "type": "string", "location": "path" }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "includeDeleted": { "default": "false", "type": "boolean", "location": "query", "description": "Whether to return deleted replies. Deleted replies don't include their original content." }, "replyId": { "type": "string", "location": "path", "description": "The ID of the reply.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ] }, "delete": { "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "DELETE", "parameters": { "replyId": { "description": "The ID of the reply.", "required": true, "location": "path", "type": "string" }, "commentId": { "description": "The ID of the comment.", "required": true, "type": "string", "location": "path" }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.replies.delete", "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments)." }, "create": { "flatPath": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "POST", "request": { "$ref": "Reply" }, "response": { "$ref": "Reply" }, "id": "drive.replies.create", "path": "files/{fileId}/comments/{commentId}/replies", "parameters": { "commentId": { "description": "The ID of the comment.", "required": true, "type": "string", "location": "path" }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "parameterOrder": [ "fileId", "commentId" ], "description": "Creates a reply to a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments)." }, "list": { "response": { "$ref": "ReplyList" }, "httpMethod": "GET", "flatPath": "files/{fileId}/comments/{commentId}/replies", "parameterOrder": [ "fileId", "commentId" ], "description": "Lists a comment's replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "path": "files/{fileId}/comments/{commentId}/replies", "parameters": { "commentId": { "type": "string", "location": "path", "description": "The ID of the comment.", "required": true }, "fileId": { "description": "The ID of the file.", "required": true, "type": "string", "location": "path" }, "pageToken": { "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.", "type": "string", "location": "query" }, "includeDeleted": { "description": "Whether to include deleted replies. Deleted replies don't include their original content.", "location": "query", "default": "false", "type": "boolean" }, "pageSize": { "location": "query", "maximum": "100", "format": "int32", "default": "20", "type": "integer", "description": "The maximum number of replies to return per page.", "minimum": "1" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.replies.list" }, "update": { "description": "Updates a reply with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "parameterOrder": [ "fileId", "commentId", "replyId" ], "id": "drive.replies.update", "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameters": { "fileId": { "location": "path", "type": "string", "description": "The ID of the file.", "required": true }, "commentId": { "type": "string", "location": "path", "description": "The ID of the comment.", "required": true }, "replyId": { "description": "The ID of the reply.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "Reply" }, "response": { "$ref": "Reply" }, "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PATCH" } } }, "changes": { "methods": { "watch": { "flatPath": "changes/watch", "httpMethod": "POST", "request": { "$ref": "Channel", "parameterName": "resource" }, "response": { "$ref": "Channel" }, "id": "drive.changes.watch", "path": "changes/watch", "parameters": { "driveId": { "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.", "location": "query", "type": "string" }, "supportsAllDrives": { "location": "query", "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "includeLabels": { "type": "string", "location": "query", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "includeItemsFromAllDrives": { "default": "false", "type": "boolean", "location": "query", "description": "Whether both My Drive and shared drive items should be included in results." }, "pageToken": { "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, "location": "query", "type": "string" }, "spaces": { "location": "query", "default": "drive", "type": "string", "description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'." }, "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "includeRemoved": { "description": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.", "location": "query", "default": "true", "type": "boolean" }, "includeCorpusRemovals": { "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.", "location": "query", "default": "false", "type": "boolean" }, "restrictToMyDrive": { "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.", "location": "query", "default": "false", "type": "boolean" }, "includeTeamDriveItems": { "deprecated": true, "location": "query", "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "default": "false", "type": "boolean" }, "teamDriveId": { "description": "Deprecated: Use `driveId` instead.", "deprecated": true, "type": "string", "location": "query" }, "pageSize": { "location": "query", "maximum": "1000", "format": "int32", "default": "100", "type": "integer", "description": "The maximum number of changes to return per page.", "minimum": "1" }, "includePermissionsForView": { "location": "query", "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "description": "Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "parameterOrder": [ "pageToken" ], "supportsSubscription": true }, "getStartPageToken": { "path": "changes/startPageToken", "parameters": { "teamDriveId": { "deprecated": true, "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" }, "supportsTeamDrives": { "location": "query", "deprecated": true, "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "driveId": { "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", "type": "string", "location": "query" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.changes.getStartPageToken", "parameterOrder": [], "description": "Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).", "httpMethod": "GET", "flatPath": "changes/startPageToken", "response": { "$ref": "StartPageToken" } }, "list": { "path": "changes", "parameters": { "includeCorpusRemovals": { "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.", "default": "false", "type": "boolean", "location": "query" }, "includeRemoved": { "default": "true", "type": "boolean", "location": "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." }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "type": "string", "location": "query" }, "driveId": { "type": "string", "location": "query", "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." }, "supportsAllDrives": { "default": "false", "type": "boolean", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." }, "spaces": { "description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.", "default": "drive", "type": "string", "location": "query" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "deprecated": true }, "includeItemsFromAllDrives": { "description": "Whether both My Drive and shared drive items should be included in results.", "default": "false", "type": "boolean", "location": "query" }, "pageToken": { "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, "location": "query", "type": "string" }, "pageSize": { "format": "int32", "maximum": "1000", "location": "query", "description": "The maximum number of changes to return per page.", "minimum": "1", "default": "100", "type": "integer" }, "includePermissionsForView": { "location": "query", "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported." }, "restrictToMyDrive": { "location": "query", "default": "false", "type": "boolean", "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." }, "includeTeamDriveItems": { "default": "false", "type": "boolean", "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "deprecated": true }, "teamDriveId": { "location": "query", "type": "string", "deprecated": true, "description": "Deprecated: Use `driveId` instead." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.changes.list", "supportsSubscription": true, "parameterOrder": [ "pageToken" ], "description": "Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).", "httpMethod": "GET", "flatPath": "changes", "response": { "$ref": "ChangeList" } } } }, "accessproposals": { "methods": { "get": { "httpMethod": "GET", "flatPath": "files/{fileId}/accessproposals/{proposalId}", "response": { "$ref": "AccessProposal" }, "path": "files/{fileId}/accessproposals/{proposalId}", "parameters": { "fileId": { "description": "Required. The ID of the item the request is on.", "required": true, "type": "string", "location": "path" }, "proposalId": { "location": "path", "type": "string", "description": "Required. The ID of the access proposal to resolve.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.accessproposals.get", "parameterOrder": [ "fileId", "proposalId" ], "description": "Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access)." }, "list": { "flatPath": "files/{fileId}/accessproposals", "httpMethod": "GET", "response": { "$ref": "ListAccessProposalsResponse" }, "id": "drive.accessproposals.list", "path": "files/{fileId}/accessproposals", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The number of results per page." }, "fileId": { "type": "string", "location": "path", "description": "Required. The ID of the item the request is on.", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The continuation token on the list of access requests." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "parameterOrder": [ "fileId" ], "description": "List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned." }, "resolve": { "path": "files/{fileId}/accessproposals/{proposalId}:resolve", "parameters": { "fileId": { "location": "path", "type": "string", "description": "Required. The ID of the item the request is on.", "required": true }, "proposalId": { "type": "string", "location": "path", "description": "Required. The ID of the access proposal to resolve.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.accessproposals.resolve", "description": "Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).", "parameterOrder": [ "fileId", "proposalId" ], "httpMethod": "POST", "flatPath": "files/{fileId}/accessproposals/{proposalId}:resolve", "request": { "$ref": "ResolveAccessProposalRequest" } } } } }, "batchPath": "batch/drive/v3", "discoveryVersion": "v1", "description": "The Google Drive API allows clients to access resources from Google Drive.", "ownerDomain": "google.com", "title": "Google Drive API", "schemas": { "ApprovalList": { "type": "object", "description": "The response of an Approvals list request.", "properties": { "nextPageToken": { "description": "The page token for the next page of Approvals. This will be absent if the end of the Approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", "type": "string" }, "kind": { "description": "This is always drive#approvalList", "type": "string" }, "items": { "description": "The list of Approvals. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "type": "array", "items": { "$ref": "Approval" } } }, "id": "ApprovalList" }, "ListAccessProposalsResponse": { "type": "object", "id": "ListAccessProposalsResponse", "description": "The response to an access proposal list request.", "properties": { "accessProposals": { "description": "The list of access proposals. This field is only populated in Drive API v3.", "type": "array", "items": { "$ref": "AccessProposal" } }, "nextPageToken": { "description": "The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", "type": "string" } } }, "User": { "id": "User", "description": "Information about a Drive user.", "properties": { "me": { "description": "Output only. Whether this user is the requesting user.", "readOnly": true, "type": "boolean" }, "permissionId": { "type": "string", "description": "Output only. The user's ID as visible in Permission resources.", "readOnly": true }, "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.", "readOnly": true, "type": "string" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.", "readOnly": true, "default": "drive#user", "type": "string" }, "photoLink": { "type": "string", "description": "Output only. A link to the user's profile photo, if available.", "readOnly": true }, "displayName": { "description": "Output only. A plain text displayable name for this user.", "readOnly": true, "type": "string" } }, "type": "object" }, "Permission": { "id": "Permission", "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", "properties": { "role": { "description": "The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "annotations": { "required": [ "drive.permissions.create" ] }, "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).", "type": "string" }, "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.", "type": "boolean" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", "default": "drive#permission", "type": "string" }, "expirationTime": { "type": "string", "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future", "format": "date-time" }, "displayName": { "description": "Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as \"Dana A.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"cymbalgroup.com.\" * `anyone` - No `displayName` is present.", "type": "string" }, "deleted": { "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.", "type": "boolean" }, "permissionDetails": { "description": "Output only. Details of whether the permissions on this item are inherited or are directly on this item.", "readOnly": true, "type": "array", "items": { "type": "object", "properties": { "permissionType": { "description": "Output only. The permission type for this user. Supported values include: * `file` * `member`", "type": "string" }, "role": { "description": "Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "type": "string" }, "inheritedFrom": { "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "inherited": { "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" } } } }, "type": { "type": "string", "description": "The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.", "annotations": { "required": [ "drive.permissions.create" ] } }, "id": { "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "teamDrivePermissionDetails": { "type": "array", "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "readOnly": true, "items": { "type": "object", "properties": { "teamDrivePermissionType": { "type": "string", "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead." }, "inheritedFrom": { "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.", "type": "string" }, "inherited": { "type": "boolean", "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead." }, "role": { "type": "string", "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/role` instead." } } }, "deprecated": true }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.", "type": "boolean" }, "photoLink": { "description": "Output only. A link to the user's profile photo, if available.", "type": "string" }, "inheritedPermissionsDisabled": { "description": "When `true`, only organizers, owners, and users with permissions added directly on the item can access it.", "type": "boolean" } }, "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": { "trashingUser": { "$ref": "User", "description": "Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." }, "permissionIds": { "description": "Output only. List of permission IDs for users with access to this file.", "type": "array", "items": { "type": "string" } }, "imageMediaMetadata": { "type": "object", "description": "Output only. Additional metadata about image media, if available.", "properties": { "flashUsed": { "description": "Output only. Whether a flash was used to create the photo.", "type": "boolean" }, "aperture": { "description": "Output only. The aperture used to create the photo (f-number).", "format": "float", "type": "number" }, "rotation": { "type": "integer", "format": "int32", "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation." }, "meteringMode": { "description": "Output only. The metering mode used to create the photo.", "type": "string" }, "cameraMake": { "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "focalLength": { "type": "number", "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float" }, "exposureBias": { "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float", "type": "number" }, "cameraModel": { "description": "Output only. The model of the camera used to create the photo.", "type": "string" }, "location": { "type": "object", "description": "Output only. Geographic location information stored in the image.", "properties": { "latitude": { "type": "number", "format": "double", "description": "Output only. The latitude stored in the image." }, "altitude": { "description": "Output only. The altitude stored in the image.", "format": "double", "type": "number" }, "longitude": { "format": "double", "description": "Output only. The longitude stored in the image.", "type": "number" } } }, "isoSpeed": { "format": "int32", "description": "Output only. The ISO speed used to create the photo.", "type": "integer" }, "time": { "description": "Output only. The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "exposureTime": { "format": "float", "description": "Output only. The length of the exposure, in seconds.", "type": "number" }, "colorSpace": { "description": "Output only. The color space of the photo.", "type": "string" }, "width": { "type": "integer", "format": "int32", "description": "Output only. The width of the image in pixels." }, "sensor": { "description": "Output only. The type of sensor used to create the photo.", "type": "string" }, "exposureMode": { "description": "Output only. The exposure mode used to create the photo.", "type": "string" }, "whiteBalance": { "description": "Output only. The white balance mode used to create the photo.", "type": "string" }, "subjectDistance": { "type": "integer", "format": "int32", "description": "Output only. The distance to the subject of the photo, in meters." }, "height": { "type": "integer", "description": "Output only. The height of the image in pixels.", "format": "int32" }, "lens": { "description": "Output only. The lens used to create the photo.", "type": "string" }, "maxApertureValue": { "format": "float", "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "type": "number" } } }, "version": { "type": "string", "description": "Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", "format": "int64" }, "labelInfo": { "type": "object", "description": "Output only. An overview of the labels on the file.", "properties": { "labels": { "type": "array", "items": { "$ref": "Label" }, "description": "Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned." } } }, "owners": { "description": "Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "type": "array", "items": { "$ref": "User" } }, "exportLinks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true }, "id": { "description": "The ID of the file.", "type": "string" }, "fullFileExtension": { "description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.", "type": "string" }, "linkShareMetadata": { "type": "object", "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { "description": "Output only. Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { "description": "Output only. Whether the security update is enabled for this file.", "type": "boolean" } } }, "size": { "format": "int64", "description": "Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.", "type": "string" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters.", "type": "boolean" }, "mimeType": { "description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.", "type": "string" }, "thumbnailLink": { "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.", "type": "string" }, "appProperties": { "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries 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", "additionalProperties": { "type": "string" } }, "headRevisionId": { "description": "Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", "type": "string" }, "parents": { "description": "The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "type": "array", "items": { "type": "string" } }, "starred": { "description": "Whether the user has starred the file.", "type": "boolean" }, "originalFilename": { "description": "The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.", "type": "string" }, "thumbnailVersion": { "type": "string", "format": "int64", "description": "Output only. The thumbnail version for use in thumbnail cache invalidation." }, "trashed": { "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted.", "type": "boolean" }, "writersCanShare": { "description": "Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.", "default": "drive#file", "type": "string" }, "sharingUser": { "$ref": "User", "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "webContentLink": { "description": "Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", "type": "string" }, "permissions": { "description": "Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", "type": "array", "items": { "$ref": "Permission" } }, "downloadRestrictions": { "description": "Download restrictions applied on the file.", "$ref": "DownloadRestrictionsMetadata" }, "ownedByMe": { "description": "Output only. Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "fileExtension": { "description": "Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.", "type": "string" }, "viewedByMe": { "description": "Output only. Whether the file has been viewed by this user.", "type": "boolean" }, "inheritedPermissionsDisabled": { "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", "type": "boolean" }, "hasThumbnail": { "description": "Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "name": { "description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.", "type": "string" }, "explicitlyTrashed": { "description": "Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "modifiedByMeTime": { "format": "date-time", "description": "The last time the file was modified by the user (RFC 3339 date-time).", "type": "string" }, "shared": { "description": "Output only. Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sha256Checksum": { "description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests." }, "lastModifyingUser": { "description": "Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.", "$ref": "User" }, "spaces": { "type": "array", "items": { "type": "string" }, "description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`." }, "createdTime": { "type": "string", "description": "The time at which the file was created (RFC 3339 date-time).", "format": "date-time" }, "description": { "description": "A short description of the file.", "type": "string" }, "modifiedByMe": { "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "sha1Checksum": { "description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "viewersCanCopyContent": { "deprecated": true, "description": "Deprecated: Use `copyRequiresWriterPermission` instead.", "type": "boolean" }, "modifiedTime": { "type": "string", "description": "he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.", "format": "date-time" }, "viewedByMeTime": { "type": "string", "format": "date-time", "description": "The last time the file was viewed by the user (RFC 3339 date-time)." }, "clientEncryptionDetails": { "$ref": "ClientEncryptionDetails", "description": "Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts." }, "contentHints": { "type": "object", "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { "format": "byte", "description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).", "type": "string" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } }, "type": "object" }, "indexableText": { "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.", "type": "string" } } }, "folderColorRgb": { "description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.", "type": "string" }, "capabilities": { "type": "object", "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).", "properties": { "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.", "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" }, "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" }, "canMoveTeamDriveItem": { "type": "boolean", "deprecated": true, "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead." }, "canReadTeamDrive": { "description": "Deprecated: Output only. Use `canReadDrive` instead.", "deprecated": true, "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.", "deprecated": true, "type": "boolean" }, "canChangeViewersCanCopyContent": { "type": "boolean", "deprecated": true, "description": "Deprecated: Output only." }, "canUntrash": { "description": "Output only. Whether the current user can restore this file from trash.", "type": "boolean" }, "canRemoveContentRestriction": { "description": "Output only. Whether there's a content restriction on the file that can be removed by the current user.", "type": "boolean" }, "canDisableInheritedPermissions": { "description": "Whether a user can disable inherited permissions.", "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 isn't 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" }, "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's being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead.", "deprecated": true }, "canModifyContent": { "description": "Output only. Whether the current user can modify the content of this file.", "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 isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "deprecated": true }, "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 if it's not a folder, can be read.", "type": "boolean" }, "canDelete": { "description": "Output only. Whether the current user can delete this file.", "type": "boolean" }, "canModifyOwnerContentRestriction": { "description": "Output only. Whether the current user can add or modify content restrictions which are owner restricted.", "type": "boolean" }, "canComment": { "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canShare": { "description": "Output only. Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canEnableInheritedPermissions": { "description": "Whether a user can re-enable inherited permissions.", "type": "boolean" }, "canAddChildren": { "description": "Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.", "type": "boolean" }, "canRemoveChildren": { "description": "Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canDeleteChildren": { "description": "Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "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 isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canChangeItemDownloadRestriction": { "description": "Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.", "type": "boolean" }, "canRename": { "description": "Output only. Whether the current user can rename this file.", "type": "boolean" }, "canTrash": { "description": "Output only. Whether the current user can move this file to trash.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { "description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.", "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's being added.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.", "deprecated": true }, "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" }, "canModifyLabels": { "description": "Output only. Whether the current user can modify the labels on the file.", "type": "boolean" }, "canTrashChildren": { "description": "Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canModifyContentRestriction": { "type": "boolean", "deprecated": true, "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`." }, "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 if it's not a folder.", "type": "boolean" }, "canReadLabels": { "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canAcceptOwnership": { "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "deprecated": true, "description": "Deprecated: Output only. Use `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" }, "canRemoveMyDriveParent": { "description": "Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" } } }, "teamDriveId": { "type": "string", "description": "Deprecated: Output only. Use `driveId` instead.", "deprecated": true }, "sharedWithMeTime": { "type": "string", "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "format": "date-time" }, "quotaBytesUsed": { "type": "string", "format": "int64", "description": "Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled." }, "resourceKey": { "description": "Output only. A key needed to access the item via a shared link.", "type": "string" }, "webViewLink": { "description": "Output only. A link for opening the file in a relevant Google editor or viewer in a browser.", "type": "string" }, "driveId": { "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "type": "array", "items": { "$ref": "ContentRestriction" } }, "iconLink": { "description": "Output only. A static, unauthenticated link to the file's icon.", "type": "string" }, "hasAugmentedPermissions": { "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" }, "videoMediaMetadata": { "type": "object", "description": "Output only. Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "width": { "format": "int32", "description": "Output only. The width of the video in pixels.", "type": "integer" }, "height": { "type": "integer", "description": "Output only. The height of the video in pixels.", "format": "int32" }, "durationMillis": { "type": "string", "format": "int64", "description": "Output only. The duration of the video in milliseconds." } } }, "shortcutDetails": { "type": "object", "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to. Can only be set on `files.create` requests.", "type": "string" }, "targetMimeType": { "description": "Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { "description": "Output only. The `resourceKey` for the target file.", "type": "string" } } }, "md5Checksum": { "description": "Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", "type": "string" }, "trashedTime": { "type": "string", "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", "format": "date-time" } }, "id": "File", "type": "object" }, "AppIcons": { "id": "AppIcons", "properties": { "category": { "description": "Category of the icon. Allowed values are: * `application` - The icon for the application. * `document` - The icon for a file associated with the app. * `documentShared` - The icon for a shared file associated with the app.", "type": "string" }, "size": { "format": "int32", "description": "Size of the icon. Represented as the maximum of the width and height.", "type": "integer" }, "iconUrl": { "description": "URL for the icon.", "type": "string" } }, "type": "object" }, "ModifyLabelsRequest": { "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "properties": { "labelModifications": { "type": "array", "items": { "$ref": "LabelModification" }, "description": "The list of modifications to apply to the labels on the file." }, "kind": { "description": "This is always `\"drive#modifyLabelsRequest\"`.", "type": "string" } }, "id": "ModifyLabelsRequest", "type": "object" }, "ClientEncryptionDetails": { "type": "object", "id": "ClientEncryptionDetails", "description": "Details about the client-side encryption applied to the file.", "properties": { "encryptionState": { "description": "The encryption state of the file. The values expected here are: - encrypted - unencrypted ", "type": "string" }, "decryptionMetadata": { "description": "The metadata used for client-side operations.", "$ref": "DecryptionMetadata" } } }, "TeamDrive": { "type": "object", "description": "Deprecated: use the drive collection instead.", "properties": { "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" }, "capabilities": { "type": "object", "description": "Capabilities the current user has on this Team Drive.", "properties": { "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" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this Team Drive.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or 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" }, "canRenameTeamDrive": { "description": "Whether the current user can rename this Team Drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this Team Drive", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this Team Drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this Team Drive.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files 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" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this Team Drive.", "type": "boolean" }, "canShare": { "description": "Whether the current user can share files or folders in this Team Drive.", "type": "boolean" }, "canAddChildren": { "description": "Whether the current user can add children to folders in this Team Drive.", "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canChangeDownloadRestriction": { "description": "Whether the current user can change organizer-applied download restrictions of this shared drive.", "type": "boolean" }, "canResetTeamDriveRestrictions": { "description": "Whether the current user can reset the Team Drive restrictions to defaults.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this Team Drive.", "type": "boolean" }, "canRemoveChildren": { "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.", "deprecated": true, "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { "description": "Whether the current user can change the background of this Team Drive.", "type": "boolean" } } }, "name": { "description": "The name of this Team Drive.", "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" }, "createdTime": { "type": "string", "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "format": "date-time" }, "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" }, "kind": { "default": "drive#teamDrive", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`." }, "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": { "yCoordinate": { "type": "number", "format": "float", "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." }, "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" }, "id": { "description": "The ID of an image file in Drive to use for the background image.", "type": "string" }, "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" } }, "type": "object" }, "restrictions": { "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "properties": { "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" }, "downloadRestriction": { "description": "Download restrictions applied by shared drive managers.", "$ref": "DownloadRestriction" }, "teamMembersOnly": { "description": "Whether access to items inside this Team Drive is restricted to members 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" }, "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" }, "adminManagedRestrictions": { "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", "type": "boolean" } }, "type": "object" }, "backgroundImageLink": { "description": "A short-lived link to this Team Drive's background image.", "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" } }, "id": "TeamDrive" }, "LabelModification": { "type": "object", "description": "A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", "properties": { "kind": { "description": "This is always `\"drive#labelModification\"`.", "type": "string" }, "labelId": { "description": "The ID of the label to modify.", "annotations": { "required": [ "drive.files.modifyLabels" ] }, "type": "string" }, "fieldModifications": { "type": "array", "items": { "$ref": "LabelFieldModification" }, "description": "The list of modifications to this label's fields." }, "removeLabel": { "description": "If true, the label will be removed from the file.", "type": "boolean" } }, "id": "LabelModification" }, "StartPageToken": { "id": "StartPageToken", "properties": { "startPageToken": { "description": "The starting page token for listing future changes. The page token doesn't expire.", "type": "string" }, "kind": { "default": "drive#startPageToken", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`." } }, "type": "object" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" } }, "id": "Operation", "type": "object" }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "type": "object" }, "GeneratedIds": { "type": "object", "id": "GeneratedIds", "description": "A list of generated file IDs which can be provided in create requests.", "properties": { "ids": { "description": "The IDs generated for the requesting user in the specified space.", "type": "array", "items": { "type": "string" } }, "space": { "description": "The type of file that can be created with these IDs.", "type": "string" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`.", "default": "drive#generatedIds", "type": "string" } } }, "About": { "type": "object", "id": "About", "description": "Information about the user, the user's Drive, and system capabilities.", "properties": { "teamDriveThemes": { "description": "Deprecated: Use `driveThemes` instead.", "deprecated": true, "type": "array", "items": { "type": "object", "properties": { "colorRgb": { "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "deprecated": true, "type": "string" }, "id": { "deprecated": true, "description": "Deprecated: Use `driveThemes/id` instead.", "type": "string" }, "backgroundImageLink": { "deprecated": true, "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead.", "type": "string" } } } }, "maxImportSizes": { "description": "A map of maximum import sizes by MIME type, in bytes.", "type": "object", "additionalProperties": { "type": "string", "format": "int64" } }, "importFormats": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "A map of source MIME type to possible targets for all supported imports." }, "folderColorPalette": { "type": "array", "items": { "type": "string" }, "description": "The currently supported folder colors as RGB hex strings." }, "driveThemes": { "description": "A list of themes that are supported for shared drives.", "type": "array", "items": { "type": "object", "properties": { "colorRgb": { "description": "The color of this theme as an RGB hex string.", "type": "string" }, "id": { "description": "The ID of the theme.", "type": "string" }, "backgroundImageLink": { "description": "A link to this theme's background image.", "type": "string" } } } }, "maxUploadSize": { "description": "The maximum upload size in bytes.", "format": "int64", "type": "string" }, "kind": { "default": "drive#about", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`." }, "user": { "$ref": "User", "description": "The authenticated user." }, "canCreateDrives": { "description": "Whether the user can create shared drives.", "type": "boolean" }, "storageQuota": { "description": "The user's storage quota limits and usage. For users that are part of an organization with pooled storage, information about the limit and usage across all services is for the organization, rather than the individual user. All fields are measured in bytes.", "properties": { "usageInDrive": { "description": "The usage by all files in Google Drive.", "format": "int64", "type": "string" }, "limit": { "format": "int64", "description": "The usage limit, if applicable. This will not be present if the user has unlimited storage. For users that are part of an organization with pooled storage, this is the limit for the organization, rather than the individual user.", "type": "string" }, "usage": { "description": "The total usage across all services. For users that are part of an organization with pooled storage, this is the usage across all services for the organization, rather than the individual user.", "format": "int64", "type": "string" }, "usageInDriveTrash": { "description": "The usage by trashed files in Google Drive.", "format": "int64", "type": "string" } }, "type": "object" }, "appInstalled": { "description": "Whether the user has installed the requesting app.", "type": "boolean" }, "exportFormats": { "description": "A map of source MIME type to possible targets for all supported exports.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "canCreateTeamDrives": { "description": "Deprecated: Use `canCreateDrives` instead.", "deprecated": true, "type": "boolean" } } }, "TeamDriveList": { "type": "object", "id": "TeamDriveList", "description": "A list of Team Drives.", "properties": { "kind": { "default": "drive#teamDriveList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`." }, "teamDrives": { "description": "The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "type": "array", "items": { "$ref": "TeamDrive" } }, "nextPageToken": { "description": "The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" } } }, "ReviewerResponse": { "description": "A response on an Approval made by a specific Reviewer.", "properties": { "kind": { "description": "This is always drive#reviewerResponse.", "type": "string" }, "reviewer": { "description": "The user that is responsible for this response.", "$ref": "User" }, "response": { "description": "A Reviewer’s Response for the Approval.", "enumDescriptions": [ "Response was set to an unrecognized value.", "The reviewer has not yet responded", "The Reviewer has approved the item.", "The Reviewer has declined the item." ], "type": "string", "enum": [ "RESPONSE_UNSPECIFIED", "NO_RESPONSE", "APPROVED", "DECLINED" ] } }, "id": "ReviewerResponse", "type": "object" }, "DecryptionMetadata": { "id": "DecryptionMetadata", "description": "Representation of the CSE DecryptionMetadata.", "properties": { "encryptionResourceKeyHash": { "description": "The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference", "type": "string" }, "kaclsName": { "description": "The name of the KACLS (Key ACL Service) used to encrypt the file.", "type": "string" }, "jwt": { "description": "The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.", "type": "string" }, "aes256GcmChunkSize": { "description": "Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ", "type": "string" }, "keyFormat": { "description": "Key format for the unwrapped key. Must be `tinkAesGcmKey`.", "type": "string" }, "kaclsId": { "description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", "format": "int64", "type": "string" }, "wrappedKey": { "description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.", "type": "string" } }, "type": "object" }, "LabelFieldModification": { "type": "object", "description": "A modification to a label's field.", "properties": { "kind": { "description": "This is always `\"drive#labelFieldModification\"`.", "type": "string" }, "setDateValues": { "type": "array", "items": { "format": "date", "type": "string" }, "description": "Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD." }, "unsetValues": { "description": "Unsets the values for this field.", "type": "boolean" }, "setUserValues": { "type": "array", "items": { "type": "string" }, "description": "Replaces a `user` field with these new values. The values must be a valid email addresses." }, "fieldId": { "description": "The ID of the field to be modified.", "type": "string" }, "setTextValues": { "type": "array", "items": { "type": "string" }, "description": "Sets the value of a `text` field." }, "setIntegerValues": { "description": "Replaces the value of an `integer` field with these new values.", "type": "array", "items": { "type": "string", "format": "int64" } }, "setSelectionValues": { "description": "Replaces a `selection` field with these new values.", "type": "array", "items": { "type": "string" } } }, "id": "LabelFieldModification" }, "Approval": { "id": "Approval", "description": "Metadata for an approval. An approval is a review/approve process for a Drive item.", "properties": { "approvalId": { "description": "The Approval ID.", "type": "string" }, "modifyTime": { "format": "google-datetime", "description": "Output only. The most recent time the approval was modified.", "readOnly": true, "type": "string" }, "status": { "description": "Output only. The status of the approval at the time this resource was requested.", "readOnly": true, "type": "string", "enumDescriptions": [ "Approval status has not been set or was set to an invalid value.", "The approval process has started and not finished.", "The approval process is finished and the target was approved.", "The approval process was cancelled before it finished.", "The approval process is finished and the target was declined." ], "enum": [ "STATUS_UNSPECIFIED", "IN_PROGRESS", "APPROVED", "CANCELLED", "DECLINED" ] }, "initiator": { "$ref": "User", "description": "The user that requested the Approval." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the approval was created.", "readOnly": true }, "targetFileId": { "description": "Target file id of the approval.", "type": "string" }, "completeTime": { "type": "string", "description": "Output only. The time the approval was completed.", "readOnly": true, "format": "google-datetime" }, "reviewerResponses": { "description": "The responses made on the Approval by reviewers.", "type": "array", "items": { "$ref": "ReviewerResponse" } }, "dueTime": { "description": "The time that the approval is due.", "format": "google-datetime", "type": "string" }, "kind": { "description": "This is always drive#approval.", "type": "string" } }, "type": "object" }, "ReplyList": { "type": "object", "id": "ReplyList", "description": "A list of replies to a comment on a file.", "properties": { "replies": { "description": "The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "type": "array", "items": { "$ref": "Reply" } }, "kind": { "default": "drive#replyList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`." }, "nextPageToken": { "description": "The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" } } }, "PermissionList": { "type": "object", "id": "PermissionList", "description": "A list of permissions for a file.", "properties": { "nextPageToken": { "description": "The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" }, "permissions": { "type": "array", "items": { "$ref": "Permission" }, "description": "The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched." }, "kind": { "default": "drive#permissionList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`." } } }, "RevisionList": { "description": "A list of revisions of a file.", "properties": { "kind": { "default": "drive#revisionList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`." }, "revisions": { "type": "array", "items": { "$ref": "Revision" }, "description": "The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched." }, "nextPageToken": { "description": "The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" } }, "id": "RevisionList", "type": "object" }, "Comment": { "type": "object", "id": "Comment", "description": "A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.", "properties": { "resolved": { "description": "Output only. Whether the comment has been resolved by one of its replies.", "type": "boolean" }, "replies": { "type": "array", "items": { "$ref": "Reply" }, "description": "Output only. The full list of replies to the comment in chronological order." }, "modifiedTime": { "format": "date-time", "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "type": "string" }, "htmlContent": { "description": "Output only. The content of the comment with HTML formatting.", "type": "string" }, "content": { "description": "The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.", "annotations": { "required": [ "drive.comments.create", "drive.comments.update" ] }, "type": "string" }, "id": { "description": "Output only. The ID of the comment.", "type": "string" }, "createdTime": { "type": "string", "format": "date-time", "description": "The time at which the comment was created (RFC 3339 date-time)." }, "deleted": { "description": "Output only. Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "anchor": { "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).", "type": "string" }, "author": { "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated.", "$ref": "User" }, "mentionedEmailAddresses": { "type": "array", "items": { "type": "string" }, "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "readOnly": true }, "assigneeEmailAddress": { "type": "string", "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.", "readOnly": true }, "quotedFileContent": { "type": "object", "description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.", "properties": { "value": { "description": "The quoted content itself. This is interpreted as plain text if set through the API.", "type": "string" }, "mimeType": { "description": "The MIME type of the quoted content.", "type": "string" } } }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "default": "drive#comment", "type": "string" } } }, "DownloadRestrictionsMetadata": { "type": "object", "description": "Download restrictions applied to the file.", "properties": { "itemDownloadRestriction": { "description": "The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.", "$ref": "DownloadRestriction" }, "effectiveDownloadRestrictionWithContext": { "$ref": "DownloadRestriction", "description": "Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules." } }, "id": "DownloadRestrictionsMetadata" }, "Reply": { "id": "Reply", "description": "A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.", "properties": { "deleted": { "description": "Output only. Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "action": { "description": "The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`", "type": "string" }, "id": { "description": "Output only. The ID of the reply.", "type": "string" }, "createdTime": { "format": "date-time", "description": "The time at which the reply was created (RFC 3339 date-time).", "type": "string" }, "kind": { "default": "drive#reply", "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`." }, "content": { "type": "string", "description": "The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.", "annotations": { "required": [ "drive.replies.update" ] } }, "htmlContent": { "description": "Output only. The content of the reply with HTML formatting.", "type": "string" }, "modifiedTime": { "type": "string", "description": "The last time the reply was modified (RFC 3339 date-time).", "format": "date-time" }, "author": { "$ref": "User", "description": "Output only. The author of the reply. The author's email address and permission ID won't be populated." }, "mentionedEmailAddresses": { "type": "array", "items": { "type": "string" }, "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "readOnly": true }, "assigneeEmailAddress": { "type": "string", "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.", "readOnly": true } }, "type": "object" }, "AccessProposalRoleAndView": { "id": "AccessProposalRoleAndView", "description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).", "properties": { "role": { "description": "The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`", "type": "string" }, "view": { "description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.", "type": "string" } }, "type": "object" }, "LabelField": { "type": "object", "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.", "type": "array", "items": { "format": "date", "type": "string" } }, "integer": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Only present if `valueType` is `integer`." }, "text": { "type": "array", "items": { "type": "string" }, "description": "Only present if `valueType` is `text`." }, "kind": { "description": "This is always drive#labelField.", "type": "string" }, "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" }, "user": { "description": "Only present if `valueType` is `user`.", "type": "array", "items": { "$ref": "User" } }, "selection": { "type": "array", "items": { "type": "string" }, "description": "Only present if `valueType` is `selection`" }, "id": { "description": "The identifier of this label field.", "type": "string" } }, "id": "LabelField" }, "GenerateCseTokenResponse": { "type": "object", "description": "JWT and associated metadata used to generate CSE files.", "properties": { "currentKaclsName": { "description": "Name of the KACLs that the returned KACLs ID points to.", "type": "string" }, "fileId": { "description": "The fileId for which the JWT was generated.", "type": "string" }, "jwt": { "description": "The signed JSON Web Token (JWT) for the file.", "type": "string" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.", "type": "string" }, "currentKaclsId": { "type": "string", "format": "int64", "description": "The current Key ACL Service (KACLS) ID associated with the JWT." } }, "id": "GenerateCseTokenResponse" }, "FileList": { "id": "FileList", "description": "A list of files.", "properties": { "incompleteSearch": { "description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.", "type": "boolean" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.", "default": "drive#fileList", "type": "string" }, "files": { "type": "array", "items": { "$ref": "File" }, "description": "The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched." }, "nextPageToken": { "description": "The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "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": { "restrictions": { "description": "A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.", "properties": { "domainUsersOnly": { "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", "type": "boolean" }, "adminManagedRestrictions": { "description": "Whether administrative privileges on this shared drive are required to modify restrictions.", "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" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this shared 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 shared drive.", "type": "boolean" }, "downloadRestriction": { "$ref": "DownloadRestriction", "description": "Download restrictions applied by shared drive managers." }, "driveMembersOnly": { "description": "Whether access to items inside this shared drive is restricted to its members.", "type": "boolean" } }, "type": "object" }, "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" }, "xCoordinate": { "format": "float", "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.", "type": "number" }, "yCoordinate": { "format": "float", "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.", "type": "number" }, "width": { "type": "number", "format": "float", "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." } }, "type": "object" }, "kind": { "default": "drive#drive", "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`." }, "backgroundImageLink": { "description": "Output only. A short-lived link to this shared drive's background image.", "type": "string" }, "orgUnitId": { "description": "Output only. 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" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.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" }, "colorRgb": { "description": "The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.", "type": "string" }, "id": { "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "createdTime": { "type": "string", "description": "The time at which the shared drive was created (RFC 3339 date-time).", "format": "date-time" }, "hidden": { "description": "Whether the shared drive is hidden from default view.", "type": "boolean" }, "name": { "description": "The name of this shared drive.", "type": "string" }, "capabilities": { "type": "object", "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canChangeDomainUsersOnlyRestriction": { "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canListChildren": { "description": "Output only. Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canRename": { "description": "Output only. Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.", "type": "boolean" }, "canEdit": { "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" }, "canRenameDrive": { "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canManageMembers": { "description": "Output only. Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.", "type": "boolean" }, "canDeleteDrive": { "description": "Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canCopy": { "description": "Output only. Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canResetDriveRestrictions": { "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canTrashChildren": { "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" }, "canReadRevisions": { "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canChangeDownloadRestriction": { "description": "Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.", "type": "boolean" }, "canComment": { "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canShare": { "description": "Output only. Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canAddChildren": { "description": "Output only. Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canDownload": { "description": "Output only. Whether the current user can download files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" } } } }, "id": "Drive", "type": "object" }, "ContentRestriction": { "type": "object", "id": "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" }, "restrictionTime": { "type": "string", "format": "date-time", "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true." }, "restrictingUser": { "description": "Output only. The user who set the content restriction. Only populated if `readOnly=true`.", "$ref": "User" }, "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" }, "type": { "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.", "type": "string" }, "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" }, "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" } } }, "DriveList": { "id": "DriveList", "description": "A list of shared drives.", "properties": { "drives": { "type": "array", "items": { "$ref": "Drive" }, "description": "The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched." }, "nextPageToken": { "description": "The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" }, "kind": { "default": "drive#driveList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`." } }, "type": "object" }, "Revision": { "type": "object", "description": "The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.", "properties": { "published": { "description": "Whether this revision is published. This is only applicable to Docs Editors files.", "type": "boolean" }, "id": { "description": "Output only. The ID of the revision.", "type": "string" }, "exportLinks": { "description": "Output only. Links for exporting Docs Editors files to specific formats.", "type": "object", "additionalProperties": { "type": "string" } }, "size": { "format": "int64", "description": "Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", "type": "string" }, "md5Checksum": { "description": "Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", "type": "string" }, "modifiedTime": { "format": "date-time", "description": "The last time the revision was modified (RFC 3339 date-time).", "type": "string" }, "mimeType": { "description": "Output only. The MIME type of the revision.", "type": "string" }, "keepForever": { "description": "Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.", "type": "boolean" }, "publishedOutsideDomain": { "description": "Whether this revision is published outside the domain. This is only applicable to Docs Editors files.", "type": "boolean" }, "publishedLink": { "description": "Output only. A link to the published revision. This is only populated for Docs Editors files.", "type": "string" }, "originalFilename": { "description": "Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.", "type": "string" }, "publishAuto": { "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.", "type": "boolean" }, "lastModifyingUser": { "description": "Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user.", "$ref": "User" }, "kind": { "default": "drive#revision", "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`." } }, "id": "Revision" }, "DownloadRestriction": { "type": "object", "description": "A restriction for copy and download of the file.", "properties": { "restrictedForReaders": { "description": "Whether download and copy is restricted for readers.", "type": "boolean" }, "restrictedForWriters": { "description": "Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.", "type": "boolean" } }, "id": "DownloadRestriction" }, "AccessProposal": { "type": "object", "description": "Manage outstanding access proposals on a file.", "properties": { "rolesAndViews": { "type": "array", "items": { "$ref": "AccessProposalRoleAndView" }, "description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles)." }, "requestMessage": { "description": "The message that the requester added to the proposal.", "type": "string" }, "requesterEmailAddress": { "description": "The email address of the requesting user.", "type": "string" }, "fileId": { "description": "The file ID that the proposal for access is on.", "type": "string" }, "proposalId": { "description": "The ID of the access proposal.", "type": "string" }, "recipientEmailAddress": { "description": "The email address of the user that will receive permissions, if accepted.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "The creation time.", "type": "string" } }, "id": "AccessProposal" }, "CommentList": { "description": "A list of comments on a file.", "properties": { "nextPageToken": { "description": "The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.", "default": "drive#commentList", "type": "string" }, "comments": { "description": "The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "type": "array", "items": { "$ref": "Comment" } } }, "id": "CommentList", "type": "object" }, "ChangeList": { "description": "A list of changes for a user.", "properties": { "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" }, "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" }, "changes": { "type": "array", "items": { "$ref": "Change" }, "description": "The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched." }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.", "default": "drive#changeList", "type": "string" } }, "id": "ChangeList", "type": "object" }, "ResolveAccessProposalRequest": { "id": "ResolveAccessProposalRequest", "description": "Request message for resolving an AccessProposal on a file.", "properties": { "sendNotification": { "description": "Optional. Whether to send an email to the requester when the access proposal is denied or accepted.", "type": "boolean" }, "role": { "description": "Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.", "type": "array", "items": { "type": "string" } }, "view": { "description": "Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.", "type": "string" }, "action": { "enum": [ "ACTION_UNSPECIFIED", "ACCEPT", "DENY" ], "type": "string", "enumDescriptions": [ "Unspecified action", "The user accepts the access proposal. Note: If this action is used, the `role` field must have at least one value.", "The user denies the access proposal." ], "description": "Required. The action to take on the access proposal." } }, "type": "object" }, "Label": { "id": "Label", "description": "Representation of label and label fields.", "properties": { "kind": { "description": "This is always drive#label", "type": "string" }, "revisionId": { "description": "The revision ID of the label.", "type": "string" }, "id": { "description": "The ID of the label.", "type": "string" }, "fields": { "description": "A map of the fields on the label, keyed by the field's ID.", "type": "object", "additionalProperties": { "$ref": "LabelField" } } }, "type": "object" }, "ModifyLabelsResponse": { "id": "ModifyLabelsResponse", "description": "Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.", "properties": { "modifiedLabels": { "type": "array", "items": { "$ref": "Label" }, "description": "The list of labels which were added or updated by the request." }, "kind": { "description": "This is always `\"drive#modifyLabelsResponse\"`.", "type": "string" } }, "type": "object" }, "App": { "type": "object", "description": "The `apps` resource provides a list of apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. Some resource methods (such as `apps.get`) require an `appId`. Use the `apps.list` method to retrieve the ID for an installed application.", "properties": { "createUrl": { "description": "The URL to create a file with this app.", "type": "string" }, "id": { "description": "The ID of the app.", "type": "string" }, "authorized": { "description": "Whether the app is authorized to access data on the user's Drive.", "type": "boolean" }, "supportsMultiOpen": { "description": "Whether this app supports opening more than one file.", "type": "boolean" }, "primaryFileExtensions": { "description": "The list of primary file extensions.", "type": "array", "items": { "type": "string" } }, "primaryMimeTypes": { "type": "array", "items": { "type": "string" }, "description": "The list of primary MIME types." }, "hasDriveWideScope": { "description": "Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the user's Drive.", "type": "boolean" }, "supportsImport": { "description": "Whether this app supports importing from Google Docs.", "type": "boolean" }, "supportsOfflineCreate": { "description": "Whether this app supports creating files when offline.", "type": "boolean" }, "objectType": { "description": "The type of object this app creates such as a Chart. If empty, the app name should be used instead.", "type": "string" }, "secondaryMimeTypes": { "description": "The list of secondary MIME types.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of the app.", "type": "string" }, "productId": { "description": "The ID of the product listing for this app.", "type": "string" }, "secondaryFileExtensions": { "type": "array", "items": { "type": "string" }, "description": "The list of secondary file extensions." }, "createInFolderTemplate": { "description": "The template URL to create a file with this app in a given folder. The template contains the {folderId} to be replaced by the folder ID house the new file.", "type": "string" }, "icons": { "description": "The various icons for the app.", "type": "array", "items": { "$ref": "AppIcons" } }, "installed": { "description": "Whether the app is installed.", "type": "boolean" }, "longDescription": { "description": "A long description of the app.", "type": "string" }, "productUrl": { "description": "A link to the product listing for this app.", "type": "string" }, "useByDefault": { "description": "Whether the app is selected as the default handler for the types it supports.", "type": "boolean" }, "shortDescription": { "description": "A short description of the app.", "type": "string" }, "openUrlTemplate": { "description": "The template URL for opening files with this app. The template contains {ids} or {exportIds} to be replaced by the actual file IDs. For more information, see Open Files for the full documentation.", "type": "string" }, "supportsCreate": { "description": "Whether this app supports creating objects.", "type": "boolean" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#app\".", "default": "drive#app", "type": "string" } }, "id": "App" }, "AppList": { "type": "object", "id": "AppList", "description": "A list of third-party applications which the user has installed or given access to Google Drive.", "properties": { "selfLink": { "description": "A link back to this list.", "type": "string" }, "items": { "type": "array", "items": { "$ref": "App" }, "description": "The list of apps." }, "defaultAppIds": { "type": "array", "items": { "type": "string" }, "description": "The list of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest)." }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#appList\".", "default": "drive#appList", "type": "string" } } }, "Channel": { "id": "Channel", "description": "A notification channel used to watch for resource changes.", "properties": { "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" }, "payload": { "description": "A Boolean value to indicate whether payload is wanted. Optional.", "type": "boolean" }, "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "params": { "description": "Additional parameters controlling delivery channel behavior. Optional.", "type": "object", "additionalProperties": { "type": "string" } }, "kind": { "default": "api#channel", "type": "string", "description": "Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`." }, "expiration": { "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", "format": "int64", "type": "string" }, "resourceId": { "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", "type": "string" } }, "type": "object" }, "LabelList": { "type": "object", "id": "LabelList", "description": "A list of labels applied to a file.", "properties": { "nextPageToken": { "description": "The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.", "type": "string" }, "labels": { "type": "array", "items": { "$ref": "Label" }, "description": "The list of labels." }, "kind": { "description": "This is always `\"drive#labelList\"`.", "type": "string" } } }, "Change": { "type": "object", "description": "A change to a file or shared drive.", "properties": { "removed": { "description": "Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.", "type": "boolean" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.", "default": "drive#change", "type": "string" }, "teamDrive": { "$ref": "TeamDrive", "deprecated": true, "description": "Deprecated: Use `drive` instead." }, "fileId": { "description": "The ID of the file which has changed.", "type": "string" }, "changeType": { "description": "The type of the change. Possible values are `file` and `drive`.", "type": "string" }, "teamDriveId": { "type": "string", "deprecated": true, "description": "Deprecated: Use `driveId` instead." }, "type": { "deprecated": true, "description": "Deprecated: Use `changeType` instead.", "type": "string" }, "time": { "description": "The time of this change (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "drive": { "$ref": "Drive", "description": "The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted." }, "file": { "description": "The updated state of the file. Present if the type is file and the file has not been removed from this list of changes.", "$ref": "File" }, "driveId": { "description": "The ID of the shared drive associated with this change.", "type": "string" } }, "id": "Change" } }, "id": "drive:v3", "rootUrl": "https://www.googleapis.com/" }