@datafire/google_drive
Advanced tools
Client library for Drive API
npm install --save @datafire/google_drive
let google_drive = require('@datafire/google_drive').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
Exchange the code passed to your redirect URI for an access_token
google_drive.oauthCallback({
"code": ""
}, context)
object
stringobject
stringstringstringstringstringExchange a refresh_token for an access_token
google_drive.oauthRefresh(null, context)
This action has no parameters
object
stringstringstringstringstringGets information about the user, the user's Drive, and system capabilities.
google_drive.drive.about.get({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Lists the changes for a user or shared drive.
google_drive.drive.changes.list({
"pageToken": ""
}, context)
object
string: 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.string: The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.boolean: 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.boolean: Whether both My Drive and shared drive items should be included in results.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.boolean: Deprecated use includeItemsFromAllDrives instead.integer: The maximum number of changes to return per page.boolean: Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.string: A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string: Deprecated use driveId instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Gets the starting pageToken for listing future changes.
google_drive.drive.changes.getStartPageToken({}, context)
object
string: The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string: Deprecated use driveId instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Subscribes to changes for a user.
google_drive.drive.changes.watch({
"pageToken": ""
}, context)
object
string: 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.string: The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.boolean: 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.boolean: Whether both My Drive and shared drive items should be included in results.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.boolean: Deprecated use includeItemsFromAllDrives instead.integer: The maximum number of changes to return per page.boolean: Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.string: A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string: Deprecated use driveId instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Stop watching resources through this channel
google_drive.drive.channels.stop({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Lists the user's shared drives.
google_drive.drive.drives.list({}, context)
object
integer: Maximum number of shared drives to return.string: Page token for shared drives.string: Query string for searching shared drives.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a new shared drive.
google_drive.drive.drives.create({
"requestId": ""
}, context)
object
string: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
google_drive.drive.drives.delete({
"driveId": ""
}, context)
object
string: The ID of the shared drive.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a shared drive's metadata by ID.
google_drive.drive.drives.get({
"driveId": ""
}, context)
object
string: The ID of the shared drive.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates the metadate for a shared drive.
google_drive.drive.drives.update({
"driveId": ""
}, context)
object
string: The ID of the shared drive.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Hides a shared drive from the default view.
google_drive.drive.drives.hide({
"driveId": ""
}, context)
object
string: The ID of the shared drive.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Restores a shared drive to the default view.
google_drive.drive.drives.unhide({
"driveId": ""
}, context)
object
string: The ID of the shared drive.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Lists or searches files.
google_drive.drive.files.list({}, context)
object
string: Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.string (values: domain, user): The source of files to list. Deprecated: use 'corpora' instead.string: ID of the shared drive to search.boolean: Whether both My Drive and shared drive items should be included in results.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Deprecated use includeItemsFromAllDrives instead.string: A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.integer: 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.string: 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.string: A query for filtering the file results. See the "Search for Files" guide for supported syntax.string: A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string: Deprecated use driveId instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a new file.
google_drive.drive.files.create({}, context)
object
boolean: Deprecated. Creating files in multiple folders is no longer supported.boolean: Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.string: A language hint for OCR processing during image import (ISO 639-1 code).boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: Whether to use the uploaded content as indexable text.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Generates a set of file IDs which can be provided in create or copy requests.
google_drive.drive.files.generateIds({}, context)
object
integer: The number of IDs to return.string: The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Permanently deletes all of the user's trashed files.
google_drive.drive.files.emptyTrash({}, context)
object
boolean: Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
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. If the target is a folder, all descendants owned by the user are also deleted.
google_drive.drive.files.delete({
"fileId": ""
}, context)
object
string: The ID of the file.boolean: Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a file's metadata or content by ID.
google_drive.drive.files.get({
"fileId": ""
}, context)
object
string: The ID of the file.boolean: Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates a file's metadata and/or content. This method supports patch semantics.
google_drive.drive.files.update({
"fileId": ""
}, context)
object
string: The ID of the file.string: A comma-separated list of parent IDs to add.boolean: Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.string: A language hint for OCR processing during image import (ISO 639-1 code).string: A comma-separated list of parent IDs to remove.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: Whether to use the uploaded content as indexable text.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Lists a file's comments.
google_drive.drive.comments.list({
"fileId": ""
}, context)
object
string: The ID of the file.boolean: Whether to include deleted comments. Deleted comments will not include their original content.integer: The maximum number of comments to return per page.string: 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.string: The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a new comment on a file.
google_drive.drive.comments.create({
"fileId": ""
}, context)
object
string: The ID of the file.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deletes a comment.
google_drive.drive.comments.delete({
"fileId": "",
"commentId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a comment by ID.
google_drive.drive.comments.get({
"fileId": "",
"commentId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.boolean: Whether to return deleted comments. Deleted comments will not include their original content.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates a comment with patch semantics.
google_drive.drive.comments.update({
"fileId": "",
"commentId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Lists a comment's replies.
google_drive.drive.replies.list({
"fileId": "",
"commentId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.boolean: Whether to include deleted replies. Deleted replies will not include their original content.integer: The maximum number of replies to return per page.string: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a new reply to a comment.
google_drive.drive.replies.create({
"fileId": "",
"commentId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deletes a reply.
google_drive.drive.replies.delete({
"fileId": "",
"commentId": "",
"replyId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string: The ID of the reply.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a reply by ID.
google_drive.drive.replies.get({
"fileId": "",
"commentId": "",
"replyId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string: The ID of the reply.boolean: Whether to return deleted replies. Deleted replies will not include their original content.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates a reply with patch semantics.
google_drive.drive.replies.update({
"fileId": "",
"commentId": "",
"replyId": ""
}, context)
object
string: The ID of the file.string: The ID of the comment.string: The ID of the reply.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.
google_drive.drive.files.copy({
"fileId": ""
}, context)
object
string: The ID of the file.boolean: Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.boolean: Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.string: A language hint for OCR processing during image import (ISO 639-1 code).boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
google_drive.drive.files.export({
"fileId": "",
"mimeType": ""
}, context)
object
string: The ID of the file.string: The MIME type of the format requested for this export.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Lists a file's or shared drive's permissions.
google_drive.drive.permissions.list({
"fileId": ""
}, context)
object
string: The ID of the file or shared drive.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.integer: 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.string: 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.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Creates a permission for a file or shared drive.
google_drive.drive.permissions.create({
"fileId": ""
}, context)
object
string: The ID of the file or shared drive.string: A plain text custom message to include in the notification email.boolean: Deprecated. See moveToNewOwnersRoot for details.boolean: 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.boolean: Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deletes a permission.
google_drive.drive.permissions.delete({
"fileId": "",
"permissionId": ""
}, context)
object
string: The ID of the file or shared drive.string: The ID of the permission.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a permission by ID.
google_drive.drive.permissions.get({
"fileId": "",
"permissionId": ""
}, context)
object
string: The ID of the file.string: The ID of the permission.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates a permission with patch semantics.
google_drive.drive.permissions.update({
"fileId": "",
"permissionId": ""
}, context)
object
string: The ID of the file or shared drive.string: The ID of the permission.boolean: Whether to remove the expiration date.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.boolean: Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Lists a file's revisions.
google_drive.drive.revisions.list({
"fileId": ""
}, context)
object
string: The ID of the file.integer: The maximum number of revisions to return per page.string: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.
google_drive.drive.revisions.delete({
"fileId": "",
"revisionId": ""
}, context)
object
string: The ID of the file.string: The ID of the revision.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Gets a revision's metadata or content by ID.
google_drive.drive.revisions.get({
"fileId": "",
"revisionId": ""
}, context)
object
string: The ID of the file.string: The ID of the revision.boolean: Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Updates a revision with patch semantics.
google_drive.drive.revisions.update({
"fileId": "",
"revisionId": ""
}, context)
object
string: The ID of the file.string: The ID of the revision.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Subscribes to changes to a file
google_drive.drive.files.watch({
"fileId": ""
}, context)
object
string: The ID of the file.boolean: Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.string: Specifies which additional view's permissions to include in the response. Only 'published' is supported.boolean: Whether the requesting application supports both My Drives and shared drives.boolean: Deprecated use supportsAllDrives instead.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deprecated use drives.list instead.
google_drive.drive.teamdrives.list({}, context)
object
integer: Maximum number of Team Drives to return.string: Page token for Team Drives.string: Query string for searching Team Drives.boolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deprecated use drives.create instead.
google_drive.drive.teamdrives.create({
"requestId": ""
}, context)
object
string: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deprecated use drives.delete instead.
google_drive.drive.teamdrives.delete({
"teamDriveId": ""
}, context)
object
string: The ID of the Team Drivestring (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Output schema unknown
Deprecated use drives.get instead.
google_drive.drive.teamdrives.get({
"teamDriveId": ""
}, context)
object
string: The ID of the Team Driveboolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.Deprecated use drives.update instead
google_drive.drive.teamdrives.update({
"teamDriveId": ""
}, context)
object
string: The ID of the Team Driveboolean: 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.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: 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.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string: Deprecated. Please use quotaUser instead.object: Information about the user, the user's Drive, and system capabilities.
boolean: Whether the user has installed the requesting app.boolean: Whether the user can create shared drives.boolean: Deprecated - use canCreateDrives instead.array: A list of themes that are supported for shared drives.
object
string: A link to this theme's background image.string: The color of this theme as an RGB hex string.string: The ID of the theme.object: A map of source MIME type to possible targets for all supported exports.array: The currently supported folder colors as RGB hex strings.
stringobject: A map of source MIME type to possible targets for all supported imports.string: Identifies what kind of resource this is. Value: the fixed string "drive#about".object: A map of maximum import sizes by MIME type, in bytes.string: The maximum upload size in bytes.object: The user's storage quota limits and usage. All fields are measured in bytes.
string: The usage limit, if applicable. This will not be present if the user has unlimited storage.string: The total usage across all services.string: The usage by all files in Google Drive.string: The usage by trashed files in Google Drive.array: Deprecated - use driveThemes instead.
object
string: Deprecated - use driveThemes/backgroundImageLink instead.string: Deprecated - use driveThemes/colorRgb instead.string: Deprecated - use driveThemes/id instead.object: A change to a file or shared drive.
string: The type of the change. Possible values are file and drive.string: The ID of the shared drive associated with this change.string: The ID of the file which has changed.string: Identifies what kind of resource this is. Value: the fixed string "drive#change".boolean: Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.string: Deprecated - use driveId instead.string: The time of this change (RFC 3339 date-time).string: Deprecated - use changeType instead.object: A list of changes for a user.
array: The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
string: Identifies what kind of resource this is. Value: the fixed string "drive#changeList".string: The starting page token for future changes. This will be present only if the end of the current changes list has been reached.string: 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.object: An notification channel used to watch for resource changes.
string: The address where notifications are delivered for this channel.string: Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.string: A UUID or similar unique string that identifies this channel.string: Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".object: Additional parameters controlling delivery channel behavior. Optional.boolean: A Boolean value to indicate whether payload is wanted. Optional.string: An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.string: A version-specific identifier for the watched resource.string: An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.string: The type of delivery mechanism used for this channel.object: A comment on a file.
string: A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.string: The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.string: The time at which the comment was created (RFC 3339 date-time).boolean: Whether the comment has been deleted. A deleted comment has no content.string: The content of the comment with HTML formatting.string: The ID of the comment.string: Identifies what kind of resource this is. Value: the fixed string "drive#comment".string: The last time the comment or any of its replies was modified (RFC 3339 date-time).object: The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
string: The MIME type of the quoted content.string: The quoted content itself. This is interpreted as plain text if set through the API.array: The full list of replies to the comment in chronological order.
boolean: Whether the comment has been resolved by one of its replies.object: A list of comments on a file.
array: The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
string: Identifies what kind of resource this is. Value: the fixed string "drive#commentList".string: 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.object: A restriction for accessing the content of the file.
boolean: 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.string: Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.string: The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.string: The type of the content restriction. Currently the only possible value is globalContentRestriction.object: Representation of a shared drive.
object: 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.
string: The ID of an image file in Google Drive to use for the background image.number: 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.number: 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.number: 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.string: A short-lived link to this shared drive's background image.object: Capabilities the current user has on this shared drive.
boolean: Whether the current user can add children to folders in this shared drive.boolean: Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.boolean: Whether the current user can change the domainUsersOnly restriction of this shared drive.boolean: Whether the current user can change the background of this shared drive.boolean: Whether the current user can change the driveMembersOnly restriction of this shared drive.boolean: Whether the current user can comment on files in this shared drive.boolean: Whether the current user can copy files in this shared drive.boolean: Whether the current user can delete children from folders in this shared drive.boolean: 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.boolean: Whether the current user can download files in this shared drive.boolean: Whether the current user can edit files in this shared driveboolean: Whether the current user can list the children of folders in this shared drive.boolean: Whether the current user can add members to this shared drive or remove them or change their role.boolean: Whether the current user can read the revisions resource of files in this shared drive.boolean: Whether the current user can rename files or folders in this shared drive.boolean: Whether the current user can rename this shared drive.boolean: Whether the current user can share files or folders in this shared drive.boolean: Whether the current user can trash children from folders in this shared drive.string: 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.string: The time at which the shared drive was created (RFC 3339 date-time).boolean: Whether the shared drive is hidden from default view.string: The ID of this shared drive which is also the ID of the top level folder of this shared drive.string: Identifies what kind of resource this is. Value: the fixed string "drive#drive".string: The name of this shared drive.object: A set of restrictions that apply to this shared drive or items inside this shared drive.
boolean: Whether administrative privileges on this shared drive are required to modify restrictions.boolean: 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.boolean: 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.boolean: Whether access to items inside this shared drive is restricted to its members.string: The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.object: A list of shared drives.
array: The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
string: Identifies what kind of resource this is. Value: the fixed string "drive#driveList".string: 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.object: The metadata for a file.
object: A collection of arbitrary key-value pairs which are private to the requesting app.object: Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
boolean: Whether the current user can add children to this folder. This is always false when the item is not a folder.boolean: 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.boolean: 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.boolean: Whether the current user can change the copyRequiresWriterPermission restriction of this file.boolean: Deprecatedboolean: Whether the current user can comment on this file.boolean: 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.boolean: Whether the current user can delete this file.boolean: 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.boolean: Whether the current user can download this file.boolean: 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.boolean: Whether the current user can list the children of this folder. This is always false when the item is not a folder.boolean: Whether the current user can modify the content of this file.boolean: Whether the current user can modify restrictions on content of this file.boolean: 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.boolean: Deprecated - use canMoveChildrenOutOfDrive instead.boolean: 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.boolean: Deprecated - use canMoveChildrenWithinDrive instead.boolean: Deprecated - use canMoveItemOutOfDrive instead.boolean: 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.boolean: Deprecated - use canMoveItemOutOfDrive instead.boolean: 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.boolean: Deprecated - use canMoveItemWithinDrive instead.boolean: Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.boolean: Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.boolean: 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.boolean: Deprecated - use canReadDrive instead.boolean: 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.boolean: 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.boolean: Whether the current user can rename this file.boolean: Whether the current user can modify the sharing settings for this file.boolean: Whether the current user can move this file to trash.boolean: 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.boolean: Whether the current user can restore this file from trash.object: Additional information about the content of the file. These fields are never populated in responses.
string: Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.object: A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
string: The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).string: The MIME type of the thumbnail.array: Restrictions for accessing the content of the file. Only populated if such a restriction exists.
boolean: Whether the options to copy, print, or download this file, should be disabled for readers and commenters.string: The time at which the file was created (RFC 3339 date-time).string: A short description of the file.string: ID of the shared drive the file resides in. Only populated for items in shared drives.boolean: Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.object: Links for exporting Docs Editors files to specific formats.string: The final component of fullFileExtension. This is only available for files with binary content in Google Drive.string: The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.string: The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.boolean: Whether there are permissions directly on this file. This field is only populated for items in shared drives.boolean: 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.string: The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.string: A static, unauthenticated link to the file's icon.string: The ID of the file.object: Additional metadata about image media, if available.
number: The aperture used to create the photo (f-number).string: The make of the camera used to create the photo.string: The model of the camera used to create the photo.string: The color space of the photo.number: The exposure bias of the photo (APEX value).string: The exposure mode used to create the photo.number: The length of the exposure, in seconds.boolean: Whether a flash was used to create the photo.number: The focal length used to create the photo, in millimeters.integer: The height of the image in pixels.integer: The ISO speed used to create the photo.string: The lens used to create the photo.object: Geographic location information stored in the image.
number: The altitude stored in the image.number: The latitude stored in the image.number: The longitude stored in the image.number: The smallest f-number of the lens at the focal length used to create the photo (APEX value).string: The metering mode used to create the photo.integer: The number of clockwise 90 degree rotations applied from the image's original orientation.string: The type of sensor used to create the photo.integer: The distance to the subject of the photo, in meters.string: The date and time the photo was taken (EXIF DateTime).string: The white balance mode used to create the photo.integer: The width of the image in pixels.boolean: Whether the file was created or opened by the requesting app.string: Identifies what kind of resource this is. Value: the fixed string "drive#file".string: The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.string: The MIME type of the file.boolean: Whether the file has been modified by this user.string: The last time the file was modified by the user (RFC 3339 date-time).string: The last time the file was modified by anyone (RFC 3339 date-time).string: The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.string: The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.boolean: Whether the user owns the file. Not populated for items in shared drives.array: The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
array: The IDs of the parent folders which contain the file.
stringarray: List of permission IDs for users with access to this file.
stringarray: The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
object: A collection of arbitrary key-value pairs which are visible to all apps.string: The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.boolean: Whether the file has been shared. Not populated for items in shared drives.string: The time at which the file was shared with the user, if applicable (RFC 3339 date-time).object: Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
string: The ID of the file that this shortcut points to.string: 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.string: The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.array: The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
stringboolean: Whether the user has starred the file.string: Deprecated - use driveId instead.string: A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. 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.string: The thumbnail version for use in thumbnail cache invalidation.boolean: Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.string: The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.string: A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.object: Additional metadata about video media. This may not be available immediately upon upload.
string: The duration of the video in milliseconds.integer: The height of the video in pixels.integer: The width of the video in pixels.boolean: Whether the file has been viewed by this user.string: The last time the file was viewed by the user (RFC 3339 date-time).boolean: Deprecated - use copyRequiresWriterPermission instead.string: A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.string: A link for opening the file in a relevant Google editor or viewer in a browser.boolean: Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.object: A list of files.
array: The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
boolean: 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 "user" or "drive".string: Identifies what kind of resource this is. Value: the fixed string "drive#fileList".string: 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.object: A list of generated file IDs which can be provided in create requests.
array: The IDs generated for the requesting user in the specified space.
stringstring: Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".string: The type of file that can be created with these IDs.object: A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
boolean: Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.boolean: Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.string: The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:string: The domain to which this permission refers.string: The email address of the user or group to which this permission refers.string: The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:string: The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.string: Identifies what kind of resource this is. Value: the fixed string "drive#permission".array: Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
object
boolean: Whether this permission is inherited. This field is always populated. This is an output-only field.string: The ID of the item from which this permission is inherited. This is an output-only field.string: The permission type for this user. While new values may be added in future, the following are currently possible:string: The primary role for this user. While new values may be added in the future, the following are currently possible:string: A link to the user's profile photo, if available.string: The role granted by this permission. While new values may be supported in the future, the following are currently allowed:array: Deprecated - use permissionDetails instead.
object
boolean: Deprecated - use permissionDetails/inherited instead.string: Deprecated - use permissionDetails/inheritedFrom instead.string: Deprecated - use permissionDetails/role instead.string: Deprecated - use permissionDetails/permissionType instead.string: The type of the grantee. Valid values are:string: Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.object: A list of permissions for a file.
string: Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".string: 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.array: The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
object: A reply to a comment on a file.
string: The action the reply performed to the parent comment. Valid values are:string: The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.string: The time at which the reply was created (RFC 3339 date-time).boolean: Whether the reply has been deleted. A deleted reply has no content.string: The content of the reply with HTML formatting.string: The ID of the reply.string: Identifies what kind of resource this is. Value: the fixed string "drive#reply".string: The last time the reply was modified (RFC 3339 date-time).object: A list of replies to a comment on a file.
string: Identifies what kind of resource this is. Value: the fixed string "drive#replyList".string: 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.array: The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
object: The metadata for a revision to a file.
object: Links for exporting Docs Editors files to specific formats.string: The ID of the revision.boolean: Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.string: Identifies what kind of resource this is. Value: the fixed string "drive#revision".string: The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.string: The MIME type of the revision.string: The last time the revision was modified (RFC 3339 date-time).string: The original filename used to create this revision. This is only applicable to files with binary content in Drive.boolean: Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.boolean: Whether this revision is published. This is only applicable to Docs Editors files.string: A link to the published revision. This is only populated for Google Sites files.boolean: Whether this revision is published outside the domain. This is only applicable to Docs Editors files.string: The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.object: A list of revisions of a file.
string: Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".string: The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.array: The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
object
string: Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".string: The starting page token for listing changes.object: Deprecated: use the drive collection instead.
object: 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.
string: The ID of an image file in Drive to use for the background image.number: 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.number: 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.number: 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.string: A short-lived link to this Team Drive's background image.object: Capabilities the current user has on this Team Drive.
boolean: Whether the current user can add children to folders in this Team Drive.boolean: Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.boolean: Whether the current user can change the domainUsersOnly restriction of this Team Drive.boolean: Whether the current user can change the background of this Team Drive.boolean: Whether the current user can change the teamMembersOnly restriction of this Team Drive.boolean: Whether the current user can comment on files in this Team Drive.boolean: Whether the current user can copy files in this Team Drive.boolean: Whether the current user can delete children from folders in this Team Drive.boolean: 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.boolean: Whether the current user can download files in this Team Drive.boolean: Whether the current user can edit files in this Team Driveboolean: Whether the current user can list the children of folders in this Team Drive.boolean: Whether the current user can add members to this Team Drive or remove them or change their role.boolean: Whether the current user can read the revisions resource of files in this Team Drive.boolean: Deprecated - use canDeleteChildren or canTrashChildren instead.boolean: Whether the current user can rename files or folders in this Team Drive.boolean: Whether the current user can rename this Team Drive.boolean: Whether the current user can share files or folders in this Team Drive.boolean: Whether the current user can trash children from folders in this Team Drive.string: 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.string: The time at which the Team Drive was created (RFC 3339 date-time).string: The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.string: Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".string: The name of this Team Drive.object: A set of restrictions that apply to this Team Drive or items inside this Team Drive.
boolean: Whether administrative privileges on this Team Drive are required to modify restrictions.boolean: 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.boolean: 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.boolean: Whether access to items inside this Team Drive is restricted to members of this Team Drive.string: The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.object: A list of Team Drives.
string: Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList".string: The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.array: The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
object: Information about a Drive user.
string: A plain text displayable name for this user.string: 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.string: Identifies what kind of resource this is. Value: the fixed string "drive#user".boolean: Whether this user is the requesting user.string: The user's ID as visible in Permission resources.string: A link to the user's profile photo, if available.FAQs
DataFire integration for Drive API
We found that @datafire/google_drive demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.