{ "resources": { "apps": { "methods": { "get": { "httpMethod": "GET", "response": { "$ref": "App" }, "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" ], "parameters": { "appId": { "required": true, "description": "The ID of the app.", "location": "path", "type": "string" } }, "id": "drive.apps.get", "flatPath": "apps/{appId}", "parameterOrder": [ "appId" ], "description": "Gets a specific app.", "path": "apps/{appId}" }, "list": { "httpMethod": "GET", "response": { "$ref": "AppList" }, "scopes": [ "https://www.googleapis.com/auth/drive.apps.readonly" ], "parameters": { "appFilterMimeTypes": { "type": "string", "default": "", "description": "A comma-separated list of MIME types for open with filtering. All apps 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.", "location": "query" }, "languageCode": { "type": "string", "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/).", "location": "query" }, "appFilterExtensions": { "default": "", "type": "string", "description": "A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists.", "location": "query" } }, "flatPath": "apps", "parameterOrder": [], "description": "Lists a user's installed apps.", "id": "drive.apps.list", "path": "apps" } } }, "children": { "methods": { "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" ], "response": { "$ref": "ChildReference" }, "parameters": { "folderId": { "type": "string", "description": "The ID of the folder.", "location": "path", "required": true }, "childId": { "type": "string", "description": "The ID of the child.", "location": "path", "required": true } }, "path": "files/{folderId}/children/{childId}", "flatPath": "files/{folderId}/children/{childId}", "parameterOrder": [ "folderId", "childId" ], "description": "Gets a specific child reference.", "id": "drive.children.get" }, "list": { "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "ChildList" }, "httpMethod": "GET", "path": "files/{folderId}/children", "flatPath": "files/{folderId}/children", "parameterOrder": [ "folderId" ], "description": "Lists a folder's children.", "id": "drive.children.list", "parameters": { "folderId": { "required": true, "description": "The ID of the folder.", "location": "path", "type": "string" }, "maxResults": { "type": "integer", "default": "100", "location": "query", "minimum": "0", "format": "int32", "description": "Maximum number of children to return." }, "orderBy": { "type": "string", "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", "location": "query" }, "q": { "type": "string", "description": "Query string for searching children.", "location": "query" }, "pageToken": { "description": "Page token for children.", "location": "query", "type": "string" } } }, "delete": { "httpMethod": "DELETE", "parameters": { "folderId": { "type": "string", "required": true, "description": "The ID of the folder.", "location": "path" }, "childId": { "required": true, "description": "The ID of the child.", "location": "path", "type": "string" }, "enforceSingleParent": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root." } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{folderId}/children/{childId}", "flatPath": "files/{folderId}/children/{childId}", "parameterOrder": [ "folderId", "childId" ], "description": "Removes a child from a folder.", "id": "drive.children.delete" }, "insert": { "request": { "$ref": "ChildReference" }, "response": { "$ref": "ChildReference" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "httpMethod": "POST", "id": "drive.children.insert", "flatPath": "files/{folderId}/children", "parameterOrder": [ "folderId" ], "description": "Inserts a file into a folder.", "path": "files/{folderId}/children", "parameters": { "enforceSingleParent": { "deprecated": true, "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "default": "false", "type": "boolean", "location": "query" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "location": "query", "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true }, "folderId": { "type": "string", "required": true, "description": "The ID of the folder.", "location": "path" } } } } }, "about": { "methods": { "get": { "parameters": { "startChangeId": { "type": "string", "format": "int64", "description": "Change ID to start counting from when calculating number of remaining change IDs", "location": "query" }, "includeSubscribed": { "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the `maxChangeIdCount`.", "location": "query", "type": "boolean", "default": "true" }, "maxChangeIdCount": { "format": "int64", "description": "Maximum number of remaining change IDs to count", "type": "string", "default": "1", "location": "query" } }, "path": "about", "flatPath": "about", "parameterOrder": [], "description": "Gets the information about the current user along with Drive API settings", "id": "drive.about.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.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "About" } } } }, "changes": { "methods": { "watch": { "parameters": { "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "includeItemsFromAllDrives": { "description": "Whether both My Drive and shared drive items should be included in results.", "location": "query", "type": "boolean", "default": "false" }, "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "includeSubscribed": { "type": "boolean", "default": "true", "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", "location": "query" }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead.", "location": "query" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "driveId": { "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", "location": "query", "type": "string" }, "spaces": { "type": "string", "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", "location": "query" }, "includeTeamDriveItems": { "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "maxResults": { "default": "100", "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "Maximum number of changes to return." }, "startChangeId": { "deprecated": true, "format": "int64", "description": "Deprecated: Use `pageToken` instead.", "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" }, "includeDeleted": { "default": "true", "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.", "location": "query" }, "pageToken": { "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 or to the response from the getStartPageToken method.", "location": "query" }, "includeCorpusRemovals": { "description": "Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.", "location": "query", "type": "boolean", "default": "false" } }, "id": "drive.changes.watch", "flatPath": "changes/watch", "parameterOrder": [], "description": "Subscribe to changes for a user.", "path": "changes/watch", "httpMethod": "POST", "supportsSubscription": true, "request": { "parameterName": "resource", "$ref": "Channel" }, "response": { "$ref": "Channel" }, "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.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" ] }, "get": { "parameters": { "changeId": { "type": "string", "description": "The ID of the change.", "location": "path", "required": true }, "driveId": { "description": "The shared drive from which the change will be returned.", "location": "query", "type": "string" }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead.", "location": "query" }, "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." } }, "id": "drive.changes.get", "flatPath": "changes/{changeId}", "parameterOrder": [ "changeId" ], "description": "Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.", "path": "changes/{changeId}", "httpMethod": "GET", "response": { "$ref": "Change" }, "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.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" ] }, "getStartPageToken": { "response": { "$ref": "StartPageToken" }, "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.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" ], "httpMethod": "GET", "id": "drive.changes.getStartPageToken", "flatPath": "changes/startPageToken", "parameterOrder": [], "description": "Gets the starting pageToken for listing future changes.", "path": "changes/startPageToken", "parameters": { "driveId": { "type": "string", "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" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead.", "location": "query" } } }, "list": { "httpMethod": "GET", "supportsSubscription": true, "response": { "$ref": "ChangeList" }, "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.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" ], "parameters": { "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "includeItemsFromAllDrives": { "description": "Whether both My Drive and shared drive items should be included in results.", "location": "query", "type": "boolean", "default": "false" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "driveId": { "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.", "location": "query" }, "spaces": { "type": "string", "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", "location": "query" }, "includeTeamDriveItems": { "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "includeSubscribed": { "default": "true", "type": "boolean", "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", "location": "query" }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead.", "location": "query" }, "supportsTeamDrives": { "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "location": "query" }, "includeDeleted": { "description": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.", "location": "query", "type": "boolean", "default": "true" }, "pageToken": { "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 or to the response from the getStartPageToken method.", "location": "query" }, "includeCorpusRemovals": { "description": "Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.", "location": "query", "default": "false", "type": "boolean" }, "maxResults": { "location": "query", "default": "100", "type": "integer", "description": "Maximum number of changes to return.", "minimum": "1", "format": "int32" }, "startChangeId": { "type": "string", "location": "query", "deprecated": true, "format": "int64", "description": "Deprecated: Use `pageToken` instead." }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" } }, "flatPath": "changes", "parameterOrder": [], "description": "Lists the changes for a user or shared drive.", "id": "drive.changes.list", "path": "changes" } } }, "drives": { "methods": { "unhide": { "parameters": { "driveId": { "type": "string", "required": true, "description": "The ID of the shared drive.", "location": "path" } }, "path": "drives/{driveId}/unhide", "id": "drive.drives.unhide", "flatPath": "drives/{driveId}/unhide", "parameterOrder": [ "driveId" ], "description": "Restores a shared drive to the default view.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive" ], "response": { "$ref": "Drive" } }, "update": { "path": "drives/{driveId}", "id": "drive.drives.update", "flatPath": "drives/{driveId}", "parameterOrder": [ "driveId" ], "description": "Updates the metadata for a shared drive.", "parameters": { "driveId": { "type": "string", "required": true, "description": "The ID of the shared drive.", "location": "path" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "request": { "$ref": "Drive" }, "response": { "$ref": "Drive" }, "httpMethod": "PUT" }, "get": { "parameters": { "driveId": { "description": "The ID of the shared 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 shared drive belongs.", "location": "query", "type": "boolean", "default": "false" } }, "flatPath": "drives/{driveId}", "parameterOrder": [ "driveId" ], "description": "Gets a shared drive's metadata by ID.", "id": "drive.drives.get", "path": "drives/{driveId}", "httpMethod": "GET", "response": { "$ref": "Drive" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ] }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "DriveList" }, "parameters": { "pageToken": { "description": "Page token for shared drives.", "location": "query", "type": "string" }, "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.", "location": "query", "default": "false", "type": "boolean" }, "q": { "type": "string", "description": "Query string for searching shared drives.", "location": "query" }, "maxResults": { "minimum": "1", "format": "int32", "description": "Maximum number of shared drives to return per page.", "maximum": "100", "default": "10", "type": "integer", "location": "query" } }, "path": "drives", "flatPath": "drives", "parameterOrder": [], "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.", "id": "drive.drives.list" }, "hide": { "response": { "$ref": "Drive" }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "httpMethod": "POST", "id": "drive.drives.hide", "flatPath": "drives/{driveId}/hide", "parameterOrder": [ "driveId" ], "description": "Hides a shared drive from the default view.", "path": "drives/{driveId}/hide", "parameters": { "driveId": { "required": true, "description": "The ID of the shared drive.", "location": "path", "type": "string" } } }, "delete": { "httpMethod": "DELETE", "parameters": { "driveId": { "type": "string", "required": true, "description": "The ID of the shared drive.", "location": "path" }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", "location": "query", "type": "boolean", "default": "false" }, "allowItemDeletion": { "type": "boolean", "default": "false", "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", "location": "query" } }, "flatPath": "drives/{driveId}", "parameterOrder": [ "driveId" ], "description": "Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items.", "id": "drive.drives.delete", "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "drives/{driveId}" }, "insert": { "parameters": { "requestId": { "type": "string", "required": true, "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.", "location": "query" } }, "flatPath": "drives", "parameterOrder": [ "requestId" ], "description": "Creates a new shared drive.", "id": "drive.drives.insert", "path": "drives", "httpMethod": "POST", "request": { "$ref": "Drive" }, "response": { "$ref": "Drive" }, "scopes": [ "https://www.googleapis.com/auth/drive" ] } } }, "permissions": { "methods": { "delete": { "flatPath": "files/{fileId}/permissions/{permissionId}", "parameterOrder": [ "fileId", "permissionId" ], "description": "Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", "id": "drive.permissions.delete", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "parameters": { "enforceExpansiveAccess": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: All requests use the expansive access rules." }, "permissionId": { "type": "string", "description": "The ID for the permission.", "location": "path", "required": true }, "supportsAllDrives": { "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query" }, "fileId": { "required": true, "description": "The ID for the file or shared drive.", "location": "path", "type": "string" } } }, "insert": { "parameters": { "emailMessage": { "description": "A plain text custom message to include in notification emails.", "location": "query", "type": "string" }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query", "type": "boolean", "default": "false" }, "enforceSingleParent": { "description": "Deprecated: See `moveToNewOwnersRoot` for details.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "fileId": { "required": true, "description": "The ID for the file or shared drive.", "location": "path", "type": "string" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "enforceExpansiveAccess": { "description": "Deprecated: All requests use the expansive access rules.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "moveToNewOwnersRoot": { "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.", "location": "query", "default": "false", "type": "boolean" }, "sendNotificationEmails": { "type": "boolean", "default": "true", "description": "Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the `role` is `owner`.", "location": "query" } }, "flatPath": "files/{fileId}/permissions", "parameterOrder": [ "fileId" ], "description": "Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", "id": "drive.permissions.insert", "path": "files/{fileId}/permissions", "httpMethod": "POST", "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "getIdForEmail": { "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.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "PermissionId" }, "httpMethod": "GET", "path": "permissionIds/{email}", "id": "drive.permissions.getIdForEmail", "flatPath": "permissionIds/{email}", "parameterOrder": [ "email" ], "description": "Returns the permission ID for an email address.", "parameters": { "email": { "description": "The email address for which to return a permission ID", "location": "path", "required": true, "type": "string" } } }, "get": { "id": "drive.permissions.get", "flatPath": "files/{fileId}/permissions/{permissionId}", "parameterOrder": [ "fileId", "permissionId" ], "description": "Gets a permission by ID.", "path": "files/{fileId}/permissions/{permissionId}", "parameters": { "permissionId": { "type": "string", "description": "The ID for the permission.", "location": "path", "required": true }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "useDomainAdminAccess": { "default": "false", "type": "boolean", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query" }, "fileId": { "required": true, "description": "The ID for the file or shared drive.", "location": "path", "type": "string" } }, "response": { "$ref": "Permission" }, "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" ], "httpMethod": "GET" }, "list": { "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "PermissionList" }, "httpMethod": "GET", "path": "files/{fileId}/permissions", "id": "drive.permissions.list", "flatPath": "files/{fileId}/permissions", "parameterOrder": [ "fileId" ], "description": "Lists a file's or shared drive's permissions.", "parameters": { "fileId": { "required": true, "description": "The ID for the file or shared drive.", "location": "path", "type": "string" }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query", "default": "false", "type": "boolean" }, "maxResults": { "minimum": "1", "format": "int32", "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.", "maximum": "100", "type": "integer", "location": "query" }, "supportsAllDrives": { "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead.", "default": "false", "type": "boolean", "location": "query" }, "includePermissionsForView": { "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query" }, "pageToken": { "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.", "location": "query" } } }, "update": { "flatPath": "files/{fileId}/permissions/{permissionId}", "parameterOrder": [ "fileId", "permissionId" ], "description": "Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", "id": "drive.permissions.update", "path": "files/{fileId}/permissions/{permissionId}", "parameters": { "fileId": { "type": "string", "description": "The ID for the file or shared drive.", "location": "path", "required": true }, "removeExpiration": { "default": "false", "type": "boolean", "description": "Whether to remove the expiration date.", "location": "query" }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query", "type": "boolean", "default": "false" }, "permissionId": { "description": "The ID for the permission.", "location": "path", "required": true, "type": "string" }, "supportsAllDrives": { "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "enforceExpansiveAccess": { "description": "Deprecated: All requests use the expansive access rules.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "transferOwnership": { "type": "boolean", "default": "false", "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", "location": "query" } }, "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "httpMethod": "PUT" }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "parameters": { "permissionId": { "type": "string", "required": true, "description": "The ID for the permission.", "location": "path" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "enforceExpansiveAccess": { "location": "query", "default": "false", "type": "boolean", "description": "Deprecated: All requests use the expansive access rules.", "deprecated": true }, "transferOwnership": { "type": "boolean", "default": "false", "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", "location": "query" }, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", "required": true, "type": "string" }, "removeExpiration": { "default": "false", "type": "boolean", "description": "Whether to remove the expiration date.", "location": "query" }, "useDomainAdminAccess": { "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", "location": "query", "type": "boolean", "default": "false" } }, "path": "files/{fileId}/permissions/{permissionId}", "id": "drive.permissions.patch", "flatPath": "files/{fileId}/permissions/{permissionId}", "parameterOrder": [ "fileId", "permissionId" ], "description": "Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied." } } }, "replies": { "methods": { "patch": { "parameters": { "commentId": { "type": "string", "description": "The ID of the comment.", "location": "path", "required": true }, "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "replyId": { "type": "string", "description": "The ID of the reply.", "location": "path", "required": true } }, "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Updates an existing reply.", "id": "drive.replies.patch", "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PATCH", "request": { "$ref": "CommentReply" }, "response": { "$ref": "CommentReply" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "update": { "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Updates an existing reply.", "id": "drive.replies.update", "parameters": { "commentId": { "description": "The ID of the comment.", "location": "path", "required": true, "type": "string" }, "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "replyId": { "type": "string", "description": "The ID of the reply.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "CommentReply" }, "response": { "$ref": "CommentReply" }, "httpMethod": "PUT" }, "delete": { "parameters": { "commentId": { "required": true, "description": "The ID of the comment.", "location": "path", "type": "string" }, "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "replyId": { "type": "string", "required": true, "description": "The ID of the reply.", "location": "path" } }, "httpMethod": "DELETE", "id": "drive.replies.delete", "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Deletes a reply.", "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ] }, "insert": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "CommentReply" }, "response": { "$ref": "CommentReply" }, "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" }, "commentId": { "description": "The ID of the comment.", "location": "path", "required": true, "type": "string" } }, "path": "files/{fileId}/comments/{commentId}/replies", "flatPath": "files/{fileId}/comments/{commentId}/replies", "parameterOrder": [ "fileId", "commentId" ], "description": "Creates a new reply to the given comment.", "id": "drive.replies.insert" }, "get": { "parameters": { "fileId": { "required": true, "description": "The ID of the file.", "location": "path", "type": "string" }, "replyId": { "description": "The ID of the reply.", "location": "path", "required": true, "type": "string" }, "commentId": { "type": "string", "required": true, "description": "The ID of the comment.", "location": "path" }, "includeDeleted": { "description": "If set, this will succeed when retrieving a deleted reply.", "location": "query", "default": "false", "type": "boolean" } }, "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", "id": "drive.replies.get", "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "parameterOrder": [ "fileId", "commentId", "replyId" ], "description": "Gets a reply.", "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" ], "response": { "$ref": "CommentReply" } }, "list": { "id": "drive.replies.list", "flatPath": "files/{fileId}/comments/{commentId}/replies", "parameterOrder": [ "fileId", "commentId" ], "description": "Lists all of the replies to a comment.", "path": "files/{fileId}/comments/{commentId}/replies", "parameters": { "commentId": { "required": true, "description": "The ID of the comment.", "location": "path", "type": "string" }, "includeDeleted": { "type": "boolean", "default": "false", "description": "If set, all replies, including deleted replies (with content stripped) will be returned.", "location": "query" }, "pageToken": { "type": "string", "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.", "location": "query" }, "maxResults": { "location": "query", "type": "integer", "default": "20", "description": "The maximum number of replies to include in the response, used for paging.", "maximum": "100", "minimum": "0", "format": "int32" }, "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" } }, "response": { "$ref": "CommentReplyList" }, "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" ], "httpMethod": "GET" } } }, "parents": { "methods": { "delete": { "httpMethod": "DELETE", "parameters": { "enforceSingleParent": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root." }, "parentId": { "description": "The ID of the parent.", "location": "path", "required": true, "type": "string" }, "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true } }, "flatPath": "files/{fileId}/parents/{parentId}", "parameterOrder": [ "fileId", "parentId" ], "description": "Removes a parent from a file.", "id": "drive.parents.delete", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/parents/{parentId}" }, "insert": { "httpMethod": "POST", "request": { "$ref": "ParentReference" }, "response": { "$ref": "ParentReference" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "parameters": { "enforceSingleParent": { "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." } }, "flatPath": "files/{fileId}/parents", "parameterOrder": [ "fileId" ], "description": "Adds a parent folder for a file.", "id": "drive.parents.insert", "path": "files/{fileId}/parents" }, "get": { "parameters": { "parentId": { "type": "string", "description": "The ID of the parent.", "location": "path", "required": true }, "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" } }, "flatPath": "files/{fileId}/parents/{parentId}", "parameterOrder": [ "fileId", "parentId" ], "description": "Gets a specific parent reference.", "id": "drive.parents.get", "path": "files/{fileId}/parents/{parentId}", "httpMethod": "GET", "response": { "$ref": "ParentReference" }, "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" ] }, "list": { "httpMethod": "GET", "response": { "$ref": "ParentList" }, "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" ], "parameters": { "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true } }, "id": "drive.parents.list", "flatPath": "files/{fileId}/parents", "parameterOrder": [ "fileId" ], "description": "Lists a file's parents.", "path": "files/{fileId}/parents" } } }, "channels": { "methods": { "stop": { "id": "drive.channels.stop", "flatPath": "channels/stop", "parameterOrder": [], "description": "Stops watching resources through this channel.", "path": "channels/stop", "parameters": {}, "request": { "$ref": "Channel", "parameterName": "resource" }, "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.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" ], "httpMethod": "POST" } } }, "comments": { "methods": { "delete": { "httpMethod": "DELETE", "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "commentId": { "type": "string", "description": "The ID of the comment.", "location": "path", "required": true } }, "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "description": "Deletes a comment.", "id": "drive.comments.delete", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "path": "files/{fileId}/comments/{commentId}" }, "insert": { "httpMethod": "POST", "request": { "$ref": "Comment" }, "response": { "$ref": "Comment" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" } }, "flatPath": "files/{fileId}/comments", "parameterOrder": [ "fileId" ], "description": "Creates a new comment on the given file.", "id": "drive.comments.insert", "path": "files/{fileId}/comments" }, "get": { "httpMethod": "GET", "response": { "$ref": "Comment" }, "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" ], "parameters": { "includeDeleted": { "type": "boolean", "default": "false", "description": "If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.", "location": "query" }, "commentId": { "type": "string", "description": "The ID of the comment.", "location": "path", "required": true }, "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" } }, "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "description": "Gets a comment by ID.", "id": "drive.comments.get", "path": "files/{fileId}/comments/{commentId}" }, "list": { "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" ], "response": { "$ref": "CommentList" }, "parameters": { "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "updatedMin": { "description": "Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.", "location": "query", "type": "string" }, "maxResults": { "default": "20", "type": "integer", "location": "query", "minimum": "0", "format": "int32", "description": "The maximum number of discussions to include in the response, used for paging.", "maximum": "100" }, "includeDeleted": { "description": "If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.", "location": "query", "default": "false", "type": "boolean" }, "pageToken": { "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.", "location": "query", "type": "string" } }, "path": "files/{fileId}/comments", "flatPath": "files/{fileId}/comments", "parameterOrder": [ "fileId" ], "description": "Lists a file's comments.", "id": "drive.comments.list" }, "update": { "path": "files/{fileId}/comments/{commentId}", "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "description": "Updates an existing comment.", "id": "drive.comments.update", "parameters": { "commentId": { "type": "string", "required": true, "description": "The ID of the comment.", "location": "path" }, "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "Comment" }, "response": { "$ref": "Comment" }, "httpMethod": "PUT" }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "Comment" }, "response": { "$ref": "Comment" }, "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" }, "commentId": { "required": true, "description": "The ID of the comment.", "location": "path", "type": "string" } }, "path": "files/{fileId}/comments/{commentId}", "flatPath": "files/{fileId}/comments/{commentId}", "parameterOrder": [ "fileId", "commentId" ], "description": "Updates an existing comment.", "id": "drive.comments.patch" } } }, "files": { "methods": { "emptyTrash": { "httpMethod": "DELETE", "parameters": { "driveId": { "type": "string", "description": "If set, empties the trash of the provided shared drive.", "location": "query" }, "enforceSingleParent": { "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item is placed under its owner's root.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "path": "files/trash", "flatPath": "files/trash", "parameterOrder": [], "description": "Permanently deletes all of the user's trashed files.", "id": "drive.files.emptyTrash" }, "export": { "supportsMediaDownload": true, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "useMediaDownloadService": true, "httpMethod": "GET", "id": "drive.files.export", "flatPath": "files/{fileId}/export", "parameterOrder": [ "fileId", "mimeType" ], "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", "path": "files/{fileId}/export", "parameters": { "mimeType": { "required": true, "description": "Required. The MIME type of the format requested for this export.", "location": "query", "type": "string" }, "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" } } }, "generateIds": { "id": "drive.files.generateIds", "flatPath": "files/generateIds", "parameterOrder": [], "description": "Generates a set of file IDs which can be provided in insert or copy requests.", "path": "files/generateIds", "parameters": { "space": { "type": "string", "default": "drive", "description": "The space in which the IDs can be used to create new files. Supported values are `drive` and `appDataFolder`. (Default: `drive`)", "location": "query" }, "type": { "description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`)", "location": "query", "type": "string", "default": "files" }, "maxResults": { "description": "Maximum number of IDs to return.", "maximum": "1000", "minimum": "1", "format": "int32", "location": "query", "type": "integer", "default": "10" } }, "response": { "$ref": "GeneratedIds" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "httpMethod": "GET" }, "listLabels": { "parameters": { "pageToken": { "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.", "location": "query" }, "fileId": { "type": "string", "description": "The ID for the file.", "location": "path", "required": true }, "maxResults": { "location": "query", "default": "100", "type": "integer", "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "maximum": "100", "minimum": "1", "format": "int32" } }, "flatPath": "files/{fileId}/listLabels", "parameterOrder": [ "fileId" ], "description": "Lists the labels on a file.", "id": "drive.files.listLabels", "path": "files/{fileId}/listLabels", "httpMethod": "GET", "response": { "$ref": "LabelList" }, "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" ] }, "untrash": { "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID of the file to untrash.", "location": "path" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "supportsAllDrives": { "default": "false", "type": "boolean", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead.", "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" } }, "id": "drive.files.untrash", "flatPath": "files/{fileId}/untrash", "parameterOrder": [ "fileId" ], "description": "Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.", "path": "files/{fileId}/untrash", "httpMethod": "POST", "response": { "$ref": "File" }, "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" ] }, "modifyLabels": { "parameters": { "fileId": { "type": "string", "description": "The ID of the file to which the labels belong.", "location": "path", "required": true } }, "flatPath": "files/{fileId}/modifyLabels", "parameterOrder": [ "fileId" ], "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", "id": "drive.files.modifyLabels", "path": "files/{fileId}/modifyLabels", "httpMethod": "POST", "request": { "$ref": "ModifyLabelsRequest" }, "response": { "$ref": "ModifyLabelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata" ] }, "list": { "parameters": { "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "includeItemsFromAllDrives": { "description": "Whether both My Drive and shared drive items should be included in results.", "location": "query", "type": "boolean", "default": "false" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "projection": { "description": "Deprecated: This parameter has no function.", "deprecated": true, "enum": [ "BASIC", "FULL" ], "location": "query", "type": "string", "enumDescriptions": [ "Deprecated.", "Deprecated." ] }, "corpus": { "location": "query", "enumDescriptions": [ "The items that the user has accessed.", "Items shared to the user's domain." ], "type": "string", "description": "Deprecated: The body of items (files/documents) to which the query applies. Use `corpora` instead.", "enum": [ "DEFAULT", "DOMAIN" ], "deprecated": true }, "driveId": { "description": "ID of the shared drive to search.", "location": "query", "type": "string" }, "spaces": { "type": "string", "description": "A comma-separated list of spaces to query. Supported values are `drive`, and `appDataFolder`.", "location": "query" }, "includeTeamDriveItems": { "location": "query", "default": "false", "type": "boolean", "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "deprecated": true }, "teamDriveId": { "description": "Deprecated: Use `driveId` instead.", "location": "query", "deprecated": true, "type": "string" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "corpora": { "type": "string", "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency.", "location": "query" }, "pageToken": { "type": "string", "description": "Page token for files.", "location": "query" }, "orderBy": { "description": "A comma-separated list of sort keys. Valid keys are: * `createdDate`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `lastViewedByMeDate`: The last time the file was viewed by the user. * `modifiedByMeDate`: The last time the file was modified by the user. * `modifiedDate`: The last time the file was modified by anyone. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeDate`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `title`: The title of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `title_natural`: The title of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedDate desc,title`. Note that there's a current limitation for users with approximately one million files in which the requested sort order is ignored.", "location": "query", "type": "string" }, "q": { "type": "string", "description": "Query string for searching files.", "location": "query" }, "maxResults": { "type": "integer", "default": "100", "location": "query", "minimum": "0", "format": "int32", "description": "The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached." }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" } }, "path": "files", "flatPath": "files", "parameterOrder": [], "description": " Lists the user's files. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "id": "drive.files.list", "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.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "FileList" } }, "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" ], "supportsSubscription": true, "request": { "parameterName": "resource", "$ref": "Channel" }, "response": { "$ref": "Channel" }, "parameters": { "projection": { "description": "Deprecated: This parameter has no function.", "enum": [ "BASIC", "FULL" ], "deprecated": true, "location": "query", "enumDescriptions": [ "Deprecated.", "Deprecated." ], "type": "string" }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "revisionId": { "type": "string", "description": "Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.", "location": "query" }, "updateViewedDate": { "location": "query", "type": "boolean", "default": "false", "description": "Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.", "deprecated": true }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "location": "query", "type": "boolean", "default": "false", "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true }, "acknowledgeAbuse": { "type": "boolean", "default": "false", "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query" }, "fileId": { "type": "string", "required": true, "description": "The ID for the file in question.", "location": "path" } }, "path": "files/{fileId}/watch", "flatPath": "files/{fileId}/watch", "parameterOrder": [ "fileId" ], "description": "Subscribes to changes to a file.", "id": "drive.files.watch" }, "generateCseToken": { "id": "drive.files.generateCseToken", "flatPath": "files/generateCseToken", "parameterOrder": [], "description": "Generates a CSE token which can be used to create or update CSE files.", "path": "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.", "location": "query", "type": "string" }, "fileId": { "type": "string", "description": "The ID of the file for which the JWT should be generated. If not provided, an id will be generated.", "location": "query" } }, "response": { "$ref": "GenerateCseTokenResponse" }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "httpMethod": "GET" }, "update": { "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.scripts" ], "request": { "$ref": "File" }, "response": { "$ref": "File" }, "mediaUpload": { "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/drive/v2/files/{fileId}" }, "simple": { "multipart": true, "path": "/upload/drive/v2/files/{fileId}" } }, "accept": [ "*/*" ] }, "httpMethod": "PUT", "path": "files/{fileId}", "id": "drive.files.update", "flatPath": "files/{fileId}", "parameterOrder": [ "fileId" ], "supportsMediaUpload": true, "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).", "parameters": { "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "updateViewedDate": { "type": "boolean", "default": "true", "description": "Whether to update the view date after successfully updating the file.", "location": "query" }, "removeParents": { "description": "Comma-separated list of parent IDs to remove.", "location": "query", "type": "string" }, "pinned": { "default": "false", "type": "boolean", "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.", "location": "query" }, "addParents": { "description": "Comma-separated list of parent IDs to add.", "location": "query", "type": "string" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "default": "false", "type": "boolean" }, "convert": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: This parameter has no function." }, "enforceSingleParent": { "deprecated": true, "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "type": "boolean", "default": "false", "location": "query" }, "modifiedDateBehavior": { "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.", "enum": [ "fromBody", "fromBodyIfNeeded", "fromBodyOrNow", "noChange", "now", "nowIfNeeded" ], "location": "query", "enumDescriptions": [ "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", "Maintain the previous value of `modifiedDate`.", "Set `modifiedDate` to the current time.", "Set `modifiedDate` to the current time depending on contents of the update." ], "type": "string" }, "ocrLanguage": { "type": "string", "description": "If ocr is true, hints at the language to use. Valid values are BCP 47 codes.", "location": "query" }, "timedTextTrackName": { "type": "string", "description": "The timed text track name.", "location": "query" }, "useContentAsIndexableText": { "default": "false", "type": "boolean", "description": "Whether to use the content as indexable text.", "location": "query" }, "setModifiedDate": { "default": "false", "type": "boolean", "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", "location": "query" }, "includePermissionsForView": { "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query" }, "timedTextLanguage": { "type": "string", "description": "The language of the timed text.", "location": "query" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "newRevision": { "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045).", "location": "query", "default": "true", "type": "boolean" }, "ocr": { "default": "false", "type": "boolean", "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.", "location": "query" }, "fileId": { "required": true, "description": "The ID of the file to update.", "location": "path", "type": "string" } } }, "copy": { "parameters": { "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "timedTextTrackName": { "description": "The timed text track name.", "location": "query", "type": "string" }, "visibility": { "description": "The visibility of the new file. Permissions are still inherited from parent folders. This parameter is only relevant when the source is not a Google Doc file and when `convert=false`.", "enum": [ "DEFAULT", "PRIVATE" ], "location": "query", "type": "string", "default": "DEFAULT", "enumDescriptions": [ "The visibility of the new file is determined by the user's default visibility or sharing policies.", "The user's default visibility or sharing policies are ignored, and the new file is only visible to the owner and any users with permissions inherited from the parent folder." ] }, "timedTextLanguage": { "description": "The language of the timed text.", "location": "query", "type": "string" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "fileId": { "type": "string", "description": "The ID of the file to copy.", "location": "path", "required": true }, "ocr": { "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.", "location": "query", "default": "false", "type": "boolean" }, "includeLabels": { "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "pinned": { "type": "boolean", "default": "false", "description": "Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.", "location": "query" }, "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "ocrLanguage": { "description": "If `ocr` is true, hints at the language to use. Valid values are BCP 47 codes.", "location": "query", "type": "string" }, "enforceSingleParent": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead." }, "convert": { "description": "Whether to convert this file to the corresponding Docs Editors format.", "location": "query", "type": "boolean", "default": "false" } }, "flatPath": "files/{fileId}/copy", "parameterOrder": [ "fileId" ], "description": "Creates a copy of the specified file.", "id": "drive.files.copy", "path": "files/{fileId}/copy", "httpMethod": "POST", "request": { "$ref": "File" }, "response": { "$ref": "File" }, "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.photos.readonly" ] }, "patch": { "parameters": { "timedTextLanguage": { "description": "The language of the timed text.", "location": "query", "type": "string" }, "setModifiedDate": { "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", "location": "query", "type": "boolean", "default": "false" }, "includePermissionsForView": { "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query" }, "timedTextTrackName": { "description": "The timed text track name.", "location": "query", "type": "string" }, "useContentAsIndexableText": { "description": "Whether to use the content as indexable text.", "location": "query", "default": "false", "type": "boolean" }, "fileId": { "type": "string", "description": "The ID of the file to update.", "location": "path", "required": true }, "ocr": { "default": "false", "type": "boolean", "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.", "location": "query" }, "newRevision": { "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there is no payload in the request.", "location": "query", "default": "true", "type": "boolean" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "default": "false", "type": "boolean" }, "pinned": { "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.", "location": "query", "default": "false", "type": "boolean" }, "removeParents": { "type": "string", "description": "Comma-separated list of parent IDs to remove.", "location": "query" }, "updateViewedDate": { "description": "Whether to update the view date after successfully updating the file.", "location": "query", "type": "boolean", "default": "true" }, "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "ocrLanguage": { "description": "If ocr is true, hints at the language to use. Valid values are BCP 47 codes.", "location": "query", "type": "string" }, "enforceSingleParent": { "deprecated": true, "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "default": "false", "type": "boolean", "location": "query" }, "modifiedDateBehavior": { "type": "string", "enumDescriptions": [ "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", "Maintain the previous value of `modifiedDate`.", "Set `modifiedDate` to the current time.", "Set `modifiedDate` to the current time depending on contents of the update." ], "location": "query", "enum": [ "fromBody", "fromBodyIfNeeded", "fromBodyOrNow", "noChange", "now", "nowIfNeeded" ], "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`." }, "convert": { "deprecated": true, "description": "Deprecated: This parameter has no function.", "type": "boolean", "default": "false", "location": "query" }, "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "addParents": { "description": "Comma-separated list of parent IDs to add.", "location": "query", "type": "string" } }, "id": "drive.files.patch", "flatPath": "files/{fileId}", "parameterOrder": [ "fileId" ], "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", "path": "files/{fileId}", "httpMethod": "PATCH", "request": { "$ref": "File" }, "response": { "$ref": "File" }, "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.scripts" ] }, "insert": { "id": "drive.files.insert", "flatPath": "files", "parameterOrder": [], "supportsMediaUpload": true, "description": " Inserts a new 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:*`*/*` Note: 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 on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"title\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` 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 title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "path": "files", "parameters": { "ocrLanguage": { "description": "If ocr is true, hints at the language to use. Valid values are BCP 47 codes.", "location": "query", "type": "string" }, "enforceSingleParent": { "location": "query", "default": "false", "type": "boolean", "description": "Deprecated: Creating files in multiple folders is no longer supported.", "deprecated": true }, "convert": { "description": "Whether to convert this file to the corresponding Docs Editors format.", "location": "query", "default": "false", "type": "boolean" }, "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "pinned": { "description": "Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.", "location": "query", "type": "boolean", "default": "false" }, "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "ocr": { "type": "boolean", "default": "false", "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.", "location": "query" }, "supportsTeamDrives": { "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead.", "type": "boolean", "default": "false", "location": "query" }, "visibility": { "default": "DEFAULT", "enumDescriptions": [ "The visibility of the new file is determined by the user's default visibility or sharing policies.", "The user's default visibility or sharing policies are ignored, and the new file is only visible to the owner and any users with permissions inherited from the parent folder." ], "type": "string", "location": "query", "enum": [ "DEFAULT", "PRIVATE" ], "description": "The visibility of the new file. Permissions are still inherited from parent folders. This parameter is only relevant when `convert=false`." }, "timedTextLanguage": { "description": "The language of the timed text.", "location": "query", "type": "string" }, "includePermissionsForView": { "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query" }, "timedTextTrackName": { "type": "string", "description": "The timed text track name.", "location": "query" }, "useContentAsIndexableText": { "default": "false", "type": "boolean", "description": "Whether to use the content as indexable text.", "location": "query" } }, "request": { "$ref": "File" }, "response": { "$ref": "File" }, "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" ], "httpMethod": "POST", "mediaUpload": { "accept": [ "*/*" ], "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/drive/v2/files" }, "simple": { "multipart": true, "path": "/upload/drive/v2/files" } }, "maxSize": "5497558138880" } }, "get": { "id": "drive.files.get", "flatPath": "files/{fileId}", "parameterOrder": [ "fileId" ], "description": " Gets a file's metadata or content by ID. 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/v2/files/export) instead. For more information, see [Download & export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads).", "path": "files/{fileId}", "parameters": { "projection": { "location": "query", "type": "string", "enumDescriptions": [ "Deprecated.", "Deprecated." ], "description": "Deprecated: This parameter has no function.", "deprecated": true, "enum": [ "BASIC", "FULL" ] }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "revisionId": { "type": "string", "description": "Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.", "location": "query" }, "updateViewedDate": { "type": "boolean", "default": "false", "location": "query", "deprecated": true, "description": "Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body." }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "default": "false", "type": "boolean", "location": "query", "deprecated": true, "description": "Deprecated: Use `supportsAllDrives` instead." }, "acknowledgeAbuse": { "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "default": "false", "type": "boolean" }, "fileId": { "type": "string", "required": true, "description": "The ID for the file in question.", "location": "path" } }, "supportsSubscription": true, "supportsMediaDownload": true, "response": { "$ref": "File" }, "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" ], "useMediaDownloadService": true, "httpMethod": "GET" }, "touch": { "response": { "$ref": "File" }, "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" ], "httpMethod": "POST", "id": "drive.files.touch", "flatPath": "files/{fileId}/touch", "parameterOrder": [ "fileId" ], "description": "Set the file's updated time to the current server time.", "path": "files/{fileId}/touch", "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID of the file to update.", "location": "path" }, "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "location": "query", "default": "false", "type": "boolean", "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" } } }, "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}", "flatPath": "files/{fileId}", "parameterOrder": [ "fileId" ], "description": "Permanently deletes a file owned by the user without moving it to the trash. 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.", "id": "drive.files.delete", "httpMethod": "DELETE", "parameters": { "supportsAllDrives": { "type": "boolean", "default": "false", "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query" }, "supportsTeamDrives": { "location": "query", "type": "boolean", "default": "false", "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true }, "fileId": { "type": "string", "required": true, "description": "The ID of the file to delete.", "location": "path" }, "enforceSingleParent": { "deprecated": true, "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item is placed under its owner's root.", "type": "boolean", "default": "false", "location": "query" } } }, "trash": { "httpMethod": "POST", "response": { "$ref": "File" }, "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" ], "parameters": { "includeLabels": { "type": "string", "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query" }, "supportsAllDrives": { "description": "Whether the requesting application supports both My Drives and shared drives.", "location": "query", "type": "boolean", "default": "false" }, "supportsTeamDrives": { "description": "Deprecated: Use `supportsAllDrives` instead.", "deprecated": true, "location": "query", "type": "boolean", "default": "false" }, "includePermissionsForView": { "type": "string", "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query" }, "fileId": { "type": "string", "description": "The ID of the file to trash.", "location": "path", "required": true } }, "flatPath": "files/{fileId}/trash", "parameterOrder": [ "fileId" ], "description": "Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.", "id": "drive.files.trash", "path": "files/{fileId}/trash" } } }, "properties": { "methods": { "update": { "request": { "$ref": "Property" }, "response": { "$ref": "Property" }, "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" ], "httpMethod": "PUT", "id": "drive.properties.update", "flatPath": "files/{fileId}/properties/{propertyKey}", "parameterOrder": [ "fileId", "propertyKey" ], "description": "Updates a property.", "path": "files/{fileId}/properties/{propertyKey}", "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" }, "propertyKey": { "type": "string", "description": "The key of the property.", "location": "path", "required": true }, "visibility": { "description": "The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)", "location": "query", "type": "string", "default": "private" } } }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "Property" }, "response": { "$ref": "Property" }, "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" ], "parameters": { "propertyKey": { "description": "The key of the property.", "location": "path", "required": true, "type": "string" }, "visibility": { "description": "The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)", "location": "query", "default": "private", "type": "string" }, "fileId": { "required": true, "description": "The ID of the file.", "location": "path", "type": "string" } }, "flatPath": "files/{fileId}/properties/{propertyKey}", "parameterOrder": [ "fileId", "propertyKey" ], "description": "Updates a property.", "id": "drive.properties.patch", "path": "files/{fileId}/properties/{propertyKey}" }, "delete": { "id": "drive.properties.delete", "flatPath": "files/{fileId}/properties/{propertyKey}", "parameterOrder": [ "fileId", "propertyKey" ], "description": "Deletes a property.", "path": "files/{fileId}/properties/{propertyKey}", "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" ], "parameters": { "propertyKey": { "description": "The key of the property.", "location": "path", "required": true, "type": "string" }, "visibility": { "description": "The visibility of the property.", "location": "query", "default": "private", "type": "string" }, "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" } }, "httpMethod": "DELETE" }, "insert": { "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" ], "request": { "$ref": "Property" }, "response": { "$ref": "Property" }, "httpMethod": "POST", "path": "files/{fileId}/properties", "flatPath": "files/{fileId}/properties", "parameterOrder": [ "fileId" ], "description": "Adds a property to a file, or updates it if it already exists.", "id": "drive.properties.insert", "parameters": { "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true } } }, "get": { "flatPath": "files/{fileId}/properties/{propertyKey}", "parameterOrder": [ "fileId", "propertyKey" ], "description": "Gets a property by its key.", "id": "drive.properties.get", "path": "files/{fileId}/properties/{propertyKey}", "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID of the file.", "location": "path" }, "propertyKey": { "required": true, "description": "The key of the property.", "location": "path", "type": "string" }, "visibility": { "description": "The visibility of the property.", "location": "query", "type": "string", "default": "private" } }, "response": { "$ref": "Property" }, "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" ], "httpMethod": "GET" }, "list": { "path": "files/{fileId}/properties", "flatPath": "files/{fileId}/properties", "parameterOrder": [ "fileId" ], "description": "Lists a file's properties.", "id": "drive.properties.list", "parameters": { "fileId": { "description": "The ID of the file.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "PropertyList" }, "httpMethod": "GET" } } }, "revisions": { "methods": { "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}/revisions/{revisionId}", "flatPath": "files/{fileId}/revisions/{revisionId}", "parameterOrder": [ "fileId", "revisionId" ], "description": "Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", "id": "drive.revisions.delete", "httpMethod": "DELETE", "parameters": { "fileId": { "type": "string", "description": "The ID of the file.", "location": "path", "required": true }, "revisionId": { "type": "string", "description": "The ID of the revision.", "location": "path", "required": true } } }, "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" ], "response": { "$ref": "Revision" }, "httpMethod": "GET", "path": "files/{fileId}/revisions/{revisionId}", "id": "drive.revisions.get", "flatPath": "files/{fileId}/revisions/{revisionId}", "parameterOrder": [ "fileId", "revisionId" ], "description": "Gets a specific revision.", "parameters": { "revisionId": { "required": true, "description": "The ID of the revision.", "location": "path", "type": "string" }, "fileId": { "required": true, "description": "The ID of the file.", "location": "path", "type": "string" } } }, "list": { "response": { "$ref": "RevisionList" }, "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" ], "httpMethod": "GET", "flatPath": "files/{fileId}/revisions", "parameterOrder": [ "fileId" ], "description": "Lists a file's 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.", "id": "drive.revisions.list", "path": "files/{fileId}/revisions", "parameters": { "fileId": { "required": true, "description": "The ID of the file.", "location": "path", "type": "string" }, "maxResults": { "description": "Maximum number of revisions to return.", "maximum": "1000", "minimum": "1", "format": "int32", "location": "query", "type": "integer", "default": "200" }, "pageToken": { "type": "string", "description": "Page token for revisions. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.", "location": "query" } } }, "update": { "path": "files/{fileId}/revisions/{revisionId}", "id": "drive.revisions.update", "flatPath": "files/{fileId}/revisions/{revisionId}", "parameterOrder": [ "fileId", "revisionId" ], "description": "Updates a revision.", "parameters": { "fileId": { "required": true, "description": "The ID for the file.", "location": "path", "type": "string" }, "revisionId": { "type": "string", "description": "The ID for the revision.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "request": { "$ref": "Revision" }, "response": { "$ref": "Revision" }, "httpMethod": "PUT" }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "Revision" }, "response": { "$ref": "Revision" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], "parameters": { "fileId": { "type": "string", "required": true, "description": "The ID for the file.", "location": "path" }, "revisionId": { "type": "string", "description": "The ID for the revision.", "location": "path", "required": true } }, "id": "drive.revisions.patch", "flatPath": "files/{fileId}/revisions/{revisionId}", "parameterOrder": [ "fileId", "revisionId" ], "description": "Updates a revision.", "path": "files/{fileId}/revisions/{revisionId}" } } }, "teamdrives": { "methods": { "update": { "request": { "$ref": "TeamDrive" }, "response": { "$ref": "TeamDrive" }, "scopes": [ "https://www.googleapis.com/auth/drive" ], "httpMethod": "PUT", "flatPath": "teamdrives/{teamDriveId}", "parameterOrder": [ "teamDriveId" ], "description": "Deprecated: Use `drives.update` instead.", "id": "drive.teamdrives.update", "path": "teamdrives/{teamDriveId}", "parameters": { "teamDriveId": { "type": "string", "required": true, "description": "The ID of the Team Drive", "location": "path" }, "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.", "location": "query", "type": "boolean", "default": "false" } } }, "get": { "flatPath": "teamdrives/{teamDriveId}", "parameterOrder": [ "teamDriveId" ], "description": "Deprecated: Use `drives.get` instead.", "id": "drive.teamdrives.get", "path": "teamdrives/{teamDriveId}", "parameters": { "teamDriveId": { "required": true, "description": "The ID of the Team Drive", "location": "path", "type": "string" }, "useDomainAdminAccess": { "type": "boolean", "default": "false", "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.", "location": "query" } }, "response": { "$ref": "TeamDrive" }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "httpMethod": "GET" }, "list": { "path": "teamdrives", "id": "drive.teamdrives.list", "flatPath": "teamdrives", "parameterOrder": [], "description": "Deprecated: Use `drives.list` instead.", "parameters": { "maxResults": { "minimum": "1", "format": "int32", "description": "Maximum number of Team Drives to return.", "maximum": "100", "default": "10", "type": "integer", "location": "query" }, "q": { "type": "string", "description": "Query string for searching Team Drives.", "location": "query" }, "pageToken": { "type": "string", "description": "Page token for Team Drives.", "location": "query" }, "useDomainAdminAccess": { "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.", "location": "query", "default": "false", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.readonly" ], "response": { "$ref": "TeamDriveList" }, "httpMethod": "GET" }, "delete": { "path": "teamdrives/{teamDriveId}", "scopes": [ "https://www.googleapis.com/auth/drive" ], "id": "drive.teamdrives.delete", "flatPath": "teamdrives/{teamDriveId}", "parameterOrder": [ "teamDriveId" ], "description": "Deprecated: Use `drives.delete` instead.", "parameters": { "teamDriveId": { "description": "The ID of the Team Drive", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE" }, "insert": { "scopes": [ "https://www.googleapis.com/auth/drive" ], "request": { "$ref": "TeamDrive" }, "response": { "$ref": "TeamDrive" }, "httpMethod": "POST", "path": "teamdrives", "flatPath": "teamdrives", "parameterOrder": [ "requestId" ], "description": "Deprecated: Use `drives.insert` instead.", "id": "drive.teamdrives.insert", "parameters": { "requestId": { "type": "string", "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", "location": "query", "required": true } } } } } }, "servicePath": "drive/v2/", "kind": "discovery#restDescription", "mtlsRootUrl": "https://www.mtls.googleapis.com/", "ownerDomain": "google.com", "name": "drive", "parameters": { "callback": { "type": "string", "description": "JSONP", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true", "type": "boolean" }, "$.xgafv": { "location": "query", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "quotaUser": { "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.", "location": "query" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "location": "query", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "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.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" } }, "schemas": { "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.", "id": "File", "type": "object", "properties": { "headRevisionId": { "description": "Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "copyable": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `capabilities/canCopy` instead." }, "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), 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" }, "selfLink": { "description": "Output only. A link back to this file.", "type": "string" }, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" }, "ownedByMe": { "description": "Output only. Whether the file is owned by the current user. Not populated for items in shared drives.", "type": "boolean" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "type": "array", "items": { "$ref": "ContentRestriction" } }, "imageMediaMetadata": { "type": "object", "properties": { "date": { "description": "Output only. The date and time the photo was taken (EXIF format timestamp).", "type": "string" }, "isoSpeed": { "description": "Output only. The ISO speed used to create the photo.", "type": "integer", "format": "int32" }, "exposureBias": { "type": "number", "format": "float", "description": "Output only. The exposure bias of the photo (APEX value)." }, "meteringMode": { "description": "Output only. The metering mode used to create the photo.", "type": "string" }, "height": { "type": "integer", "format": "int32", "description": "Output only. The height of the image in pixels." }, "location": { "description": "Output only. Geographic location information stored in the image.", "type": "object", "properties": { "altitude": { "type": "number", "format": "double", "description": "Output only. The altitude stored in the image." }, "latitude": { "description": "Output only. The latitude stored in the image.", "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double", "description": "Output only. The longitude stored in the image." } } }, "aperture": { "type": "number", "format": "float", "description": "Output only. The aperture used to create the photo (f-number)." }, "subjectDistance": { "description": "Output only. The distance to the subject of the photo, in meters.", "type": "integer", "format": "int32" }, "colorSpace": { "description": "Output only. The color space of the photo.", "type": "string" }, "whiteBalance": { "description": "Output only. The white balance mode used to create the photo.", "type": "string" }, "focalLength": { "description": "Output only. The focal length used to create the photo, in millimeters.", "type": "number", "format": "float" }, "sensor": { "description": "Output only. The type of sensor used to create the photo.", "type": "string" }, "rotation": { "type": "integer", "format": "int32", "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation." }, "cameraMake": { "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "width": { "type": "integer", "format": "int32", "description": "Output only. The width of the image in pixels." }, "maxApertureValue": { "type": "number", "format": "float", "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value)." }, "lens": { "description": "Output only. The lens used to create the photo.", "type": "string" }, "cameraModel": { "description": "Output only. The model of the camera used to create the photo.", "type": "string" }, "exposureTime": { "description": "Output only. The length of the exposure, in seconds.", "type": "number", "format": "float" }, "flashUsed": { "description": "Output only. Whether a flash was used to create the photo.", "type": "boolean" }, "exposureMode": { "description": "Output only. The exposure mode used to create the photo.", "type": "string" } }, "description": "Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content." }, "webViewLink": { "description": "Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.", "type": "string" }, "lastModifyingUser": { "description": "Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user.", "$ref": "User" }, "properties": { "items": { "$ref": "Property" }, "type": "array", "description": "The list of properties." }, "createdDate": { "type": "string", "format": "date-time", "description": "Create time for this file (formatted RFC 3339 timestamp)." }, "modifiedDate": { "type": "string", "format": "date-time", "description": "Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set." }, "markedViewedByMeDate": { "description": "Deprecated.", "type": "string", "format": "date-time" }, "ownerNames": { "description": "Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.", "type": "array", "items": { "type": "string" } }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", "type": "boolean" }, "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." }, "userPermission": { "description": "Output only. The permissions for the authenticated user on this file.", "$ref": "Permission" }, "writersCanShare": { "description": "Whether writers can share the document with other users. Not populated for items in shared drives.", "type": "boolean" }, "fileExtension": { "description": "Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "folderColorRgb": { "description": "Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.", "type": "string" }, "fileSize": { "type": "string", "format": "int64", "description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders." }, "sha256Checksum": { "description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "hasThumbnail": { "description": "Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "embedLink": { "description": "Output only. A link for embedding the file.", "type": "string" }, "canComment": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `capabilities/canComment` instead." }, "trashedDate": { "description": "The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.", "type": "string", "format": "date-time" }, "clientEncryptionDetails": { "$ref": "ClientEncryptionDetails", "description": "Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts." }, "shareable": { "description": "Output only. Deprecated: Use `capabilities/canShare` instead.", "deprecated": true, "type": "boolean" }, "hasAugmentedPermissions": { "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "kind": { "default": "drive#file", "type": "string", "description": "Output only. The type of file. This is always `drive#file`." }, "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.", "type": "object", "properties": { "canModifyContentRestriction": { "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.", "deprecated": true, "type": "boolean" }, "canModifyEditorContentRestriction": { "description": "Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.", "type": "boolean" }, "canMoveItemOutOfDrive": { "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", "type": "boolean" }, "canEdit": { "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, "canDelete": { "description": "Output only. Whether the current user can delete this file.", "type": "boolean" }, "canShare": { "description": "Output only. Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canReadDrive": { "description": "Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canDisableInheritedPermissions": { "description": "Output only. Whether a user can disable inherited permissions.", "readOnly": true, "type": "boolean" }, "canEnableInheritedPermissions": { "readOnly": true, "type": "boolean", "description": "Output only. Whether a user can re-enable inherited permissions." }, "canMoveChildrenOutOfDrive": { "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canAcceptOwnership": { "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "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" }, "canRename": { "description": "Output only. Whether the current user can rename this file.", "type": "boolean" }, "canAddChildren": { "description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead." }, "canModifyLabels": { "description": "Output only. Whether the current user can modify the labels on the file.", "type": "boolean" }, "canReadRevisions": { "description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", "type": "boolean" }, "canModifyOwnerContentRestriction": { "description": "Output only. Whether the current user can add or modify content restrictions which are owner restricted.", "type": "boolean" }, "canComment": { "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "description": "Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.", "deprecated": true, "type": "boolean" }, "canModifyContent": { "description": "Output only. Whether the current user can modify the content of this file.", "type": "boolean" }, "canAddMyDriveParent": { "description": "Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { "description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canReadTeamDrive": { "description": "Output only. Deprecated: Use `canReadDrive` instead.", "deprecated": true, "type": "boolean" }, "canMoveChildrenWithinDrive": { "description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `canMoveItemWithinDrive` instead." }, "canMoveItemOutOfTeamDrive": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `canMoveItemOutOfDrive` instead." }, "canUntrash": { "description": "Output only. Whether the current user can restore this file from trash.", "type": "boolean" }, "canMoveItemWithinDrive": { "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", "type": "boolean" }, "canRemoveChildren": { "description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canTrash": { "description": "Output only. Whether the current user can move this file to trash.", "type": "boolean" }, "canMoveTeamDriveItem": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead." }, "canTrashChildren": { "description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canCopy": { "description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead." }, "canReadLabels": { "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canChangeRestrictedDownload": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated." }, "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canRemoveContentRestriction": { "description": "Output only. Whether there is 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 is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { "description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" } } }, "mimeType": { "description": "The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.", "type": "string" }, "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" }, "driveId": { "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "openWithLinks": { "additionalProperties": { "type": "string" }, "description": "Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.", "type": "object" }, "alternateLink": { "description": "Output only. A link for opening the file in a relevant Google editor or viewer.", "type": "string" }, "sharedWithMeDate": { "type": "string", "format": "date-time", "description": "Time at which this file was shared with the user (formatted RFC 3339 timestamp)." }, "md5Checksum": { "description": "Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "appDataContents": { "description": "Output only. Whether this file is in the Application Data folder.", "type": "boolean" }, "title": { "description": "The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.", "type": "string" }, "permissionIds": { "description": "Output only. List of permission IDs for users with access to this file.", "type": "array", "items": { "type": "string" } }, "inheritedPermissionsDisabled": { "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", "type": "boolean" }, "indexableText": { "type": "object", "properties": { "text": { "description": "The text to be indexed for this file.", "type": "string" } }, "description": "Indexable text attributes for the file (can only be written)" }, "videoMediaMetadata": { "type": "object", "properties": { "width": { "description": "Output only. The width of the video in pixels.", "type": "integer", "format": "int32" }, "height": { "description": "Output only. The height of the video in pixels.", "type": "integer", "format": "int32" }, "durationMillis": { "description": "Output only. The duration of the video in milliseconds.", "type": "string", "format": "int64" } }, "description": "Output only. Metadata about video media. This will only be present for video types." }, "thumbnailVersion": { "description": "Output only. The thumbnail version for use in thumbnail cache invalidation.", "type": "string", "format": "int64" }, "sharingUser": { "$ref": "User", "description": "Output only. User that shared the item with the current user, if available." }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Output only. Deprecated: Use `driveId` instead." }, "lastModifyingUserName": { "description": "Output only. Name of the last user to modify this file.", "type": "string" }, "spaces": { "description": "Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.", "items": { "type": "string" }, "type": "array" }, "labels": { "description": "A group of labels for the file.", "type": "object", "properties": { "modified": { "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "trashed": { "description": "Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.", "type": "boolean" }, "starred": { "description": "Whether this file is starred by the user.", "type": "boolean" }, "viewed": { "description": "Whether this file has been viewed by this user.", "type": "boolean" }, "restricted": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `copyRequiresWriterPermission` instead." }, "hidden": { "description": "Output only. Deprecated.", "deprecated": true, "type": "boolean" } } }, "downloadUrl": { "description": "Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", "type": "string" }, "fullFileExtension": { "description": "Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as \"tar.gz\". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "permissions": { "items": { "$ref": "Permission" }, "type": "array", "description": "Output only. The list of permissions for users with access to this file. Not populated for items in shared drives." }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.", "type": "object", "properties": { "image": { "description": "The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.", "type": "string", "format": "byte" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } } }, "id": { "description": "The ID of the file.", "type": "string" }, "shortcutDetails": { "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests.", "type": "object", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to. Can only be set on `files.insert` requests.", "type": "string" }, "targetMimeType": { "description": "Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { "description": "Output only. The ResourceKey for the target file.", "type": "string" } } }, "parents": { "type": "array", "items": { "$ref": "ParentReference" }, "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 an insert 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." }, "version": { "type": "string", "format": "int64", "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 requesting user." }, "webContentLink": { "description": "Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.", "type": "string" }, "originalFilename": { "description": "The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.", "type": "string" }, "labelInfo": { "type": "object", "properties": { "labels": { "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.", "type": "array", "items": { "$ref": "Label" } } }, "description": "Output only. An overview of the labels on the file." }, "canReadRevisions": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `capabilities/canReadRevisions` instead." }, "defaultOpenWithLink": { "description": "Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.", "type": "string" }, "quotaBytesUsed": { "type": "string", "format": "int64", "description": "Output only. The number of quota bytes used by this file." }, "explicitlyTrashed": { "description": "Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.", "type": "boolean" }, "exportLinks": { "additionalProperties": { "type": "string" }, "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "description": { "description": "A short description of the file.", "type": "string" }, "lastViewedByMeDate": { "description": "Last time this file was viewed by the user (formatted RFC 3339 timestamp).", "type": "string", "format": "date-time" }, "editable": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `capabilities/canEdit` instead." }, "linkShareMetadata": { "type": "object", "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" } }, "description": "Contains details about the link URLs that clients are using to refer to this item." }, "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 is not populated for Docs Editors or shortcut files.", "type": "string" }, "shared": { "description": "Output only. Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "modifiedByMeDate": { "type": "string", "format": "date-time", "description": "Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date." }, "etag": { "description": "Output only. ETag of the file.", "type": "string" }, "iconLink": { "description": "Output only. A link to the file's icon.", "type": "string" }, "resourceKey": { "description": "Output only. A key needed to access the item via a shared link.", "type": "string" } } }, "PermissionList": { "description": "A list of permissions associated with a file.", "id": "PermissionList", "type": "object", "properties": { "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "description": "The list of permissions.", "type": "array", "items": { "$ref": "Permission" } }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "kind": { "description": "This is always `drive#permissionList`.", "type": "string", "default": "drive#permissionList" }, "nextPageToken": { "description": "The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", "type": "string" } } }, "DecryptionMetadata": { "id": "DecryptionMetadata", "description": "Representation of the CSE DecryptionMetadata.", "type": "object", "properties": { "wrappedKey": { "description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.", "type": "string" }, "jwt": { "description": "The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.", "type": "string" }, "kaclsName": { "description": "The name of the KACLS (Key ACL Service) used to encrypt the file.", "type": "string" }, "aes256GcmChunkSize": { "description": "Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ", "type": "string" }, "encryptionResourceKeyHash": { "description": "The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference", "type": "string" }, "kaclsId": { "description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", "type": "string", "format": "int64" }, "keyFormat": { "description": "Key format for the unwrapped key. Must be `tinkAesGcmKey`.", "type": "string" } } }, "About": { "type": "object", "properties": { "quotaBytesByService": { "description": "The amount of storage quota used by different Google services.", "type": "array", "items": { "type": "object", "properties": { "serviceName": { "description": "The service's name, e.g. DRIVE, GMAIL, or PHOTOS.", "type": "string" }, "bytesUsed": { "type": "string", "format": "int64", "description": "The storage quota bytes used by the service." } } } }, "quotaBytesUsedAggregate": { "type": "string", "format": "int64", "description": "The number of quota bytes used by all Google apps (Drive, Picasa, etc.)." }, "driveThemes": { "items": { "type": "object", "properties": { "colorRgb": { "description": "The color of this theme as an RGB hex string.", "type": "string" }, "backgroundImageLink": { "description": "A link to this theme's background image.", "type": "string" }, "id": { "description": "The ID of the theme.", "type": "string" } } }, "type": "array", "description": "A list of themes that are supported for shared drives." }, "quotaType": { "description": "The type of the user's storage quota. Possible values are: * `LIMITED` * `UNLIMITED`", "type": "string" }, "canCreateTeamDrives": { "deprecated": true, "type": "boolean", "description": "Deprecated: Use `canCreateDrives` instead." }, "additionalRoleInfo": { "description": "Information about supported additional roles per file type. The most specific type takes precedence.", "type": "array", "items": { "type": "object", "properties": { "roleSets": { "items": { "type": "object", "properties": { "primaryRole": { "description": "A primary permission role.", "type": "string" }, "additionalRoles": { "description": "The supported additional roles with the primary role.", "items": { "type": "string" }, "type": "array" } } }, "type": "array", "description": "The supported additional roles per primary role." }, "type": { "description": "The content type that this additional role info applies to.", "type": "string" } } } }, "quotaBytesUsed": { "description": "The number of quota bytes used by Google Drive.", "type": "string", "format": "int64" }, "features": { "items": { "type": "object", "properties": { "featureRate": { "type": "number", "format": "double", "description": "The request limit rate for this feature, in queries per second." }, "featureName": { "description": "The name of the feature.", "type": "string" } } }, "type": "array", "description": "List of additional features enabled on this account." }, "exportFormats": { "type": "array", "items": { "type": "object", "properties": { "targets": { "description": "The possible content types to convert to.", "type": "array", "items": { "type": "string" } }, "source": { "description": "The content type to convert from.", "type": "string" } } }, "description": "The allowable export formats." }, "largestChangeId": { "type": "string", "format": "int64", "description": "The largest change id." }, "etag": { "description": "The ETag of the item.", "type": "string" }, "kind": { "description": "This is always `drive#about`.", "default": "drive#about", "type": "string" }, "remainingChangeIds": { "description": "The number of remaining change ids, limited to no more than 2500.", "type": "string", "format": "int64" }, "name": { "description": "The name of the current user.", "type": "string" }, "teamDriveThemes": { "description": "Deprecated: Use `driveThemes` instead.", "items": { "type": "object", "properties": { "backgroundImageLink": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead." }, "colorRgb": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveThemes/colorRgb` instead." }, "id": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveThemes/id` instead." } } }, "deprecated": true, "type": "array" }, "quotaBytesUsedInTrash": { "type": "string", "format": "int64", "description": "The number of quota bytes used by trashed items." }, "folderColorPalette": { "type": "array", "items": { "type": "string" }, "description": "The palette of allowable folder colors as RGB hex strings." }, "rootFolderId": { "description": "The id of the root folder.", "type": "string" }, "selfLink": { "description": "A link back to this item.", "type": "string" }, "languageCode": { "description": "The user's 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" }, "maxUploadSizes": { "description": "List of max upload sizes for each file type. The most specific type takes precedence.", "items": { "type": "object", "properties": { "type": { "description": "The file type.", "type": "string" }, "size": { "description": "The max upload size for this type.", "type": "string", "format": "int64" } } }, "type": "array" }, "isCurrentAppInstalled": { "description": "A boolean indicating whether the authenticated app is installed by the authenticated user.", "type": "boolean" }, "user": { "description": "The authenticated user.", "$ref": "User" }, "permissionId": { "description": "The current user's ID as visible in the permissions collection.", "type": "string" }, "domainSharingPolicy": { "description": "Deprecated: Does not granularly represent allowlisted domains or Trust Rules. The domain sharing policy for the current user. Possible values are: * `allowed` * `allowedWithWarning` * `incomingOnly` * `disallowed` Note that if the user is enrolled in Trust Rules, `disallowed` will always be returned. If sharing is restricted to allowlisted domains, either `incomingOnly` or `allowedWithWarning` will be returned, depending on whether receiving files from outside the allowlisted domains is permitted.", "deprecated": true, "type": "string" }, "importFormats": { "type": "array", "items": { "type": "object", "properties": { "source": { "description": "The imported file's content type to convert from.", "type": "string" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "The possible content types to convert to." } } }, "description": "The allowable import formats." }, "quotaBytesTotal": { "type": "string", "format": "int64", "description": "The total number of quota bytes. This is only relevant when quotaType is LIMITED." }, "canCreateDrives": { "description": "Whether the user can create shared drives.", "type": "boolean" } }, "description": "An item with user information and settings.", "id": "About" }, "ChildReference": { "description": "A reference to a folder's child. Some resource methods (such as `children.get`) require a `childId`. Use the `children.list` method to retrieve the ID of the child.", "id": "ChildReference", "type": "object", "properties": { "kind": { "description": "Output only. This is always `drive#childReference`.", "default": "drive#childReference", "type": "string" }, "childLink": { "description": "Output only. A link to the child.", "type": "string" }, "id": { "type": "string", "annotations": { "required": [ "drive.children.insert" ] }, "description": "The ID of the child." }, "selfLink": { "description": "Output only. A link back to this reference.", "type": "string" } } }, "ClientEncryptionDetails": { "description": "Details about the client-side encryption applied to the file.", "id": "ClientEncryptionDetails", "type": "object", "properties": { "encryptionState": { "description": "The encryption state of the file. The values expected here are: - encrypted - unencrypted ", "type": "string" }, "decryptionMetadata": { "description": "The metadata used for client-side operations.", "$ref": "DecryptionMetadata" } } }, "ParentList": { "id": "ParentList", "description": "A list of a file's parents.", "type": "object", "properties": { "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "items": { "$ref": "ParentReference" }, "type": "array", "description": "The list of parents." }, "kind": { "default": "drive#parentList", "type": "string", "description": "This is always `drive#parentList`." }, "selfLink": { "description": "A link back to this list.", "type": "string" } } }, "Comment": { "type": "object", "properties": { "kind": { "type": "string", "default": "drive#comment", "description": "This is always drive#comment." }, "fileId": { "description": "The file which this comment is addressing.", "type": "string" }, "commentId": { "description": "The ID of the comment.", "type": "string" }, "deleted": { "description": "Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.", "type": "boolean" }, "content": { "type": "string", "annotations": { "required": [ "drive.comments.insert", "drive.comments.patch", "drive.comments.update" ] }, "description": "The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content." }, "context": { "type": "object", "properties": { "value": { "description": "Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.", "type": "string" }, "type": { "description": "The MIME type of the context snippet.", "type": "string" } }, "description": "Context of a file which is being commented on." }, "createdDate": { "type": "string", "format": "date-time", "description": "The date when this comment was first created." }, "modifiedDate": { "description": "The date when this comment or any of its replies were last modified.", "type": "string", "format": "date-time" }, "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" }, "fileTitle": { "description": "The title of the file which this comment is addressing.", "type": "string" }, "selfLink": { "description": "A link back to this comment.", "type": "string" }, "status": { "description": "The status of this comment. Status can be changed by posting a reply to a comment with the desired status. Possible values are: * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies.", "type": "string" }, "htmlContent": { "description": "HTML formatted content for this comment.", "type": "string" }, "author": { "$ref": "User", "description": "The user who wrote this comment." }, "replies": { "description": "Replies to this post.", "type": "array", "items": { "$ref": "CommentReply" } } }, "id": "Comment", "description": "A comment on a file in Google Drive." }, "AppList": { "type": "object", "properties": { "defaultAppIds": { "items": { "type": "string" }, "type": "array", "description": "List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest)." }, "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "description": "The list of apps.", "type": "array", "items": { "$ref": "App" } }, "kind": { "description": "This is always `drive#appList`.", "type": "string", "default": "drive#appList" }, "selfLink": { "description": "A link back to this list.", "type": "string" } }, "id": "AppList", "description": "A list of third-party applications which the user has installed or given access to Google Drive." }, "LabelField": { "type": "object", "properties": { "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" }, "integer": { "description": "Only present if `valueType` is `integer`.", "type": "array", "items": { "type": "string", "format": "int64" } }, "user": { "type": "array", "items": { "$ref": "User" }, "description": "Only present if `valueType` is `user`." }, "selection": { "description": "Only present if `valueType` is `selection`", "type": "array", "items": { "type": "string" } }, "id": { "description": "The identifier of this label field.", "type": "string" }, "dateString": { "items": { "type": "string", "format": "date" }, "type": "array", "description": "Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD." }, "text": { "description": "Only present if `valueType` is `text`.", "type": "array", "items": { "type": "string" } }, "kind": { "type": "string", "default": "drive#labelField", "description": "This is always `drive#labelField`." } }, "description": "Representation of field, which is a typed key-value pair.", "id": "LabelField" }, "CommentReply": { "id": "CommentReply", "description": "A reply to a comment on a file in Google Drive.", "type": "object", "properties": { "author": { "description": "The user who wrote this reply.", "$ref": "User" }, "htmlContent": { "description": "HTML formatted content for this reply.", "type": "string" }, "content": { "type": "string", "annotations": { "required": [ "drive.replies.patch", "drive.replies.update" ] }, "description": "The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen)." }, "createdDate": { "type": "string", "format": "date-time", "description": "The date when this reply was first created." }, "modifiedDate": { "type": "string", "format": "date-time", "description": "The date when this reply was last modified." }, "verb": { "description": "The action this reply performed to the parent comment. When creating a new reply this is the action to be perform tSo the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment.", "type": "string" }, "replyId": { "description": "The ID of the reply.", "type": "string" }, "kind": { "type": "string", "default": "drive#commentReply", "description": "This is always drive#commentReply." }, "deleted": { "description": "Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.", "type": "boolean" } } }, "DriveList": { "type": "object", "properties": { "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.", "type": "string" }, "kind": { "description": "This is always `drive#driveList`", "default": "drive#driveList", "type": "string" }, "items": { "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.", "type": "array", "items": { "$ref": "Drive" } } }, "id": "DriveList", "description": "A list of shared drives." }, "CommentReplyList": { "id": "CommentReplyList", "description": "A list of replies to a comment on a file in Google Drive.", "type": "object", "properties": { "kind": { "description": "This is always `drive#commentReplyList`.", "type": "string", "default": "drive#commentReplyList" }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "nextLink": { "description": "A link to the next page of replies.", "type": "string" }, "items": { "items": { "$ref": "CommentReply" }, "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." }, "nextPageToken": { "description": "The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", "type": "string" } } }, "TeamDriveList": { "description": "A list of Team Drives.", "id": "TeamDriveList", "type": "object", "properties": { "nextPageToken": { "description": "The page token for the next page of Team Drives.", "type": "string" }, "kind": { "type": "string", "default": "drive#teamDriveList", "description": "This is always `drive#teamDriveList`" }, "items": { "description": "The list of Team Drives.", "type": "array", "items": { "$ref": "TeamDrive" } } } }, "CommentList": { "description": "A list of comments on a file in Google Drive.", "id": "CommentList", "type": "object", "properties": { "nextPageToken": { "description": "The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", "type": "string" }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "kind": { "description": "This is always drive#commentList.", "default": "drive#commentList", "type": "string" }, "items": { "description": "The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "type": "array", "items": { "$ref": "Comment" } }, "nextLink": { "description": "A link to the next page of comments.", "type": "string" } } }, "LabelList": { "id": "LabelList", "description": "A list of labels applied to a file.", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "Label" }, "description": "The list of labels." }, "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.", "type": "string" }, "kind": { "type": "string", "default": "drive#labelList", "description": "This is always `drive#labelList`" } } }, "PermissionId": { "type": "object", "properties": { "id": { "description": "The permission ID.", "type": "string" }, "kind": { "type": "string", "default": "drive#permissionId", "description": "This is always `drive#permissionId`." } }, "id": "PermissionId", "description": "An ID for a user or group as seen in Permission items." }, "User": { "id": "User", "description": "Information about a Drive user.", "type": "object", "properties": { "kind": { "default": "drive#user", "readOnly": true, "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`." }, "picture": { "readOnly": true, "type": "object", "properties": { "url": { "description": "Output only. A URL that points to a profile picture of this user.", "readOnly": true, "type": "string" } }, "description": "Output only. The user's profile picture." }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. A plain text displayable name for this user." }, "isAuthenticatedUser": { "description": "Output only. Whether this user is the same as the authenticated user for whom the request was made.", "readOnly": true, "type": "boolean" }, "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." }, "permissionId": { "description": "Output only. The user's ID as visible in Permission resources.", "readOnly": true, "type": "string" } } }, "GeneratedIds": { "id": "GeneratedIds", "description": "A list of generated IDs which can be provided in insert requests", "type": "object", "properties": { "kind": { "default": "drive#generatedIds", "type": "string", "description": "This is always `drive#generatedIds`" }, "ids": { "description": "The IDs generated for the requesting user in the specified space.", "type": "array", "items": { "type": "string" } }, "space": { "description": "The type of file that can be created with these IDs.", "type": "string" } } }, "FileList": { "id": "FileList", "description": "A list of files.", "type": "object", "properties": { "kind": { "description": "This is always `drive#fileList`.", "type": "string", "default": "drive#fileList" }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "incompleteSearch": { "description": "Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the \"allDrives\" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as \"default\" or \"drive\".", "type": "boolean" }, "nextLink": { "description": "A link to the next page of files.", "type": "string" }, "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "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.", "type": "string" } } }, "Change": { "id": "Change", "description": "Representation of a change to a file or shared drive.", "type": "object", "properties": { "file": { "$ref": "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." }, "type": { "description": "Deprecated: Use `changeType` instead.", "deprecated": true, "type": "string" }, "kind": { "description": "This is always `drive#change`.", "default": "drive#change", "type": "string" }, "fileId": { "description": "The ID of the file associated with this change.", "type": "string" }, "deleted": { "description": "Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.", "type": "boolean" }, "teamDriveId": { "deprecated": true, "type": "string", "description": "Deprecated: Use `driveId` instead." }, "changeType": { "description": "The type of the change. Possible values are `file` and `drive`.", "type": "string" }, "driveId": { "description": "The ID of the shared drive associated with this change.", "type": "string" }, "modificationDate": { "description": "The time of this modification.", "type": "string", "format": "date-time" }, "id": { "description": "The ID of the change.", "type": "string", "format": "int64" }, "teamDrive": { "deprecated": true, "$ref": "TeamDrive", "description": "Deprecated: Use `drive` instead." }, "selfLink": { "description": "A link back to this change.", "type": "string" }, "drive": { "$ref": "Drive", "description": "The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted." } } }, "Drive": { "type": "object", "properties": { "kind": { "description": "Output only. This is always `drive#drive`", "default": "drive#drive", "type": "string" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.insert` 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" }, "hidden": { "description": "Whether the shared drive is hidden from default view.", "type": "boolean" }, "capabilities": { "description": "Output only. Capabilities the current user has on this shared drive.", "type": "object", "properties": { "canResetDriveRestrictions": { "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canReadRevisions": { "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRenameDrive": { "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canDownload": { "description": "Output only. Whether the current user can download files in this shared drive.", "type": "boolean" }, "canComment": { "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.", "type": "boolean" }, "canTrashChildren": { "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canRename": { "description": "Output only. Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canCopy": { "description": "Output only. Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canAddChildren": { "description": "Output only. Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canListChildren": { "description": "Output only. Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canShare": { "description": "Output only. Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "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": { "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.", "type": "boolean" }, "canDeleteDrive": { "description": "Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canEdit": { "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" } } }, "name": { "annotations": { "required": [ "drive.drives.insert" ] }, "type": "string", "description": "The name of this shared drive." }, "colorRgb": { "description": "The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.", "type": "string" }, "backgroundImageFile": { "type": "object", "properties": { "xCoordinate": { "type": "number", "format": "float", "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image." }, "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.", "type": "number", "format": "float" }, "id": { "description": "The ID of an image file in Google Drive to use for the background image.", "type": "string" }, "width": { "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "type": "number", "format": "float" } }, "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." }, "backgroundImageLink": { "description": "Output only. A short-lived link to this shared drive's background image.", "type": "string" }, "restrictions": { "description": "A set of restrictions that apply to this shared drive or items inside this shared drive.", "type": "object", "properties": { "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", "type": "boolean" }, "sharingFoldersRequiresOrganizerPermission": { "description": "If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.", "type": "boolean" }, "driveMembersOnly": { "description": "Whether access to items inside this shared drive is restricted to its members.", "type": "boolean" }, "adminManagedRestrictions": { "description": "Whether administrative privileges on this shared drive are required to modify restrictions.", "type": "boolean" } } }, "id": { "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "createdDate": { "type": "string", "format": "date-time", "description": "The time at which the shared drive was created (RFC 3339 date-time)." }, "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" } }, "id": "Drive", "description": "Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive." }, "ParentReference": { "type": "object", "properties": { "id": { "description": "The ID of the parent.", "type": "string", "annotations": { "required": [ "drive.parents.insert" ] } }, "selfLink": { "description": "Output only. A link back to this reference.", "type": "string" }, "kind": { "type": "string", "default": "drive#parentReference", "description": "Output only. This is always `drive#parentReference`." }, "parentLink": { "description": "Output only. A link to the parent.", "type": "string" }, "isRoot": { "description": "Output only. Whether or not the parent is the root folder.", "type": "boolean" } }, "id": "ParentReference", "description": "A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent." }, "ChangeList": { "id": "ChangeList", "description": "A list of changes for a user.", "type": "object", "properties": { "kind": { "default": "drive#changeList", "type": "string", "description": "This is always `drive#changeList`." }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "nextLink": { "description": "A link to the next page of changes.", "type": "string" }, "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "items": { "$ref": "Change" }, "type": "array", "description": "The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched." }, "nextPageToken": { "description": "The page token for the next page of changes. This will be absent if the end of the changes 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" }, "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.", "type": "string" }, "largestChangeId": { "description": "The current largest change ID.", "type": "string", "format": "int64" } } }, "GenerateCseTokenResponse": { "id": "GenerateCseTokenResponse", "description": "JWT and associated metadata used to generate CSE files.", "type": "object", "properties": { "currentKaclsId": { "type": "string", "format": "int64", "description": "The current Key ACL Service (KACLS) ID associated with the JWT." }, "jwt": { "description": "The signed JSON Web Token (JWT) for the file.", "type": "string" }, "fileId": { "description": "The fileId for which the JWT was generated.", "type": "string" }, "currentKaclsName": { "description": "Name of the KACLs that the returned KACLs ID points to.", "type": "string" }, "kind": { "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.", "type": "string" } } }, "RevisionList": { "type": "object", "properties": { "nextPageToken": { "description": "The page token for the next page of revisions. This field 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.", "type": "string" }, "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "items": { "$ref": "Revision" }, "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." }, "kind": { "description": "This is always `drive#revisionList`.", "type": "string", "default": "drive#revisionList" }, "selfLink": { "description": "A link back to this list.", "type": "string" } }, "description": "A list of revisions of a file.", "id": "RevisionList" }, "Property": { "type": "object", "properties": { "visibility": { "description": "The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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": "string" }, "kind": { "description": "Output only. This is always `drive#property`.", "default": "drive#property", "type": "string" }, "selfLink": { "description": "Output only. The link back to this property.", "type": "string" }, "value": { "description": "The value of this property.", "type": "string" }, "key": { "annotations": { "required": [ "drive.properties.insert" ] }, "type": "string", "description": "The key of this property." }, "etag": { "description": "Output only. ETag of the property.", "type": "string" } }, "id": "Property", "description": "A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property." }, "ModifyLabelsRequest": { "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "id": "ModifyLabelsRequest", "type": "object", "properties": { "labelModifications": { "description": "The list of modifications to apply to the labels on the file.", "type": "array", "items": { "$ref": "LabelModification" } }, "kind": { "default": "drive#modifyLabelsRequest", "type": "string", "description": "This is always `drive#modifyLabelsRequest`." } } }, "StartPageToken": { "id": "StartPageToken", "type": "object", "properties": { "startPageToken": { "description": "The starting page token for listing changes.", "type": "string" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.", "default": "drive#startPageToken", "type": "string" } } }, "Label": { "description": "Representation of a label and label fields.", "id": "Label", "type": "object", "properties": { "id": { "description": "The ID of the label.", "type": "string" }, "fields": { "type": "object", "description": "A map of the fields on the label, keyed by the field's ID.", "additionalProperties": { "$ref": "LabelField" } }, "revisionId": { "description": "The revision ID of the label.", "type": "string" }, "kind": { "description": "This is always `drive#label`", "default": "drive#label", "type": "string" } } }, "TeamDrive": { "type": "object", "properties": { "restrictions": { "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "type": "object", "properties": { "sharingFoldersRequiresOrganizerPermission": { "description": "If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.", "type": "boolean" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.", "type": "boolean" }, "teamMembersOnly": { "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive.", "type": "boolean" }, "adminManagedRestrictions": { "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", "type": "boolean" } } }, "orgUnitId": { "description": "The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.", "type": "string" }, "createdDate": { "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "type": "string", "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" }, "kind": { "description": "This is always `drive#teamDrive`", "type": "string", "default": "drive#teamDrive" }, "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.insert` 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": "A short-lived link to this Team Drive's background image.", "type": "string" }, "colorRgb": { "description": "The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.", "type": "string" }, "backgroundImageFile": { "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "type": "object", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", "type": "string" }, "width": { "type": "number", "format": "float", "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high." }, "xCoordinate": { "type": "number", "format": "float", "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image." }, "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.", "type": "number", "format": "float" } } }, "name": { "type": "string", "annotations": { "required": [ "drive.teamdrives.insert" ] }, "description": "The name of this Team Drive." }, "capabilities": { "type": "object", "properties": { "canAddChildren": { "description": "Whether the current user can add children to folders in this Team Drive.", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this Team Drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this Team Drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this Team Drive.", "type": "boolean" }, "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" }, "canChangeTeamMembersOnlyRestriction": { "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or folders in this Team Drive.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files in this Team Drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this Team Drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this Team Drive.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { "description": "Whether the current user can change the background of this Team Drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.", "type": "boolean" }, "canRenameTeamDrive": { "description": "Whether the current user can rename this Team Drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this Team Drive", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.", "type": "boolean" }, "canResetTeamDriveRestrictions": { "description": "Whether the current user can reset the Team Drive restrictions to defaults.", "type": "boolean" }, "canManageMembers": { "description": "Whether the current user can add members to this Team Drive or remove them or change their role.", "type": "boolean" }, "canRemoveChildren": { "deprecated": true, "type": "boolean", "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead." }, "canShare": { "description": "Whether the current user can share files or folders in this Team Drive.", "type": "boolean" } }, "description": "Capabilities the current user has on this Team Drive." } }, "id": "TeamDrive", "description": "Deprecated: Use the `drive` collection instead." }, "PropertyList": { "description": "A collection of properties, key-value pairs that are either public or private to an application.", "id": "PropertyList", "type": "object", "properties": { "selfLink": { "description": "The link back to this list.", "type": "string" }, "kind": { "default": "drive#propertyList", "type": "string", "description": "This is always `drive#propertyList`." }, "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "type": "array", "items": { "$ref": "Property" }, "description": "The list of properties." } } }, "LabelModification": { "type": "object", "properties": { "removeLabel": { "description": "If true, the label will be removed from the file.", "type": "boolean" }, "kind": { "description": "This is always `drive#labelModification`.", "type": "string", "default": "drive#labelModification" }, "labelId": { "annotations": { "required": [ "drive.files.modifyLabels" ] }, "type": "string", "description": "The ID of the label to modify." }, "fieldModifications": { "description": "The list of modifications to this label's fields.", "items": { "$ref": "LabelFieldModification" }, "type": "array" } }, "id": "LabelModification", "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." }, "Revision": { "type": "object", "properties": { "downloadUrl": { "description": "Output only. Short term download URL for the file. This will only be populated on files with content stored in Drive.", "type": "string" }, "pinned": { "description": "Whether this revision is pinned to prevent automatic purging. If not set, the revision is automatically purged 30 days after newer content is uploaded. This field can only be modified on files with content stored in Drive, excluding Docs Editors files. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.", "type": "boolean" }, "fileSize": { "description": "Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive.", "type": "string", "format": "int64" }, "md5Checksum": { "description": "Output only. An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.", "type": "string" }, "id": { "description": "Output only. The ID of the revision.", "type": "string" }, "selfLink": { "description": "Output only. A link back to this revision.", "type": "string" }, "publishAuto": { "description": "Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "originalFilename": { "description": "Output only. The original filename when this revision was created. This will only be populated on files with content stored in Drive.", "type": "string" }, "publishedLink": { "description": "Output only. A link to the published revision. This is only populated for Docs Editors files.", "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" }, "modifiedDate": { "description": "Last time this revision was modified (formatted RFC 3339 timestamp).", "type": "string", "format": "date-time" }, "exportLinks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. Links for exporting Docs Editors files to specific formats." }, "publishedOutsideDomain": { "description": "Whether this revision is published outside the domain. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "etag": { "description": "Output only. The ETag of the revision.", "type": "string" }, "kind": { "type": "string", "default": "drive#revision", "description": "Output only. This is always `drive#revision`." }, "published": { "description": "Whether this revision is published. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "mimeType": { "description": "Output only. The MIME type of the revision.", "type": "string" }, "lastModifyingUserName": { "description": "Output only. Name of the last user to modify this revision.", "type": "string" } }, "description": "A revision of a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.", "id": "Revision" }, "ContentRestriction": { "description": "A restriction for accessing the content of the file.", "id": "ContentRestriction", "type": "object", "properties": { "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" }, "restrictingUser": { "description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true.", "$ref": "User" }, "reason": { "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.", "type": "string" }, "type": { "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.", "type": "string" }, "restrictionDate": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "type": "string", "format": "date-time" }, "systemRestricted": { "description": "Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.", "type": "boolean" } } }, "LabelFieldModification": { "description": "A modification to a label's field.", "id": "LabelFieldModification", "type": "object", "properties": { "setUserValues": { "type": "array", "items": { "type": "string" }, "description": "Replaces a `user` field with these new values. The values must be valid email addresses." }, "kind": { "description": "This is always `drive#labelFieldModification`.", "type": "string", "default": "drive#labelFieldModification" }, "setDateValues": { "type": "array", "items": { "type": "string", "format": "date" }, "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." }, "setIntegerValues": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Replaces the value of an `integer` field with these new values." }, "fieldId": { "description": "The ID of the field to be modified.", "type": "string" }, "setTextValues": { "type": "array", "items": { "type": "string" }, "description": "Sets the value of a `text` field." }, "setSelectionValues": { "description": "Replaces a `selection` field with these new values.", "type": "array", "items": { "type": "string" } }, "unsetValues": { "description": "Unsets the values for this field.", "type": "boolean" } } }, "ModifyLabelsResponse": { "id": "ModifyLabelsResponse", "description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.", "type": "object", "properties": { "kind": { "description": "This is always `drive#modifyLabelsResponse`", "type": "string", "default": "drive#modifyLabelsResponse" }, "modifiedLabels": { "items": { "$ref": "Label" }, "type": "array", "description": "The list of labels which were added or updated by the request." } } }, "Channel": { "id": "Channel", "description": "A notification channel used to watch for resource changes.", "type": "object", "properties": { "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`." }, "resourceId": { "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", "type": "string" }, "expiration": { "type": "string", "format": "int64", "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional." }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "params": { "additionalProperties": { "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", "type": "object" }, "payload": { "description": "A Boolean value to indicate whether payload is wanted. Optional.", "type": "boolean" }, "token": { "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", "type": "string" }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" or \"webhook\".", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" } } }, "App": { "type": "object", "properties": { "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" }, "createUrl": { "description": "The url to create a new file with this app.", "type": "string" }, "shortDescription": { "description": "A short description of the app.", "type": "string" }, "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" }, "kind": { "description": "This is always `drive#app`.", "type": "string", "default": "drive#app" }, "name": { "description": "The name of the app.", "type": "string" }, "supportsCreate": { "description": "Whether this app supports creating new objects.", "type": "boolean" }, "supportsImport": { "description": "Whether this app supports importing from Docs Editors.", "type": "boolean" }, "primaryFileExtensions": { "type": "array", "items": { "type": "string" }, "description": "The list of primary file extensions." }, "icons": { "description": "The various icons for the app.", "items": { "type": "object", "properties": { "size": { "type": "integer", "format": "int32", "description": "Size of the icon. Represented as the maximum of the width and height." }, "category": { "description": "Category of the icon. Allowed values are: * `application` - icon for the application * `document` - icon for a file associated with the app * `documentShared` - icon for a shared file associated with the app", "type": "string" }, "iconUrl": { "description": "URL for the icon.", "type": "string" } } }, "type": "array" }, "primaryMimeTypes": { "description": "The list of primary mime types.", "type": "array", "items": { "type": "string" } }, "createInFolderTemplate": { "description": "The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.", "type": "string" }, "id": { "description": "The ID of the app.", "type": "string" }, "longDescription": { "description": "A long description of the app.", "type": "string" }, "installed": { "description": "Whether the app is installed.", "type": "boolean" }, "supportsMultiOpen": { "description": "Whether this app supports opening more than one file.", "type": "boolean" }, "supportsOfflineCreate": { "description": "Whether this app supports creating new files when offline.", "type": "boolean" }, "secondaryFileExtensions": { "items": { "type": "string" }, "type": "array", "description": "The list of secondary file extensions." }, "productUrl": { "description": "A link to the product listing for this app.", "type": "string" }, "objectType": { "description": "The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.", "type": "string" }, "productId": { "description": "The ID of the product listing for this app.", "type": "string" }, "secondaryMimeTypes": { "description": "The list of secondary mime types.", "type": "array", "items": { "type": "string" } }, "openUrlTemplate": { "description": "The template url for opening files with this app. The template will contain `{ids}` and/or `{exportIds}` to be replaced by the actual file ids. See Open Files for the full documentation.", "type": "string" } }, "description": "The apps resource provides a list of the 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.", "id": "App" }, "Permission": { "type": "object", "properties": { "inheritedPermissionsDisabled": { "description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", "type": "boolean" }, "type": { "annotations": { "required": [ "drive.permissions.insert" ] }, "type": "string", "description": "The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`" }, "role": { "type": "string", "annotations": { "required": [ "drive.permissions.insert" ] }, "description": "The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`" }, "expirationDate": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests", "type": "string", "format": "date-time" }, "emailAddress": { "description": "Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.", "type": "string" }, "authKey": { "deprecated": true, "type": "string", "description": "Output only. Deprecated." }, "etag": { "description": "Output only. The ETag of the permission.", "type": "string" }, "value": { "description": "The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, "kind": { "description": "Output only. This is always `drive#permission`.", "default": "drive#permission", "type": "string" }, "teamDrivePermissionDetails": { "description": "Output only. Deprecated: Use `permissionDetails` instead.", "readOnly": true, "deprecated": true, "type": "array", "items": { "type": "object", "properties": { "teamDrivePermissionType": { "description": "Output only. Deprecated: Use `permissionDetails/permissionType` instead.", "deprecated": true, "type": "string" }, "role": { "description": "Output only. Deprecated: Use `permissionDetails/role` instead.", "deprecated": true, "type": "string" }, "additionalRoles": { "deprecated": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Deprecated: Use `permissionDetails/additionalRoles` instead." }, "inheritedFrom": { "deprecated": true, "type": "string", "description": "Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead." }, "inherited": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: Use `permissionDetails/inherited` instead." } } } }, "deleted": { "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "name": { "description": "Output only. The name for this permission.", "type": "string" }, "photoLink": { "description": "Output only. A link to the profile photo, if available.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - 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. Note: The metadata view is currently only supported on folders. ", "type": "string" }, "id": { "description": "The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, "additionalRoles": { "items": { "type": "string" }, "type": "array", "description": "Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future." }, "selfLink": { "description": "Output only. A link back to this permission.", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.", "type": "boolean" }, "withLink": { "description": "Whether the link is required for this permission.", "type": "boolean" }, "domain": { "description": "Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.", "type": "string" }, "permissionDetails": { "items": { "type": "object", "properties": { "inherited": { "description": "Output only. Whether this permission is inherited. This field is always populated.", "type": "boolean" }, "permissionType": { "description": "Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`", "type": "string" }, "role": { "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`", "type": "string" }, "inheritedFrom": { "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "additionalRoles": { "description": "Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.", "items": { "type": "string" }, "type": "array" } } }, "readOnly": true, "type": "array", "description": "Output only. Details of whether the permissions on this item are inherited or directly on this item." } }, "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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.", "id": "Permission" }, "ChildList": { "type": "object", "properties": { "etag": { "description": "The ETag of the list.", "type": "string" }, "items": { "description": "The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "ChildReference" }, "type": "array" }, "nextLink": { "description": "A link to the next page of children.", "type": "string" }, "selfLink": { "description": "A link back to this list.", "type": "string" }, "kind": { "description": "This is always `drive#childList`.", "default": "drive#childList", "type": "string" }, "nextPageToken": { "description": "The page token for the next page of children. This will be absent if the end of the children 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" } }, "id": "ChildList", "description": "A list of children of a file." } }, "ownerName": "Google", "rootUrl": "https://www.googleapis.com/", "discoveryVersion": "v1", "description": "The Google Drive API allows clients to access resources from Google Drive.", "version": "v2", "protocol": "rest", "documentationLink": "https://developers.google.com/workspace/drive/", "revision": "20260428", "auth": { "oauth2": { "scopes": { "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": { "description": "View and manage metadata of files in your Google Drive" }, "https://www.googleapis.com/auth/drive.apps.readonly": { "description": "View your Google Drive apps" }, "https://www.googleapis.com/auth/drive.metadata.readonly": { "description": "See information about your Google Drive files" }, "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.readonly": { "description": "See and download all your Google Drive files" }, "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.scripts": { "description": "Modify your Google Apps Script scripts' behavior" }, "https://www.googleapis.com/auth/drive": { "description": "See, edit, create, and delete all of your Google Drive files" } } } }, "batchPath": "batch/drive/v2", "title": "Google Drive API", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "basePath": "/drive/v2/", "id": "drive:v2", "baseUrl": "https://www.googleapis.com/drive/v2/" }