{ "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "resources": { "teamdrives": { "methods": { "update": { "id": "drive.teamdrives.update", "parameters": { "teamDriveId": { "location": "path", "required": true, "type": "string", "description": "The ID of the Team Drive" }, "useDomainAdminAccess": { "type": "boolean", "default": "false", "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 Team Drive belongs." } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "teamdrives/{teamDriveId}", "parameterOrder": [ "teamDriveId" ], "request": { "$ref": "TeamDrive" }, "response": { "$ref": "TeamDrive" }, "description": "Deprecated: Use `drives.update` instead.", "flatPath": "teamdrives/{teamDriveId}" }, "delete": { "flatPath": "teamdrives/{teamDriveId}", "parameterOrder": [ "teamDriveId" ], "path": "teamdrives/{teamDriveId}", "description": "Deprecated: Use `drives.delete` instead.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.teamdrives.delete", "parameters": { "teamDriveId": { "description": "The ID of the Team Drive", "type": "string", "location": "path", "required": true } } }, "list": { "flatPath": "teamdrives", "description": "Deprecated: Use `drives.list` instead.", "response": { "$ref": "TeamDriveList" }, "parameterOrder": [], "path": "teamdrives", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "id": "drive.teamdrives.list", "parameters": { "pageSize": { "description": "Maximum number of Team Drives to return.", "format": "int32", "default": "10", "location": "query", "type": "integer", "minimum": "1", "maximum": "100" }, "pageToken": { "location": "query", "type": "string", "description": "Page token for Team Drives." }, "q": { "type": "string", "location": "query", "description": "Query string for searching Team Drives." }, "useDomainAdminAccess": { "default": "false", "location": "query", "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." } } }, "create": { "response": { "$ref": "TeamDrive" }, "description": "Deprecated: Use `drives.create` instead.", "flatPath": "teamdrives", "id": "drive.teamdrives.create", "parameters": { "requestId": { "type": "string", "location": "query", "required": true, "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." } }, "path": "teamdrives", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive" ], "parameterOrder": [ "requestId" ], "request": { "$ref": "TeamDrive" } }, "get": { "id": "drive.teamdrives.get", "parameters": { "teamDriveId": { "description": "The ID of the Team Drive", "location": "path", "required": true, "type": "string" }, "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 Team Drive belongs.", "default": "false", "location": "query", "type": "boolean" } }, "path": "teamdrives/{teamDriveId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "parameterOrder": [ "teamDriveId" ], "response": { "$ref": "TeamDrive" }, "description": "Deprecated: Use `drives.get` instead.", "flatPath": "teamdrives/{teamDriveId}" } } }, "approvals": { "methods": { "get": { "response": { "$ref": "Approval" }, "description": "Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).", "flatPath": "files/{fileId}/approvals/{approvalId}", "id": "drive.approvals.get", "parameters": { "fileId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the file that the approval is on." }, "approvalId": { "description": "Required. The ID of the approval.", "location": "path", "required": true, "type": "string" } }, "path": "files/{fileId}/approvals/{approvalId}", "httpMethod": "GET", "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" ], "parameterOrder": [ "fileId", "approvalId" ] }, "cancel": { "parameterOrder": [ "fileId", "approvalId" ], "request": { "$ref": "CancelApprovalRequest" }, "path": "files/{fileId}/approvals/{approvalId}:cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "id": "drive.approvals.cancel", "parameters": { "approvalId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the approval to cancel." }, "fileId": { "type": "string", "location": "path", "required": true, "description": "Required. The ID of the file that the approval is on." } }, "flatPath": "files/{fileId}/approvals/{approvalId}:cancel", "description": "Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`.", "response": { "$ref": "Approval" } }, "reassign": { "id": "drive.approvals.reassign", "parameters": { "fileId": { "description": "Required. The ID of the file that the approval is on.", "location": "path", "required": true, "type": "string" }, "approvalId": { "description": "Required. The ID of the approval to reassign.", "type": "string", "location": "path", "required": true } }, "path": "files/{fileId}/approvals/{approvalId}:reassign", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "parameterOrder": [ "fileId", "approvalId" ], "request": { "$ref": "ReassignApprovalRequest" }, "response": { "$ref": "Approval" }, "description": "Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed.", "flatPath": "files/{fileId}/approvals/{approvalId}:reassign" }, "approve": { "id": "drive.approvals.approve", "parameters": { "approvalId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the approval to approve." }, "fileId": { "type": "string", "location": "path", "required": true, "description": "Required. The ID of the file that the approval is on." } }, "path": "files/{fileId}/approvals/{approvalId}:approve", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "parameterOrder": [ "fileId", "approvalId" ], "request": { "$ref": "ApproveApprovalRequest" }, "response": { "$ref": "Approval" }, "description": "Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`.", "flatPath": "files/{fileId}/approvals/{approvalId}:approve" }, "start": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "path": "files/{fileId}/approvals:start", "parameterOrder": [ "fileId" ], "request": { "$ref": "StartApprovalRequest" }, "id": "drive.approvals.start", "parameters": { "fileId": { "description": "Required. The ID of the file that the approval is created on.", "type": "string", "location": "path", "required": true } }, "description": "Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).", "flatPath": "files/{fileId}/approvals:start", "response": { "$ref": "Approval" } }, "comment": { "response": { "$ref": "Approval" }, "description": "Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.", "flatPath": "files/{fileId}/approvals/{approvalId}:comment", "id": "drive.approvals.comment", "parameters": { "approvalId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the approval to comment on." }, "fileId": { "description": "Required. The ID of the file that the approval is on.", "type": "string", "location": "path", "required": true } }, "path": "files/{fileId}/approvals/{approvalId}:comment", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "parameterOrder": [ "fileId", "approvalId" ], "request": { "$ref": "CommentApprovalRequest" } }, "list": { "parameterOrder": [ "fileId" ], "httpMethod": "GET", "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" ], "path": "files/{fileId}/approvals", "id": "drive.approvals.list", "parameters": { "pageSize": { "description": "The maximum number of approvals to return. When not set, at most 100 approvals are returned.", "format": "int32", "location": "query", "type": "integer" }, "fileId": { "type": "string", "location": "path", "required": true, "description": "Required. The ID of the file that the approval is on." }, "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 a previous response." } }, "flatPath": "files/{fileId}/approvals", "description": "Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).", "response": { "$ref": "ApprovalList" } }, "decline": { "response": { "$ref": "Approval" }, "description": "Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`.", "flatPath": "files/{fileId}/approvals/{approvalId}:decline", "id": "drive.approvals.decline", "parameters": { "approvalId": { "description": "Required. The ID of the approval to decline.", "type": "string", "location": "path", "required": true }, "fileId": { "description": "Required. The ID of the file that the approval is on.", "type": "string", "location": "path", "required": true } }, "path": "files/{fileId}/approvals/{approvalId}:decline", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "parameterOrder": [ "fileId", "approvalId" ], "request": { "$ref": "DeclineApprovalRequest" } } } }, "about": { "methods": { "get": { "parameterOrder": [], "path": "about", "httpMethod": "GET", "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", "parameters": {}, "flatPath": "about", "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).", "response": { "$ref": "About" } } } }, "permissions": { "methods": { "list": { "flatPath": "files/{fileId}/permissions", "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).", "response": { "$ref": "PermissionList" }, "parameterOrder": [ "fileId" ], "path": "files/{fileId}/permissions", "httpMethod": "GET", "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", "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", "location": "query", "type": "boolean" }, "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 the previous response." }, "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.", "format": "int32", "type": "integer", "location": "query", "minimum": "1", "maximum": "100" }, "includePermissionsForView": { "type": "string", "location": "query", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "type": "boolean", "default": "false", "location": "query", "deprecated": true }, "fileId": { "description": "The ID of the file or shared drive.", "type": "string", "location": "path", "required": true }, "supportsAllDrives": { "type": "boolean", "default": "false", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." } } }, "delete": { "path": "files/{fileId}/permissions/{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.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "flatPath": "files/{fileId}/permissions/{permissionId}", "parameterOrder": [ "fileId", "permissionId" ], "id": "drive.permissions.delete", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file or shared drive." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "type": "boolean", "default": "false", "location": "query" }, "enforceExpansiveAccess": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: All requests use the expansive access rules." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "permissionId": { "type": "string", "location": "path", "required": true, "description": "The ID of the permission." }, "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", "location": "query", "type": "boolean" } } }, "update": { "response": { "$ref": "Permission" }, "flatPath": "files/{fileId}/permissions/{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.", "id": "drive.permissions.update", "parameters": { "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file or shared drive." }, "removeExpiration": { "default": "false", "location": "query", "type": "boolean", "description": "Whether to remove the expiration date." }, "supportsAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "enforceExpansiveAccess": { "description": "Deprecated: All requests use the expansive access rules.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "transferOwnership": { "type": "boolean", "default": "false", "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)." }, "permissionId": { "location": "path", "required": true, "type": "string", "description": "The ID of the permission." }, "useDomainAdminAccess": { "default": "false", "location": "query", "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)." } }, "parameterOrder": [ "fileId", "permissionId" ], "request": { "$ref": "Permission" }, "path": "files/{fileId}/permissions/{permissionId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "get": { "id": "drive.permissions.get", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "type": "boolean", "default": "false", "location": "query" }, "supportsTeamDrives": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "permissionId": { "type": "string", "location": "path", "required": true, "description": "The ID of the permission." }, "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).", "type": "boolean", "default": "false", "location": "query" } }, "parameterOrder": [ "fileId", "permissionId" ], "httpMethod": "GET", "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" ], "path": "files/{fileId}/permissions/{permissionId}", "response": { "$ref": "Permission" }, "flatPath": "files/{fileId}/permissions/{permissionId}", "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)." }, "create": { "id": "drive.permissions.create", "parameters": { "useDomainAdminAccess": { "default": "false", "location": "query", "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": { "description": "The ID of the file or shared drive.", "type": "string", "location": "path", "required": true }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "moveToNewOwnersRoot": { "type": "boolean", "default": "false", "location": "query", "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." }, "sendNotificationEmail": { "type": "boolean", "location": "query", "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." }, "enforceSingleParent": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: See `moveToNewOwnersRoot` for details." }, "transferOwnership": { "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).", "type": "boolean", "default": "false", "location": "query" }, "supportsAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "enforceExpansiveAccess": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: All requests use the expansive access rules." }, "emailMessage": { "description": "A plain text custom message to include in the notification email.", "type": "string", "location": "query" } }, "parameterOrder": [ "fileId" ], "request": { "$ref": "Permission" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/permissions", "response": { "$ref": "Permission" }, "flatPath": "files/{fileId}/permissions", "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." } } }, "files": { "methods": { "modifyLabels": { "id": "drive.files.modifyLabels", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file to which the labels belong." } }, "path": "files/{fileId}/modifyLabels", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ], "parameterOrder": [ "fileId" ], "request": { "$ref": "ModifyLabelsRequest" }, "response": { "$ref": "ModifyLabelsResponse" }, "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.", "flatPath": "files/{fileId}/modifyLabels" }, "update": { "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).", "flatPath": "files/{fileId}", "response": { "$ref": "File" }, "path": "files/{fileId}", "httpMethod": "PATCH", "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" ], "parameterOrder": [ "fileId" ], "supportsMediaUpload": true, "request": { "$ref": "File" }, "id": "drive.files.update", "parameters": { "enforceSingleParent": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead." }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "addParents": { "description": "A comma-separated list of parent IDs to add.", "type": "string", "location": "query" }, "useContentAsIndexableText": { "type": "boolean", "default": "false", "location": "query", "description": "Whether to use the uploaded content as indexable text." }, "keepRevisionForever": { "type": "boolean", "default": "false", "location": "query", "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." }, "ocrLanguage": { "description": "A language hint for OCR processing during image import (ISO 639-1 code).", "type": "string", "location": "query" }, "supportsAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "removeParents": { "type": "string", "location": "query", "description": "A comma-separated list of parent IDs to remove." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "includeLabels": { "type": "string", "location": "query", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." } }, "mediaUpload": { "accept": [ "*/*" ], "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/drive/v3/files/{fileId}" }, "simple": { "multipart": true, "path": "/upload/drive/v3/files/{fileId}" } }, "maxSize": "5497558138880" } }, "delete": { "id": "drive.files.delete", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "type": "boolean", "default": "false", "location": "query" }, "enforceSingleParent": { "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", "location": "query", "deprecated": true, "type": "boolean" }, "supportsTeamDrives": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}", "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.", "flatPath": "files/{fileId}", "parameterOrder": [ "fileId" ] }, "create": { "parameterOrder": [], "supportsMediaUpload": true, "request": { "$ref": "File" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "path": "files", "id": "drive.files.create", "parameters": { "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "includeLabels": { "location": "query", "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "enforceSingleParent": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Creating files in multiple folders is no longer supported." }, "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", "location": "query", "type": "boolean" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "type": "string", "location": "query" }, "useContentAsIndexableText": { "type": "boolean", "default": "false", "location": "query", "description": "Whether to use the uploaded content as indexable text." }, "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", "location": "query", "type": "boolean" }, "ocrLanguage": { "type": "string", "location": "query", "description": "A language hint for OCR processing during image import (ISO 639-1 code)." }, "supportsAllDrives": { "type": "boolean", "default": "false", "location": "query", "description": "Whether the requesting application supports both My Drives and shared drives." } }, "mediaUpload": { "maxSize": "5497558138880", "accept": [ "*/*" ], "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/drive/v3/files" }, "simple": { "multipart": true, "path": "/upload/drive/v3/files" } } }, "flatPath": "files", "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.", "response": { "$ref": "File" } }, "listLabels": { "response": { "$ref": "LabelList" }, "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).", "flatPath": "files/{fileId}/listLabels", "id": "drive.files.listLabels", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID for the file." }, "maxResults": { "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "format": "int32", "minimum": "1", "maximum": "100", "type": "integer", "default": "100", "location": "query" }, "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." } }, "httpMethod": "GET", "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" ], "path": "files/{fileId}/listLabels", "parameterOrder": [ "fileId" ] }, "get": { "httpMethod": "GET", "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" ], "path": "files/{fileId}", "parameterOrder": [ "fileId" ], "id": "drive.files.get", "parameters": { "supportsTeamDrives": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "type": "boolean", "default": "false", "location": "query" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "acknowledgeAbuse": { "type": "boolean", "default": "false", "location": "query", "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." }, "includePermissionsForView": { "location": "query", "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported." } }, "supportsMediaDownload": 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).", "flatPath": "files/{fileId}", "supportsSubscription": true, "useMediaDownloadService": true, "response": { "$ref": "File" } }, "list": { "id": "drive.files.list", "parameters": { "q": { "type": "string", "location": "query", "description": "A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files)." }, "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 the previous response." }, "spaces": { "type": "string", "default": "drive", "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": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "location": "query", "type": "boolean" }, "includeItemsFromAllDrives": { "type": "boolean", "default": "false", "location": "query", "description": "Whether both My Drive and shared drive items should be included in results." }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "type": "string", "location": "query" }, "driveId": { "description": "ID of the shared drive to search.", "location": "query", "type": "string" }, "corpus": { "location": "query", "deprecated": true, "type": "string", "description": "Deprecated: The source of files to list. Use `corpora` instead.", "enumDescriptions": [ "Files shared to the user's domain.", "Files owned by or shared to the user." ], "enum": [ "domain", "user" ] }, "orderBy": { "type": "string", "location": "query", "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 desc` 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`." }, "teamDriveId": { "location": "query", "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead." }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "pageSize": { "minimum": "1", "maximum": "1000", "type": "integer", "default": "100", "location": "query", "description": "The maximum number of files to return per page. Pages may be partial or empty even before reaching the end of the file list. If unspecified, at most 100 files are returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 100; values above 100 are changed to 100.", "format": "int32" }, "corpora": { "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).", "location": "query", "type": "string" }, "includeTeamDriveItems": { "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" } }, "parameterOrder": [], "httpMethod": "GET", "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" ], "path": "files", "response": { "$ref": "FileList" }, "flatPath": "files", "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." }, "copy": { "flatPath": "files/{fileId}/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).", "response": { "$ref": "File" }, "parameterOrder": [ "fileId" ], "request": { "$ref": "File" }, "path": "files/{fileId}/copy", "httpMethod": "POST", "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", "parameters": { "ignoreDefaultVisibility": { "default": "false", "location": "query", "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." }, "enforceSingleParent": { "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", "type": "boolean", "default": "false", "location": "query", "deprecated": true }, "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.", "type": "boolean", "default": "false", "location": "query" }, "supportsAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "ocrLanguage": { "location": "query", "type": "string", "description": "A language hint for OCR processing during image import (ISO 639-1 code)." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "location": "query", "deprecated": true, "type": "boolean" }, "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" } } }, "generateIds": { "response": { "$ref": "GeneratedIds" }, "flatPath": "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).", "id": "drive.files.generateIds", "parameters": { "count": { "description": "The number of IDs to return.", "format": "int32", "type": "integer", "default": "10", "location": "query", "minimum": "1", "maximum": "1000" }, "type": { "default": "files", "location": "query", "type": "string", "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)." }, "space": { "default": "drive", "location": "query", "type": "string", "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)." } }, "parameterOrder": [], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "path": "files/generateIds" }, "download": { "response": { "$ref": "Operation" }, "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.", "flatPath": "files/{fileId}/download", "id": "drive.files.download", "parameters": { "mimeType": { "location": "query", "type": "string", "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." }, "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" }, "fileId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the file to download." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.readonly" ], "path": "files/{fileId}/download", "parameterOrder": [ "fileId" ] }, "emptyTrash": { "id": "drive.files.emptyTrash", "parameters": { "enforceSingleParent": { "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.", "type": "boolean", "default": "false", "location": "query", "deprecated": true }, "driveId": { "type": "string", "location": "query", "description": "If set, empties the trash of the provided shared drive." } }, "path": "files/trash", "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).", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive" ], "flatPath": "files/trash", "parameterOrder": [] }, "watch": { "httpMethod": "POST", "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" ], "path": "files/{fileId}/watch", "parameterOrder": [ "fileId" ], "request": { "parameterName": "resource", "$ref": "Channel" }, "id": "drive.files.watch", "parameters": { "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "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.", "type": "boolean", "default": "false", "location": "query" }, "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "location": "query", "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" }, "supportsTeamDrives": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." } }, "description": "Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "flatPath": "files/{fileId}/watch", "supportsSubscription": true, "response": { "$ref": "Channel" } }, "export": { "id": "drive.files.export", "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "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).", "location": "query", "required": true, "type": "string" } }, "supportsMediaDownload": true, "path": "files/{fileId}/export", "httpMethod": "GET", "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" ], "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.", "flatPath": "files/{fileId}/export" }, "generateCseToken": { "parameterOrder": [], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "files/generateCseToken", "id": "drive.files.generateCseToken", "parameters": { "parent": { "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.", "type": "string", "location": "query" }, "fileId": { "type": "string", "location": "query", "description": "The ID of the file for which the JWT should be generated. If not provided, an id will be generated." } }, "flatPath": "files/generateCseToken", "description": "Generates a CSE token which can be used to create or update CSE files.", "response": { "$ref": "GenerateCseTokenResponse" } } } }, "accessproposals": { "methods": { "resolve": { "flatPath": "files/{fileId}/accessproposals/{proposalId}: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" ], "request": { "$ref": "ResolveAccessProposalRequest" }, "path": "files/{fileId}/accessproposals/{proposalId}:resolve", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.accessproposals.resolve", "parameters": { "fileId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the item the request is on." }, "proposalId": { "type": "string", "location": "path", "required": true, "description": "Required. The ID of the access proposal to resolve." } } }, "get": { "id": "drive.accessproposals.get", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "Required. The ID of the item the request is on." }, "proposalId": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the access proposal to resolve." } }, "parameterOrder": [ "fileId", "proposalId" ], "httpMethod": "GET", "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" ], "path": "files/{fileId}/accessproposals/{proposalId}", "response": { "$ref": "AccessProposal" }, "flatPath": "files/{fileId}/accessproposals/{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": { "response": { "$ref": "ListAccessProposalsResponse" }, "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.", "flatPath": "files/{fileId}/accessproposals", "id": "drive.accessproposals.list", "parameters": { "fileId": { "description": "Required. The ID of the item the request is on.", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "Optional. The continuation token on the list of access requests.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The number of results per page.", "format": "int32", "type": "integer", "location": "query" } }, "httpMethod": "GET", "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" ], "path": "files/{fileId}/accessproposals", "parameterOrder": [ "fileId" ] } } }, "replies": { "methods": { "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).", "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "response": { "$ref": "Reply" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "request": { "$ref": "Reply" }, "id": "drive.replies.update", "parameters": { "replyId": { "description": "The ID of the reply.", "location": "path", "required": true, "type": "string" }, "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." }, "commentId": { "location": "path", "required": true, "type": "string", "description": "The ID of the comment." } } }, "delete": { "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "description": "Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "id": "drive.replies.delete", "parameters": { "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." }, "replyId": { "description": "The ID of the reply.", "type": "string", "location": "path", "required": true }, "commentId": { "description": "The ID of the comment.", "location": "path", "required": true, "type": "string" } } }, "list": { "response": { "$ref": "ReplyList" }, "description": "Lists a comment's replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "flatPath": "files/{fileId}/comments/{commentId}/replies", "id": "drive.replies.list", "parameters": { "pageSize": { "description": "The maximum number of replies to return per page.", "format": "int32", "minimum": "1", "maximum": "100", "default": "20", "location": "query", "type": "integer" }, "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." }, "commentId": { "description": "The ID of the comment.", "type": "string", "location": "path", "required": true }, "includeDeleted": { "type": "boolean", "default": "false", "location": "query", "description": "Whether to include deleted replies. Deleted replies don't include their original content." }, "fileId": { "description": "The ID of the file.", "type": "string", "location": "path", "required": true } }, "path": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "GET", "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" ], "parameterOrder": [ "fileId", "commentId" ] }, "create": { "path": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "parameterOrder": [ "fileId", "commentId" ], "request": { "$ref": "Reply" }, "id": "drive.replies.create", "parameters": { "fileId": { "description": "The ID of the file.", "type": "string", "location": "path", "required": true }, "commentId": { "location": "path", "required": true, "type": "string", "description": "The ID of the comment." } }, "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).", "flatPath": "files/{fileId}/comments/{commentId}/replies", "response": { "$ref": "Reply" } }, "get": { "response": { "$ref": "Reply" }, "flatPath": "files/{fileId}/comments/{commentId}/replies/{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", "parameters": { "commentId": { "description": "The ID of the comment.", "location": "path", "required": true, "type": "string" }, "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file." }, "replyId": { "location": "path", "required": true, "type": "string", "description": "The ID of the reply." }, "includeDeleted": { "default": "false", "location": "query", "type": "boolean", "description": "Whether to return deleted replies. Deleted replies don't include their original content." } }, "parameterOrder": [ "fileId", "commentId", "replyId" ], "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "GET", "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" ] } } }, "comments": { "methods": { "get": { "response": { "$ref": "Comment" }, "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).", "flatPath": "files/{fileId}/comments/{commentId}", "id": "drive.comments.get", "parameters": { "fileId": { "description": "The ID of the file.", "type": "string", "location": "path", "required": true }, "includeDeleted": { "description": "Whether to return deleted comments. Deleted comments will not include their original content.", "default": "false", "location": "query", "type": "boolean" }, "commentId": { "description": "The ID of the comment.", "type": "string", "location": "path", "required": true } }, "path": "files/{fileId}/comments/{commentId}", "httpMethod": "GET", "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" ], "parameterOrder": [ "fileId", "commentId" ] }, "create": { "flatPath": "files/{fileId}/comments", "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).", "response": { "$ref": "Comment" }, "parameterOrder": [ "fileId" ], "request": { "$ref": "Comment" }, "path": "files/{fileId}/comments", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.comments.create", "parameters": { "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file." } } }, "list": { "response": { "$ref": "CommentList" }, "flatPath": "files/{fileId}/comments", "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).", "id": "drive.comments.list", "parameters": { "pageSize": { "minimum": "1", "maximum": "100", "type": "integer", "default": "20", "location": "query", "description": "The maximum number of comments to return per page.", "format": "int32" }, "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 the previous response." }, "startModifiedTime": { "type": "string", "location": "query", "description": "The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time)." }, "includeDeleted": { "description": "Whether to include deleted comments. Deleted comments will not include their original content.", "default": "false", "location": "query", "type": "boolean" }, "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." } }, "parameterOrder": [ "fileId" ], "httpMethod": "GET", "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" ], "path": "files/{fileId}/comments" }, "delete": { "path": "files/{fileId}/comments/{commentId}", "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "id": "drive.comments.delete", "parameters": { "fileId": { "description": "The ID of the file.", "type": "string", "location": "path", "required": true }, "commentId": { "type": "string", "location": "path", "required": true, "description": "The ID of the comment." } } }, "update": { "flatPath": "files/{fileId}/comments/{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).", "response": { "$ref": "Comment" }, "parameterOrder": [ "fileId", "commentId" ], "request": { "$ref": "Comment" }, "path": "files/{fileId}/comments/{commentId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "id": "drive.comments.update", "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "commentId": { "description": "The ID of the comment.", "location": "path", "required": true, "type": "string" } } } } }, "drives": { "methods": { "delete": { "id": "drive.drives.delete", "parameters": { "allowItemDeletion": { "type": "boolean", "default": "false", "location": "query", "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`." }, "driveId": { "description": "The ID of the shared drive.", "type": "string", "location": "path", "required": true }, "useDomainAdminAccess": { "default": "false", "location": "query", "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 shared drive belongs." } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "drives/{driveId}", "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).", "flatPath": "drives/{driveId}", "parameterOrder": [ "driveId" ] }, "update": { "id": "drive.drives.update", "parameters": { "useDomainAdminAccess": { "default": "false", "location": "query", "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 shared drive belongs." }, "driveId": { "description": "The ID of the shared drive.", "type": "string", "location": "path", "required": true } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "drives/{driveId}", "parameterOrder": [ "driveId" ], "request": { "$ref": "Drive" }, "response": { "$ref": "Drive" }, "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).", "flatPath": "drives/{driveId}" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "path": "drives", "parameterOrder": [], "id": "drive.drives.list", "parameters": { "q": { "type": "string", "location": "query", "description": "Query string for searching shared drives." }, "useDomainAdminAccess": { "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.", "type": "boolean", "default": "false", "location": "query" }, "pageSize": { "description": "Maximum number of shared drives to return per page.", "format": "int32", "minimum": "1", "maximum": "100", "type": "integer", "default": "10", "location": "query" }, "pageToken": { "description": "Page token for shared drives.", "location": "query", "type": "string" } }, "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.", "flatPath": "drives", "response": { "$ref": "DriveList" } }, "hide": { "id": "drive.drives.hide", "parameters": { "driveId": { "description": "The ID of the shared drive.", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "driveId" ], "path": "drives/{driveId}/hide", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive" ], "response": { "$ref": "Drive" }, "flatPath": "drives/{driveId}/hide", "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)." }, "create": { "response": { "$ref": "Drive" }, "flatPath": "drives", "description": "Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).", "id": "drive.drives.create", "parameters": { "requestId": { "location": "query", "required": true, "type": "string", "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." } }, "parameterOrder": [ "requestId" ], "request": { "$ref": "Drive" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "drives" }, "get": { "id": "drive.drives.get", "parameters": { "driveId": { "description": "The ID of the shared drive.", "type": "string", "location": "path", "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.", "default": "false", "location": "query", "type": "boolean" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "path": "drives/{driveId}", "parameterOrder": [ "driveId" ], "response": { "$ref": "Drive" }, "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).", "flatPath": "drives/{driveId}" }, "unhide": { "response": { "$ref": "Drive" }, "flatPath": "drives/{driveId}/unhide", "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).", "id": "drive.drives.unhide", "parameters": { "driveId": { "location": "path", "required": true, "type": "string", "description": "The ID of the shared drive." } }, "parameterOrder": [ "driveId" ], "path": "drives/{driveId}/unhide", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive" ] } } }, "revisions": { "methods": { "update": { "id": "drive.revisions.update", "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "revisionId": { "location": "path", "required": true, "type": "string", "description": "The ID of the revision." } }, "parameterOrder": [ "fileId", "revisionId" ], "request": { "$ref": "Revision" }, "path": "files/{fileId}/revisions/{revisionId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "response": { "$ref": "Revision" }, "flatPath": "files/{fileId}/revisions/{revisionId}", "description": "Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions)." }, "delete": { "id": "drive.revisions.delete", "parameters": { "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file." }, "revisionId": { "description": "The ID of the revision.", "location": "path", "required": true, "type": "string" } }, "flatPath": "files/{fileId}/revisions/{revisionId}", "parameterOrder": [ "fileId", "revisionId" ], "path": "files/{fileId}/revisions/{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).", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ] }, "get": { "flatPath": "files/{fileId}/revisions/{revisionId}", "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).", "response": { "$ref": "Revision" }, "useMediaDownloadService": true, "parameterOrder": [ "fileId", "revisionId" ], "httpMethod": "GET", "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" ], "path": "files/{fileId}/revisions/{revisionId}", "supportsMediaDownload": true, "id": "drive.revisions.get", "parameters": { "revisionId": { "location": "path", "required": true, "type": "string", "description": "The ID of the revision." }, "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.", "type": "boolean", "default": "false", "location": "query" }, "fileId": { "type": "string", "location": "path", "required": true, "description": "The ID of the file." } } }, "list": { "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.", "flatPath": "files/{fileId}/revisions", "response": { "$ref": "RevisionList" }, "path": "files/{fileId}/revisions", "httpMethod": "GET", "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": [ "fileId" ], "id": "drive.revisions.list", "parameters": { "fileId": { "location": "path", "required": true, "type": "string", "description": "The ID of the file." }, "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": { "description": "The maximum number of revisions to return per page.", "format": "int32", "type": "integer", "default": "200", "location": "query", "minimum": "1", "maximum": "1000" } } } } }, "channels": { "methods": { "stop": { "flatPath": "channels/stop", "description": "Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "id": "drive.channels.stop", "parameters": {}, "parameterOrder": [], "request": { "parameterName": "resource", "$ref": "Channel" }, "httpMethod": "POST", "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" ], "path": "channels/stop" } } }, "operations": { "methods": { "get": { "httpMethod": "GET", "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" ], "path": "operations/{name}", "parameterOrder": [ "name" ], "id": "drive.operations.get", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource." } }, "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.", "flatPath": "operations/{name}", "response": { "$ref": "Operation" } } } }, "changes": { "methods": { "watch": { "parameterOrder": [ "pageToken" ], "request": { "parameterName": "resource", "$ref": "Channel" }, "httpMethod": "POST", "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" ], "path": "changes/watch", "id": "drive.changes.watch", "parameters": { "supportsTeamDrives": { "default": "false", "location": "query", "deprecated": true, "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead." }, "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.", "type": "boolean", "default": "false", "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.", "location": "query", "required": true, "type": "string" }, "spaces": { "type": "string", "default": "drive", "location": "query", "description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'." }, "includeLabels": { "location": "query", "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response." }, "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.", "type": "boolean", "default": "true", "location": "query" }, "pageSize": { "description": "The maximum number of changes to return per page.", "format": "int32", "minimum": "1", "maximum": "1000", "default": "100", "location": "query", "type": "integer" }, "includeTeamDriveItems": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: Use `includeItemsFromAllDrives` instead." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "location": "query", "type": "boolean" }, "includeItemsFromAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether both My Drive and shared drive items should be included in results." }, "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.", "type": "boolean", "default": "false", "location": "query" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", "type": "string" }, "driveId": { "location": "query", "type": "string", "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier." }, "teamDriveId": { "location": "query", "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead." } }, "flatPath": "changes/watch", "supportsSubscription": true, "description": "Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "response": { "$ref": "Channel" } }, "getStartPageToken": { "response": { "$ref": "StartPageToken" }, "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).", "flatPath": "changes/startPageToken", "id": "drive.changes.getStartPageToken", "parameters": { "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "default": "false", "location": "query", "type": "boolean" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "type": "boolean", "default": "false", "location": "query", "deprecated": true }, "teamDriveId": { "description": "Deprecated: Use `driveId` instead.", "type": "string", "location": "query", "deprecated": true }, "driveId": { "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", "location": "query", "type": "string" } }, "httpMethod": "GET", "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" ], "path": "changes/startPageToken", "parameterOrder": [] }, "list": { "parameterOrder": [ "pageToken" ], "path": "changes", "httpMethod": "GET", "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", "parameters": { "includeTeamDriveItems": { "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "type": "boolean", "default": "false", "location": "query", "deprecated": true }, "pageSize": { "default": "100", "location": "query", "type": "integer", "minimum": "1", "maximum": "1000", "description": "The maximum number of changes to return per page.", "format": "int32" }, "includeRemoved": { "default": "true", "location": "query", "type": "boolean", "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.", "location": "query", "type": "string" }, "teamDriveId": { "type": "string", "location": "query", "deprecated": true, "description": "Deprecated: Use `driveId` instead." }, "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.", "type": "string", "location": "query" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", "type": "string" }, "includeCorpusRemovals": { "default": "false", "location": "query", "type": "boolean", "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." }, "includeItemsFromAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether both My Drive and shared drive items should be included in results." }, "supportsAllDrives": { "default": "false", "location": "query", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives." }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "type": "boolean", "default": "false", "location": "query", "deprecated": 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 or to the response from the getStartPageToken method.", "type": "string", "location": "query", "required": true }, "spaces": { "description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.", "type": "string", "default": "drive", "location": "query" }, "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.", "default": "false", "location": "query", "type": "boolean" } }, "supportsSubscription": true, "flatPath": "changes", "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).", "response": { "$ref": "ChangeList" } } } }, "apps": { "methods": { "get": { "flatPath": "apps/{appId}", "description": "Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).", "response": { "$ref": "App" }, "parameterOrder": [ "appId" ], "httpMethod": "GET", "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" ], "path": "apps/{appId}", "id": "drive.apps.get", "parameters": { "appId": { "type": "string", "location": "path", "required": true, "description": "The ID of the app." } } }, "list": { "path": "apps", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive.apps.readonly" ], "parameterOrder": [], "id": "drive.apps.list", "parameters": { "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" }, "appFilterExtensions": { "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.", "default": "", "location": "query", "type": "string" }, "appFilterMimeTypes": { "default": "", "location": "query", "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 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." } }, "description": "Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).", "flatPath": "apps", "response": { "$ref": "AppList" } } } } }, "ownerDomain": "google.com", "documentationLink": "https://developers.google.com/workspace/drive/", "baseUrl": "https://www.googleapis.com/drive/v3/", "description": "The Google Drive API allows clients to access resources from Google Drive.", "kind": "discovery#restDescription", "ownerName": "Google", "rootUrl": "https://www.googleapis.com/", "title": "Google Drive API", "parameters": { "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format." }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "quotaUser": { "location": "query", "type": "string", "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." }, "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." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "alt": { "type": "string", "default": "json", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" } }, "id": "drive:v3", "batchPath": "batch/drive/v3", "schemas": { "CommentApprovalRequest": { "id": "CommentApprovalRequest", "description": "Request for commenting on an approval.", "properties": { "message": { "description": "Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log.", "type": "string" } }, "type": "object" }, "ChangeList": { "description": "A list of changes for a user.", "properties": { "kind": { "type": "string", "default": "drive#changeList", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`." }, "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": { "description": "The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Change" }, "type": "array" }, "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" } }, "id": "ChangeList", "type": "object" }, "LabelList": { "type": "object", "description": "A list of labels applied to a file.", "properties": { "labels": { "description": "The list of labels.", "items": { "$ref": "Label" }, "type": "array" }, "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" }, "kind": { "description": "This is always `\"drive#labelList\"`.", "type": "string" } }, "id": "LabelList" }, "FileList": { "type": "object", "description": "A list of files.", "properties": { "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.", "default": "drive#fileList", "type": "string" }, "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" }, "files": { "description": "The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "File" }, "type": "array" }, "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" } }, "id": "FileList" }, "ReplaceReviewer": { "id": "ReplaceReviewer", "description": "Representation of a reviewer replacement.", "properties": { "addedReviewerEmail": { "type": "string", "description": "Required. The email of the reviewer to add." }, "removedReviewerEmail": { "description": "Required. The email of the reviewer to remove.", "type": "string" } }, "type": "object" }, "ReassignApprovalRequest": { "id": "ReassignApprovalRequest", "description": "Request for reassigning an approval. Reviewers can be added or replaced, but not removed.", "properties": { "message": { "description": "Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log.", "type": "string" }, "addReviewers": { "description": "Optional. The list of reviewers to add.", "items": { "$ref": "AddReviewer" }, "type": "array" }, "replaceReviewers": { "description": "Optional. The list of reviewer replacements.", "items": { "$ref": "ReplaceReviewer" }, "type": "array" } }, "type": "object" }, "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": { "id": { "description": "Output only. The ID of the comment.", "type": "string" }, "mentionedEmailAddresses": { "readOnly": true, "type": "array", "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "items": { "type": "string" } }, "deleted": { "description": "Output only. Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "author": { "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated.", "$ref": "User" }, "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" }, "htmlContent": { "description": "Output only. The content of the comment with HTML formatting.", "type": "string" }, "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": { "mimeType": { "type": "string", "description": "The MIME type of the quoted content." }, "value": { "description": "The quoted content itself. This is interpreted as plain text if set through the API.", "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" }, "replies": { "description": "Output only. The full list of replies to the comment in chronological order.", "items": { "$ref": "Reply" }, "type": "array" }, "modifiedTime": { "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "resolved": { "description": "Output only. Whether the comment has been resolved by one of its replies.", "type": "boolean" }, "createdTime": { "description": "The time at which the comment was created (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "assigneeEmailAddress": { "type": "string", "readOnly": true, "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset." }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "type": "string", "default": "drive#comment" } }, "id": "Comment", "type": "object" }, "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": { "teamDrivePermissionDetails": { "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "items": { "type": "object", "properties": { "inheritedFrom": { "deprecated": true, "type": "string", "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead." }, "inherited": { "deprecated": true, "type": "boolean", "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead." }, "teamDrivePermissionType": { "type": "string", "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead." }, "role": { "description": "Deprecated: Output only. Use `permissionDetails/role` instead.", "deprecated": true, "type": "string" } } }, "readOnly": true, "type": "array", "deprecated": true }, "kind": { "default": "drive#permission", "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`." }, "permissionDetails": { "description": "Output only. Details of whether the permissions on this item are inherited or are directly on this item.", "items": { "properties": { "role": { "type": "string", "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)." }, "permissionType": { "type": "string", "description": "Output only. The permission type for this user. Supported values include: * `file` * `member`" }, "inheritedFrom": { "type": "string", "readOnly": true, "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives." }, "inherited": { "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" } }, "type": "object" }, "type": "array", "readOnly": true }, "inheritedPermissionsDisabled": { "type": "boolean", "description": "When `true`, only organizers, owners, and users with permissions added directly on the item can access it." }, "emailAddress": { "description": "Output only. The email address of the user or group to which this permission refers.", "readOnly": true, "type": "string" }, "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" }, "role": { "annotations": { "required": [ "drive.permissions.create" ] }, "type": "string", "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)." }, "expirationTime": { "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", "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" }, "id": { "type": "string", "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." }, "photoLink": { "type": "string", "description": "Output only. A link to the user's profile photo, if available." }, "domain": { "readOnly": true, "type": "string", "description": "Output only. The domain to which this permission refers." }, "type": { "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" ] }, "type": "string" }, "pendingOwner": { "type": "boolean", "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." }, "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": { "type": "boolean", "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`." } }, "id": "Permission", "type": "object" }, "CommentList": { "type": "object", "id": "CommentList", "description": "A list of comments on a file.", "properties": { "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.", "type": "string", "default": "drive#commentList" }, "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.", "items": { "$ref": "Comment" }, "type": "array" }, "nextPageToken": { "type": "string", "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." } } }, "User": { "type": "object", "description": "Information about a Drive user.", "properties": { "displayName": { "readOnly": true, "type": "string", "description": "Output only. A plain text displayable name for this user." }, "photoLink": { "readOnly": true, "type": "string", "description": "Output only. A link to the user's profile photo, if available." }, "permissionId": { "type": "string", "readOnly": true, "description": "Output only. The user's ID as visible in Permission resources." }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.", "type": "string", "default": "drive#user", "readOnly": true }, "me": { "description": "Output only. Whether this user is the requesting user.", "type": "boolean", "readOnly": true }, "emailAddress": { "readOnly": true, "type": "string", "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." } }, "id": "User" }, "Label": { "description": "Representation of label and label fields.", "properties": { "kind": { "type": "string", "description": "This is always drive#label" }, "fields": { "additionalProperties": { "$ref": "LabelField" }, "description": "A map of the fields on the label, keyed by the field's ID.", "type": "object" }, "id": { "description": "The ID of the label.", "type": "string" }, "revisionId": { "description": "The revision ID of the label.", "type": "string" } }, "id": "Label", "type": "object" }, "RevisionList": { "type": "object", "description": "A list of revisions of a file.", "properties": { "revisions": { "type": "array", "description": "The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Revision" } }, "kind": { "default": "drive#revisionList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`." }, "nextPageToken": { "type": "string", "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." } }, "id": "RevisionList" }, "App": { "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": { "secondaryMimeTypes": { "type": "array", "description": "The list of secondary MIME types.", "items": { "type": "string" } }, "shortDescription": { "type": "string", "description": "A short description of the app." }, "supportsCreate": { "type": "boolean", "description": "Whether this app supports creating objects." }, "id": { "description": "The ID of the app.", "type": "string" }, "openUrlTemplate": { "type": "string", "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." }, "productUrl": { "description": "A link to the product listing for this app.", "type": "string" }, "name": { "description": "The name of the app.", "type": "string" }, "installed": { "description": "Whether the app is installed.", "type": "boolean" }, "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" }, "primaryMimeTypes": { "type": "array", "description": "The list of primary MIME types.", "items": { "type": "string" } }, "objectType": { "description": "The type of object this app creates such as a Chart. If empty, the app name should be used instead.", "type": "string" }, "supportsImport": { "type": "boolean", "description": "Whether this app supports importing from Google Docs." }, "supportsMultiOpen": { "type": "boolean", "description": "Whether this app supports opening more than one file." }, "icons": { "description": "The various icons for the app.", "items": { "$ref": "AppIcons" }, "type": "array" }, "productId": { "description": "The ID of the product listing for this app.", "type": "string" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#app\".", "type": "string", "default": "drive#app" }, "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" }, "primaryFileExtensions": { "description": "The list of primary file extensions.", "items": { "type": "string" }, "type": "array" }, "authorized": { "description": "Whether the app is authorized to access data on the user's Drive.", "type": "boolean" }, "useByDefault": { "description": "Whether the app is selected as the default handler for the types it supports.", "type": "boolean" }, "longDescription": { "description": "A long description of the app.", "type": "string" }, "secondaryFileExtensions": { "type": "array", "description": "The list of secondary file extensions.", "items": { "type": "string" } }, "createUrl": { "description": "The URL to create a file with this app.", "type": "string" }, "supportsOfflineCreate": { "type": "boolean", "description": "Whether this app supports creating files when offline." } }, "id": "App", "type": "object" }, "ReviewerResponse": { "id": "ReviewerResponse", "description": "A response on an approval made by a specific reviewer.", "properties": { "kind": { "type": "string", "description": "This is always drive#reviewerResponse." }, "reviewer": { "description": "The user that's responsible for this response.", "$ref": "User" }, "response": { "enumDescriptions": [ "The response was set to an unrecognized value.", "The reviewer hasn't responded.", "The reviewer has approved the item.", "The reviewer has declined the item." ], "description": "A reviewer’s response for the approval.", "type": "string", "enum": [ "RESPONSE_UNSPECIFIED", "NO_RESPONSE", "APPROVED", "DECLINED" ] } }, "type": "object" }, "Revision": { "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": { "mimeType": { "description": "Output only. The MIME type of the revision.", "type": "string" }, "id": { "description": "Output only. The ID of the revision.", "type": "string" }, "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" }, "modifiedTime": { "type": "string", "description": "The last time the revision was modified (RFC 3339 date-time).", "format": "date-time" }, "publishedLink": { "description": "Output only. A link to the published revision. This is only populated for Docs Editors files.", "type": "string" }, "publishedOutsideDomain": { "description": "Whether this revision is published outside the domain. This is only applicable to Docs Editors files.", "type": "boolean" }, "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" }, "publishAuto": { "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.", "type": "boolean" }, "size": { "description": "Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", "format": "int64", "type": "string" }, "originalFilename": { "type": "string", "description": "Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive." }, "exportLinks": { "additionalProperties": { "type": "string" }, "description": "Output only. Links for exporting Docs Editors files to specific formats.", "type": "object" }, "published": { "type": "boolean", "description": "Whether this revision is published. This is only applicable to Docs Editors files." }, "keepForever": { "type": "boolean", "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." }, "kind": { "default": "drive#revision", "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`." } }, "id": "Revision", "type": "object" }, "AppList": { "type": "object", "id": "AppList", "description": "A list of third-party applications which the user has installed or given access to Google Drive.", "properties": { "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#appList\".", "type": "string", "default": "drive#appList" }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "items": { "type": "array", "description": "The list of apps.", "items": { "$ref": "App" } }, "defaultAppIds": { "type": "array", "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).", "items": { "type": "string" } } } }, "PermissionList": { "type": "object", "description": "A list of permissions for a file.", "properties": { "permissions": { "description": "The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Permission" }, "type": "array" }, "nextPageToken": { "type": "string", "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." }, "kind": { "default": "drive#permissionList", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`." } }, "id": "PermissionList" }, "TeamDrive": { "type": "object", "id": "TeamDrive", "description": "Deprecated: use the drive collection instead. Next ID: 33", "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" }, "colorRgb": { "type": "string", "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`." }, "name": { "type": "string", "description": "The name of this Team Drive." }, "kind": { "type": "string", "default": "drive#teamDrive", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`." }, "createdTime": { "type": "string", "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "format": "date-time" }, "id": { "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.", "type": "string" }, "capabilities": { "description": "Capabilities the current user has on this Team Drive.", "properties": { "canDeleteChildren": { "type": "boolean", "description": "Whether the current user can delete children from folders in this Team Drive." }, "canListChildren": { "description": "Whether the current user can list the children of folders in this Team Drive.", "type": "boolean" }, "canDeleteTeamDrive": { "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this Team Drive", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.", "type": "boolean" }, "canDownload": { "type": "boolean", "description": "Whether the current user can download files in this Team Drive." }, "canReadRevisions": { "type": "boolean", "description": "Whether the current user can read the revisions resource of files in this Team Drive." }, "canCopy": { "description": "Whether the current user can copy files in this Team Drive.", "type": "boolean" }, "canManageMembers": { "type": "boolean", "description": "Whether the current user can add members to this Team Drive or remove them or change their role." }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.", "type": "boolean" }, "canRename": { "type": "boolean", "description": "Whether the current user can rename files or folders in this Team Drive." }, "canRenameTeamDrive": { "description": "Whether the current user can rename this Team Drive.", "type": "boolean" }, "canResetTeamDriveRestrictions": { "description": "Whether the current user can reset the Team Drive restrictions to defaults.", "type": "boolean" }, "canComment": { "type": "boolean", "description": "Whether the current user can comment on files in this Team Drive." }, "canChangeTeamDriveBackground": { "type": "boolean", "description": "Whether the current user can change the background of this Team Drive." }, "canChangeTeamMembersOnlyRestriction": { "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "type": "boolean", "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive." }, "canAddChildren": { "type": "boolean", "description": "Whether the current user can add children to folders in this Team Drive." }, "canShare": { "description": "Whether the current user can share files or folders in this Team Drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this Team Drive.", "type": "boolean" }, "canRemoveChildren": { "deprecated": true, "type": "boolean", "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead." }, "canChangeDownloadRestriction": { "description": "Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.", "readOnly": true, "type": "boolean" } }, "type": "object" }, "backgroundImageFile": { "type": "object", "description": "The background image file for a Team Drive.", "properties": { "xCoordinate": { "type": "number", "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" }, "id": { "description": "The ID of an image file in Drive to use for the background image.", "type": "string" }, "yCoordinate": { "type": "number", "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "format": "float" }, "width": { "type": "number", "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" } } }, "restrictions": { "type": "object", "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "properties": { "sharingFoldersRequiresOrganizerPermission": { "type": "boolean", "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." }, "teamMembersOnly": { "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive.", "type": "boolean" }, "domainUsersOnly": { "type": "boolean", "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." }, "downloadRestriction": { "description": "Download restrictions applied by shared drive managers.", "$ref": "DownloadRestriction" }, "copyRequiresWriterPermission": { "type": "boolean", "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." }, "adminManagedRestrictions": { "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", "type": "boolean" } } }, "backgroundImageLink": { "description": "A short-lived link to this Team Drive's background image.", "type": "string" }, "orgUnitId": { "type": "string", "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`." } } }, "DownloadRestrictionsMetadata": { "id": "DownloadRestrictionsMetadata", "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": { "description": "Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.", "$ref": "DownloadRestriction" } }, "type": "object" }, "File": { "id": "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": { "fileExtension": { "description": "Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.", "type": "string" }, "modifiedByMe": { "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "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.", "items": { "type": "string" }, "type": "array" }, "spaces": { "type": "array", "description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.", "items": { "type": "string" } }, "size": { "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.", "format": "int64", "type": "string" }, "shared": { "type": "boolean", "description": "Output only. Whether the file has been shared. Not populated for items in shared drives." }, "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.", "items": { "$ref": "User" }, "type": "array" }, "iconLink": { "description": "Output only. A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { "description": "The ID of the file.", "type": "string" }, "linkShareMetadata": { "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" } }, "type": "object" }, "videoMediaMetadata": { "type": "object", "description": "Output only. Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "height": { "description": "Output only. The height of the video in pixels.", "format": "int32", "type": "integer" }, "width": { "type": "integer", "description": "Output only. The width of the video in pixels.", "format": "int32" }, "durationMillis": { "description": "Output only. The duration of the video in milliseconds.", "format": "int64", "type": "string" } } }, "shortcutDetails": { "type": "object", "description": "Information about a shortcut file.", "properties": { "targetResourceKey": { "type": "string", "description": "Output only. The `resourceKey` for the target file." }, "targetId": { "type": "string", "description": "The ID of the file that this shortcut points to. Can only be set on `files.create` requests." }, "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" } } }, "labelInfo": { "type": "object", "description": "Label information on the file.", "properties": { "labels": { "type": "array", "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.", "items": { "$ref": "Label" } } } }, "writersCanShare": { "description": "Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" }, "version": { "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", "type": "string" }, "permissionIds": { "type": "array", "description": "Output only. List of permission IDs for users with access to this file.", "items": { "type": "string" } }, "createdTime": { "description": "The time at which the file was created (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "properties": { "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "thumbnailVersion": { "description": "Output only. The thumbnail version for use in thumbnail cache invalidation.", "format": "int64", "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" }, "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" }, "sha256Checksum": { "type": "string", "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." }, "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" }, "ownedByMe": { "type": "boolean", "description": "Output only. Whether the user owns the file. Not populated for items in shared drives." }, "sharingUser": { "$ref": "User", "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "hasAugmentedPermissions": { "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "folderColorRgb": { "type": "string", "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." }, "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" }, "modifiedByMeTime": { "type": "string", "description": "The last time the file was modified by the user (RFC 3339 date-time).", "format": "date-time" }, "inheritedPermissionsDisabled": { "type": "boolean", "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default." }, "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" }, "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" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { "$ref": "ContentRestriction" }, "type": "array" }, "webViewLink": { "type": "string", "description": "Output only. A link for opening the file in a relevant Google editor or viewer in a browser." }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Output only. Use `driveId` instead." }, "driveId": { "type": "string", "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives." }, "appProperties": { "additionalProperties": { "type": "string" }, "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" }, "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" }, "downloadRestrictions": { "description": "Download restrictions applied on the file.", "$ref": "DownloadRestrictionsMetadata" }, "mimeType": { "type": "string", "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." }, "hasThumbnail": { "type": "boolean", "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." }, "viewedByMeTime": { "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.", "default": "drive#file", "type": "string" }, "description": { "type": "string", "description": "A short description of the file." }, "isAppAuthorized": { "type": "boolean", "description": "Output only. Whether the file was created or opened by the requesting app." }, "sharedWithMeTime": { "type": "string", "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "format": "date-time" }, "originalFilename": { "type": "string", "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." }, "capabilities": { "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).", "properties": { "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" }, "canStartApproval": { "type": "boolean", "description": "Whether the current user can start an approval on the file." }, "canRename": { "type": "boolean", "description": "Output only. Whether the current user can rename this file." }, "canMoveItemOutOfTeamDrive": { "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "deprecated": true, "type": "boolean" }, "canListChildren": { "type": "boolean", "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." }, "canChangeItemDownloadRestriction": { "description": "Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "deprecated": true, "type": "boolean" }, "canDownload": { "type": "boolean", "description": "Output only. Whether the current user can download this file." }, "canMoveItemWithinTeamDrive": { "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead.", "type": "boolean", "deprecated": true }, "canModifyContent": { "type": "boolean", "description": "Output only. Whether the current user can modify the content of this file." }, "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" }, "canMoveTeamDriveItem": { "deprecated": true, "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead." }, "canModifyContentRestriction": { "type": "boolean", "deprecated": true, "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`." }, "canModifyLabels": { "description": "Output only. Whether the current user can modify the labels on the file.", "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" }, "canUntrash": { "type": "boolean", "description": "Output only. Whether the current user can restore this file from trash." }, "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" }, "canShare": { "type": "boolean", "description": "Output only. Whether the current user can modify the sharing settings for this file." }, "canChangeViewersCanCopyContent": { "description": "Deprecated: Output only.", "type": "boolean", "deprecated": true }, "canComment": { "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canTrash": { "type": "boolean", "description": "Output only. Whether the current user can move this file to trash." }, "canAcceptOwnership": { "type": "boolean", "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files." }, "canChangeSecurityUpdateEnabled": { "type": "boolean", "description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata." }, "canMoveChildrenWithinTeamDrive": { "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.", "type": "boolean", "deprecated": true }, "canRemoveContentRestriction": { "description": "Output only. Whether there's a content restriction on the file that can be removed by the current user.", "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" }, "canEdit": { "type": "boolean", "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`." }, "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" }, "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" }, "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" }, "canMoveChildrenWithinDrive": { "type": "boolean", "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." }, "canReadLabels": { "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canDelete": { "type": "boolean", "description": "Output only. Whether the current user can delete this file." }, "canReadTeamDrive": { "deprecated": true, "type": "boolean", "description": "Deprecated: Output only. Use `canReadDrive` instead." }, "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" }, "canModifyOwnerContentRestriction": { "description": "Output only. Whether the current user can add or modify content restrictions which are owner restricted.", "type": "boolean" }, "canReadDrive": { "type": "boolean", "description": "Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives." }, "canDisableInheritedPermissions": { "description": "Whether a user can disable 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" }, "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" }, "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" }, "canModifyEditorContentRestriction": { "type": "boolean", "description": "Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted." }, "canEnableInheritedPermissions": { "description": "Whether a user can re-enable inherited permissions.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.", "deprecated": true, "type": "boolean" } }, "type": "object" }, "exportLinks": { "description": "Output only. Links for exporting Docs Editors files to specific formats.", "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "viewersCanCopyContent": { "type": "boolean", "deprecated": true, "description": "Deprecated: Use `copyRequiresWriterPermission` instead." }, "explicitlyTrashed": { "type": "boolean", "description": "Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder." }, "viewedByMe": { "type": "boolean", "description": "Output only. Whether the file has been viewed by this user." }, "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." }, "permissions": { "type": "array", "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.", "items": { "$ref": "Permission" } }, "webContentLink": { "type": "string", "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." }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters.", "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" }, "quotaBytesUsed": { "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.", "format": "int64", "type": "string" }, "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" }, "starred": { "description": "Whether the user has starred the file.", "type": "boolean" }, "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": { "type": "object", "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { "description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).", "format": "byte", "type": "string" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } } }, "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" } } }, "imageMediaMetadata": { "description": "Output only. Additional metadata about image media, if available.", "properties": { "exposureTime": { "description": "Output only. The length of the exposure, in seconds.", "format": "float", "type": "number" }, "meteringMode": { "type": "string", "description": "Output only. The metering mode used to create the photo." }, "whiteBalance": { "type": "string", "description": "Output only. The white balance mode used to create the photo." }, "location": { "type": "object", "description": "Output only. Geographic location information stored in the image.", "properties": { "latitude": { "type": "number", "description": "Output only. The latitude stored in the image.", "format": "double" }, "longitude": { "description": "Output only. The longitude stored in the image.", "format": "double", "type": "number" }, "altitude": { "description": "Output only. The altitude stored in the image.", "format": "double", "type": "number" } } }, "aperture": { "type": "number", "description": "Output only. The aperture used to create the photo (f-number).", "format": "float" }, "sensor": { "type": "string", "description": "Output only. The type of sensor used to create the photo." }, "colorSpace": { "description": "Output only. The color space of the photo.", "type": "string" }, "lens": { "description": "Output only. The lens used to create the photo.", "type": "string" }, "rotation": { "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.", "format": "int32", "type": "integer" }, "focalLength": { "type": "number", "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float" }, "isoSpeed": { "description": "Output only. The ISO speed used to create the photo.", "format": "int32", "type": "integer" }, "subjectDistance": { "type": "integer", "description": "Output only. The distance to the subject of the photo, in meters.", "format": "int32" }, "flashUsed": { "type": "boolean", "description": "Output only. Whether a flash was used to create the photo." }, "width": { "type": "integer", "description": "Output only. The width of the image in pixels.", "format": "int32" }, "maxApertureValue": { "type": "number", "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "format": "float" }, "exposureBias": { "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float", "type": "number" }, "cameraMake": { "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "time": { "description": "Output only. The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "exposureMode": { "description": "Output only. The exposure mode used to create the photo.", "type": "string" }, "height": { "description": "Output only. The height of the image in pixels.", "format": "int32", "type": "integer" }, "cameraModel": { "type": "string", "description": "Output only. The model of the camera used to create the photo." } }, "type": "object" }, "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" }, "resourceKey": { "type": "string", "description": "Output only. A key needed to access the item via a shared link." } }, "type": "object" }, "ModifyLabelsResponse": { "type": "object", "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", "description": "The list of labels which were added or updated by the request.", "items": { "$ref": "Label" } }, "kind": { "type": "string", "description": "This is always `\"drive#modifyLabelsResponse\"`." } } }, "StartApprovalRequest": { "id": "StartApprovalRequest", "description": "Allows creating an approval on a file.", "properties": { "lockFile": { "type": "boolean", "description": "Optional. Whether to lock the file when starting the approval." }, "message": { "description": "Optional. A message to send to reviewers when notifying them of the approval request.", "type": "string" }, "reviewerEmails": { "type": "array", "description": "Required. The emails of the users who are set to review the approval.", "items": { "type": "string" } }, "dueTime": { "type": "string", "description": "Optional. The time that the approval is due.", "format": "google-datetime" } }, "type": "object" }, "DeclineApprovalRequest": { "id": "DeclineApprovalRequest", "description": "Request for declining an approval as a reviewer.", "properties": { "message": { "description": "Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.", "type": "string" } }, "type": "object" }, "LabelField": { "id": "LabelField", "description": "Representation of field, which is a typed key-value pair.", "properties": { "dateString": { "description": "Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.", "items": { "type": "string", "format": "date" }, "type": "array" }, "user": { "description": "Only present if `valueType` is `user`.", "items": { "$ref": "User" }, "type": "array" }, "kind": { "type": "string", "description": "This is always drive#labelField." }, "integer": { "type": "array", "description": "Only present if `valueType` is `integer`.", "items": { "type": "string", "format": "int64" } }, "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" }, "id": { "description": "The identifier of this label field.", "type": "string" }, "selection": { "type": "array", "description": "Only present if `valueType` is `selection`", "items": { "type": "string" } }, "text": { "description": "Only present if `valueType` is `text`.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Status": { "type": "object", "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": { "type": "string", "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." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array" } }, "id": "Status" }, "StartPageToken": { "id": "StartPageToken", "properties": { "startPageToken": { "type": "string", "description": "The starting page token for listing future changes. The page token doesn't expire." }, "kind": { "default": "drive#startPageToken", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`." } }, "type": "object" }, "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": { "fieldModifications": { "description": "The list of modifications to this label's fields.", "items": { "$ref": "LabelFieldModification" }, "type": "array" }, "labelId": { "description": "The ID of the label to modify.", "annotations": { "required": [ "drive.files.modifyLabels" ] }, "type": "string" }, "removeLabel": { "description": "If true, the label will be removed from the file.", "type": "boolean" }, "kind": { "description": "This is always `\"drive#labelModification\"`.", "type": "string" } }, "id": "LabelModification" }, "AddReviewer": { "type": "object", "id": "AddReviewer", "description": "Representation of a reviewer addition.", "properties": { "addedReviewerEmail": { "type": "string", "description": "Required. The email of the reviewer to add." } } }, "CancelApprovalRequest": { "type": "object", "id": "CancelApprovalRequest", "description": "Request for cancelling an approval as an initiator.", "properties": { "message": { "description": "Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log.", "type": "string" } } }, "Change": { "description": "A change to a file or shared drive.", "properties": { "teamDrive": { "description": "Deprecated: Use `drive` instead.", "$ref": "TeamDrive", "deprecated": true }, "removed": { "type": "boolean", "description": "Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access." }, "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" }, "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.", "$ref": "Drive" }, "type": { "deprecated": true, "type": "string", "description": "Deprecated: Use `changeType` instead." }, "teamDriveId": { "type": "string", "deprecated": true, "description": "Deprecated: Use `driveId` instead." }, "driveId": { "type": "string", "description": "The ID of the shared drive associated with this change." }, "fileId": { "type": "string", "description": "The ID of the file which has changed." }, "changeType": { "type": "string", "description": "The type of the change. Possible values are `file` and `drive`." }, "kind": { "default": "drive#change", "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`." }, "time": { "type": "string", "description": "The time of this change (RFC 3339 date-time).", "format": "date-time" } }, "id": "Change", "type": "object" }, "Drive": { "type": "object", "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": { "name": { "description": "The name of this shared drive.", "type": "string" }, "kind": { "type": "string", "default": "drive#drive", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`." }, "colorRgb": { "type": "string", "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`." }, "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" }, "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" }, "hidden": { "type": "boolean", "description": "Whether the shared drive is hidden from default view." }, "backgroundImageFile": { "type": "object", "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": { "yCoordinate": { "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "format": "float", "type": "number" }, "width": { "type": "number", "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" }, "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" }, "id": { "description": "The ID of an image file in Google Drive to use for the background image.", "type": "string" } } }, "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": { "driveMembersOnly": { "type": "boolean", "description": "Whether access to items inside this shared drive is restricted to its members." }, "sharingFoldersRequiresOrganizerPermission": { "type": "boolean", "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." }, "copyRequiresWriterPermission": { "type": "boolean", "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." }, "adminManagedRestrictions": { "type": "boolean", "description": "Whether administrative privileges on this shared drive are required to modify restrictions." }, "domainUsersOnly": { "type": "boolean", "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." }, "downloadRestriction": { "$ref": "DownloadRestriction", "description": "Download restrictions applied by shared drive managers." } }, "type": "object" }, "id": { "type": "string", "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive." }, "capabilities": { "type": "object", "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canRenameDrive": { "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canComment": { "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive." }, "canAddChildren": { "type": "boolean", "description": "Output only. Whether the current user can add children to folders in this shared drive." }, "canShare": { "type": "boolean", "description": "Output only. Whether the current user can share files or folders in this shared drive." }, "canTrashChildren": { "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive." }, "canChangeDownloadRestriction": { "description": "Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.", "type": "boolean" }, "canResetDriveRestrictions": { "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canChangeDriveBackground": { "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canDownload": { "type": "boolean", "description": "Output only. Whether the current user can download files in this shared drive." }, "canReadRevisions": { "type": "boolean", "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive." }, "canEdit": { "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canListChildren": { "type": "boolean", "description": "Output only. Whether the current user can list the children of folders in this shared drive." }, "canDeleteChildren": { "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canRename": { "type": "boolean", "description": "Output only. Whether the current user can rename files or folders in this shared drive." }, "canManageMembers": { "description": "Output only. Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive." }, "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" } } }, "createdTime": { "description": "The time at which the shared drive was created (RFC 3339 date-time).", "format": "date-time", "type": "string" } }, "id": "Drive" }, "AppIcons": { "id": "AppIcons", "properties": { "size": { "description": "Size of the icon. Represented as the maximum of the width and height.", "format": "int32", "type": "integer" }, "category": { "type": "string", "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." }, "iconUrl": { "type": "string", "description": "URL for the icon." } }, "type": "object" }, "Approval": { "description": "Metadata for an approval. An approval is a review or approve process for a Drive item.", "properties": { "completeTime": { "readOnly": true, "type": "string", "description": "Output only. The time the approval was completed.", "format": "google-datetime" }, "approvalId": { "description": "The approval ID.", "type": "string" }, "initiator": { "description": "The user that requested the approval.", "$ref": "User" }, "targetFileId": { "description": "Target file id of the approval.", "type": "string" }, "createTime": { "description": "Output only. The time the approval was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "kind": { "type": "string", "description": "This is always drive#approval." }, "dueTime": { "type": "string", "description": "The time that the approval is due.", "format": "google-datetime" }, "status": { "type": "string", "description": "Output only. The status of the approval at the time this resource was requested.", "enumDescriptions": [ "The 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." ], "readOnly": true, "enum": [ "STATUS_UNSPECIFIED", "IN_PROGRESS", "APPROVED", "CANCELLED", "DECLINED" ] }, "reviewerResponses": { "type": "array", "description": "The responses made on the approval by reviewers.", "items": { "$ref": "ReviewerResponse" } }, "modifyTime": { "readOnly": true, "type": "string", "description": "Output only. The most recent time the approval was modified.", "format": "google-datetime" } }, "id": "Approval", "type": "object" }, "DownloadRestriction": { "id": "DownloadRestriction", "description": "A restriction for copy and download of the file.", "properties": { "restrictedForReaders": { "type": "boolean", "description": "Whether download and copy is restricted for readers." }, "restrictedForWriters": { "description": "Whether download and copy is restricted for writers. If true, download is also restricted for readers.", "type": "boolean" } }, "type": "object" }, "Operation": { "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "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": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "type": "object", "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`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "done": { "type": "boolean", "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." }, "name": { "type": "string", "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}`." } }, "id": "Operation" }, "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": { "type": "string", "description": "The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`" }, "view": { "type": "string", "description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported." } }, "type": "object" }, "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" }, "jwt": { "description": "The signed JSON Web Token (JWT) for the file.", "type": "string" }, "currentKaclsId": { "type": "string", "description": "The current Key ACL Service (KACLS) ID associated with the JWT.", "format": "int64" }, "kind": { "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`." }, "fileId": { "type": "string", "description": "The fileId for which the JWT was generated." } }, "id": "GenerateCseTokenResponse" }, "ApproveApprovalRequest": { "id": "ApproveApprovalRequest", "description": "Request for approving an approval as a reviewer.", "properties": { "message": { "description": "Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.", "type": "string" } }, "type": "object" }, "ModifyLabelsRequest": { "type": "object", "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", "description": "The list of modifications to apply to the labels on the file.", "items": { "$ref": "LabelModification" } }, "kind": { "type": "string", "description": "This is always `\"drive#modifyLabelsRequest\"`." } }, "id": "ModifyLabelsRequest" }, "LabelFieldModification": { "type": "object", "id": "LabelFieldModification", "description": "A modification to a label's field.", "properties": { "setIntegerValues": { "description": "Replaces the value of an `integer` field with these new values.", "items": { "format": "int64", "type": "string" }, "type": "array" }, "setSelectionValues": { "type": "array", "description": "Replaces a `selection` field with these new values.", "items": { "type": "string" } }, "fieldId": { "type": "string", "description": "The ID of the field to be modified." }, "kind": { "description": "This is always `\"drive#labelFieldModification\"`.", "type": "string" }, "setTextValues": { "type": "array", "description": "Sets the value of a `text` field.", "items": { "type": "string" } }, "setUserValues": { "description": "Replaces a `user` field with these new values. The values must be a valid email addresses.", "items": { "type": "string" }, "type": "array" }, "unsetValues": { "type": "boolean", "description": "Unsets the values for this field." }, "setDateValues": { "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.", "items": { "format": "date", "type": "string" }, "type": "array" } } }, "ClientEncryptionDetails": { "type": "object", "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": { "$ref": "DecryptionMetadata", "description": "The metadata used for client-side operations." } }, "id": "ClientEncryptionDetails" }, "ResolveAccessProposalRequest": { "id": "ResolveAccessProposalRequest", "description": "Request message for resolving an AccessProposal on a file.", "properties": { "view": { "type": "string", "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." }, "sendNotification": { "type": "boolean", "description": "Optional. Whether to send an email to the requester when the access proposal is denied or accepted." }, "role": { "type": "array", "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.", "items": { "type": "string" } }, "action": { "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": "string", "enum": [ "ACTION_UNSPECIFIED", "ACCEPT", "DENY" ] } }, "type": "object" }, "ApprovalList": { "description": "The response of an approvals list request.", "properties": { "nextPageToken": { "description": "The page token for the next page of approvals. This is 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": { "type": "string", "description": "This is always drive#approvalList" }, "items": { "type": "array", "description": "The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Approval" } } }, "id": "ApprovalList", "type": "object" }, "DriveList": { "id": "DriveList", "description": "A list of shared drives.", "properties": { "kind": { "type": "string", "default": "drive#driveList", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`." }, "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" }, "drives": { "type": "array", "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.", "items": { "$ref": "Drive" } } }, "type": "object" }, "TeamDriveList": { "id": "TeamDriveList", "description": "A list of Team Drives.", "properties": { "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" }, "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.", "items": { "$ref": "TeamDrive" }, "type": "array" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`.", "type": "string", "default": "drive#teamDriveList" } }, "type": "object" }, "GeneratedIds": { "id": "GeneratedIds", "description": "A list of generated file IDs which can be provided in create requests.", "properties": { "kind": { "type": "string", "default": "drive#generatedIds", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`." }, "ids": { "description": "The IDs generated for the requesting user in the specified space.", "items": { "type": "string" }, "type": "array" }, "space": { "type": "string", "description": "The type of file that can be created with these IDs." } }, "type": "object" }, "ReplyList": { "description": "A list of replies to a comment on a file.", "properties": { "replies": { "type": "array", "description": "The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "Reply" } }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`.", "type": "string", "default": "drive#replyList" }, "nextPageToken": { "type": "string", "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." } }, "id": "ReplyList", "type": "object" }, "ListAccessProposalsResponse": { "type": "object", "description": "The response to an access proposal list request.", "properties": { "accessProposals": { "type": "array", "description": "The list of access proposals. This field is only populated in Drive API v3.", "items": { "$ref": "AccessProposal" } }, "nextPageToken": { "type": "string", "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." } }, "id": "ListAccessProposalsResponse" }, "Reply": { "type": "object", "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": { "kind": { "type": "string", "default": "drive#reply", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`." }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "content": { "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" ] }, "type": "string" }, "assigneeEmailAddress": { "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.", "type": "string", "readOnly": true }, "author": { "description": "Output only. The author of the reply. The author's email address and permission ID won't be populated.", "$ref": "User" }, "htmlContent": { "description": "Output only. The content of the reply with HTML formatting.", "type": "string" }, "mentionedEmailAddresses": { "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "deleted": { "description": "Output only. Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "id": { "type": "string", "description": "Output only. The ID of the reply." }, "createdTime": { "type": "string", "description": "The time at which the reply was created (RFC 3339 date-time).", "format": "date-time" }, "action": { "description": "The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`", "type": "string" } } }, "Channel": { "id": "Channel", "description": "A notification channel used to watch for resource changes.", "properties": { "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" }, "token": { "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", "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`." }, "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" or \"webhook\".", "type": "string" }, "params": { "description": "Additional parameters controlling delivery channel behavior. Optional.", "additionalProperties": { "type": "string" }, "type": "object" }, "payload": { "type": "boolean", "description": "A Boolean value to indicate whether payload is wanted. Optional." } }, "type": "object" }, "DecryptionMetadata": { "id": "DecryptionMetadata", "description": "Representation of the CSE DecryptionMetadata.", "properties": { "kaclsId": { "type": "string", "description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", "format": "int64" }, "jwt": { "type": "string", "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." }, "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" }, "wrappedKey": { "type": "string", "description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file." }, "kaclsName": { "description": "The name of the KACLS (Key ACL Service) used to encrypt the file.", "type": "string" }, "encryptionResourceKeyHash": { "type": "string", "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": "object" }, "About": { "type": "object", "id": "About", "description": "Information about the user, the user's Drive, and system capabilities.", "properties": { "canCreateDrives": { "description": "Whether the user can create shared drives.", "type": "boolean" }, "folderColorPalette": { "type": "array", "description": "The currently supported folder colors as RGB hex strings.", "items": { "type": "string" } }, "maxImportSizes": { "additionalProperties": { "format": "int64", "type": "string" }, "description": "A map of maximum import sizes by MIME type, in bytes.", "type": "object" }, "exportFormats": { "type": "object", "description": "A map of source MIME type to possible targets for all supported exports.", "additionalProperties": { "items": { "type": "string" }, "type": "array" } }, "canCreateTeamDrives": { "description": "Deprecated: Use `canCreateDrives` instead.", "type": "boolean", "deprecated": true }, "appInstalled": { "description": "Whether the user has installed the requesting app.", "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": { "limit": { "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.", "format": "int64", "type": "string" }, "usageInDrive": { "type": "string", "description": "The usage by all files in Google Drive.", "format": "int64" }, "usageInDriveTrash": { "type": "string", "description": "The usage by trashed files in Google Drive.", "format": "int64" }, "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" } }, "type": "object" }, "maxUploadSize": { "type": "string", "description": "The maximum upload size in bytes.", "format": "int64" }, "importFormats": { "type": "object", "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "A map of source MIME type to possible targets for all supported imports." }, "teamDriveThemes": { "deprecated": true, "type": "array", "description": "Deprecated: Use `driveThemes` instead.", "items": { "properties": { "id": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveThemes/id` instead." }, "backgroundImageLink": { "type": "string", "deprecated": true, "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead." }, "colorRgb": { "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "type": "string", "deprecated": true } }, "type": "object" } }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`.", "default": "drive#about", "type": "string" }, "driveThemes": { "type": "array", "description": "A list of themes that are supported for shared drives.", "items": { "type": "object", "properties": { "id": { "description": "The ID of the theme.", "type": "string" }, "backgroundImageLink": { "type": "string", "description": "A link to this theme's background image." }, "colorRgb": { "type": "string", "description": "The color of this theme as an RGB hex string." } } } }, "user": { "description": "The authenticated user.", "$ref": "User" } } }, "ContentRestriction": { "type": "object", "description": "A restriction for accessing the content of the file.", "properties": { "systemRestricted": { "type": "boolean", "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": { "type": "string", "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`." }, "reason": { "type": "string", "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`." }, "restrictingUser": { "$ref": "User", "description": "Output only. The user who set the content restriction. Only populated if `readOnly=true`." }, "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" }, "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", "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "format": "date-time" } }, "id": "ContentRestriction" }, "AccessProposal": { "id": "AccessProposal", "description": "Manage outstanding access proposals on a file.", "properties": { "requesterEmailAddress": { "type": "string", "description": "The email address of the requesting user." }, "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" }, "requestMessage": { "type": "string", "description": "The message that the requester added to the proposal." }, "rolesAndViews": { "type": "array", "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).", "items": { "$ref": "AccessProposalRoleAndView" } }, "createTime": { "type": "string", "description": "The creation time.", "format": "google-datetime" }, "fileId": { "type": "string", "description": "The file ID that the proposal for access is on." } }, "type": "object" } }, "basePath": "/drive/v3/", "discoveryVersion": "v1", "version": "v3", "servicePath": "drive/v3/", "auth": { "oauth2": { "scopes": { "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.photos.readonly": { "description": "View the photos, videos and albums in your Google Photos" }, "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.metadata": { "description": "View and manage metadata of files 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.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": { "description": "See, edit, create, and delete all of your Google Drive files" }, "https://www.googleapis.com/auth/drive.readonly": { "description": "See and download all your Google Drive files" }, "https://www.googleapis.com/auth/drive.apps.readonly": { "description": "View your Google Drive apps" } } } }, "mtlsRootUrl": "https://www.mtls.googleapis.com/", "protocol": "rest", "revision": "20260615", "name": "drive" }