"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.",
"description":"Gets the information about the current user along with Drive API settings",
"httpMethod":"GET",
"id":"drive.about.get",
"parameters":{
"includeSubscribed":{
"default":"true",
"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"
},
"maxChangeIdCount":{
"default":"1",
"description":"Maximum number of remaining change IDs to count",
"format":"int64",
"location":"query",
"type":"string"
},
"startChangeId":{
"description":"Change ID to start counting from when calculating number of remaining change IDs",
"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",
"type":"string"
},
"appFilterMimeTypes":{
"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",
"type":"string"
},
"languageCode":{
"description":"A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).",
"description":"Lists the changes for a user or Team Drive.",
"httpMethod":"GET",
"id":"drive.changes.list",
"parameters":{
"includeCorpusRemovals":{
"default":"false",
"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"
},
"includeDeleted":{
"default":"true",
"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"
},
"includeSubscribed":{
"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",
"type":"boolean"
},
"includeTeamDriveItems":{
"default":"false",
"description":"Whether Team Drive files or changes should be included in results.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"default":"100",
"description":"Maximum number of changes to return.",
"format":"int32",
"location":"query",
"minimum":"1",
"type":"integer"
},
"pageToken":{
"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.",
"location":"query",
"type":"string"
},
"spaces":{
"description":"A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.",
"location":"query",
"type":"string"
},
"startChangeId":{
"description":"Deprecated - use pageToken instead.",
"format":"int64",
"location":"query",
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"teamDriveId":{
"description":"The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.",
"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"
},
"includeDeleted":{
"default":"true",
"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"
},
"includeSubscribed":{
"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",
"type":"boolean"
},
"includeTeamDriveItems":{
"default":"false",
"description":"Whether Team Drive files or changes should be included in results.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"default":"100",
"description":"Maximum number of changes to return.",
"format":"int32",
"location":"query",
"minimum":"1",
"type":"integer"
},
"pageToken":{
"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.",
"location":"query",
"type":"string"
},
"spaces":{
"description":"A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.",
"location":"query",
"type":"string"
},
"startChangeId":{
"description":"Deprecated - use pageToken instead.",
"format":"int64",
"location":"query",
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"teamDriveId":{
"description":"The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
}
},
"path":"files/{folderId}/children",
"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"
]
},
"list":{
"description":"Lists a folder's children.",
"httpMethod":"GET",
"id":"drive.children.list",
"parameterOrder":[
"folderId"
],
"parameters":{
"folderId":{
"description":"The ID of the folder.",
"location":"path",
"required":true,
"type":"string"
},
"maxResults":{
"default":"100",
"description":"Maximum number of children to return.",
"format":"int32",
"location":"query",
"minimum":"0",
"type":"integer"
},
"orderBy":{
"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",
"type":"string"
},
"pageToken":{
"description":"Page token for children.",
"location":"query",
"type":"string"
},
"q":{
"description":"Query string for searching children.",
"description":"If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.",
"location":"query",
"type":"boolean"
}
},
"path":"files/{fileId}/comments/{commentId}",
"response":{
"$ref":"Comment"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly"
]
},
"insert":{
"description":"Creates a new comment on the given file.",
"httpMethod":"POST",
"id":"drive.comments.insert",
"parameterOrder":[
"fileId"
],
"parameters":{
"fileId":{
"description":"The ID of the file.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"files/{fileId}/comments",
"request":{
"$ref":"Comment"
},
"response":{
"$ref":"Comment"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file"
]
},
"list":{
"description":"Lists a file's comments.",
"httpMethod":"GET",
"id":"drive.comments.list",
"parameterOrder":[
"fileId"
],
"parameters":{
"fileId":{
"description":"The ID of the file.",
"location":"path",
"required":true,
"type":"string"
},
"includeDeleted":{
"default":"false",
"description":"If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"default":"20",
"description":"The maximum number of discussions to include in the response, used for paging.",
"format":"int32",
"location":"query",
"maximum":"100",
"minimum":"0",
"type":"integer"
},
"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"
},
"updatedMin":{
"description":"Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.",
"location":"query",
"type":"string"
}
},
"path":"files/{fileId}/comments",
"response":{
"$ref":"CommentList"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly"
]
},
"patch":{
"description":"Updates an existing comment. This method supports patch semantics.",
"description":"Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files.",
"httpMethod":"DELETE",
"id":"drive.files.delete",
"parameterOrder":[
"fileId"
],
"parameters":{
"fileId":{
"description":"The ID of the file to delete.",
"location":"path",
"required":true,
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
}
},
"path":"files/{fileId}",
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.appdata",
"https://www.googleapis.com/auth/drive.file"
]
},
"emptyTrash":{
"description":"Permanently deletes all of the user's trashed files.",
"httpMethod":"DELETE",
"id":"drive.files.emptyTrash",
"path":"files/trash",
"scopes":[
"https://www.googleapis.com/auth/drive"
]
},
"export":{
"description":"Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.",
"httpMethod":"GET",
"id":"drive.files.export",
"parameterOrder":[
"fileId",
"mimeType"
],
"parameters":{
"fileId":{
"description":"The ID of the file.",
"location":"path",
"required":true,
"type":"string"
},
"mimeType":{
"description":"The MIME type of the format requested for this export.",
"location":"query",
"required":true,
"type":"string"
}
},
"path":"files/{fileId}/export",
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly"
],
"supportsMediaDownload":true
},
"generateIds":{
"description":"Generates a set of file IDs which can be provided in insert requests.",
"httpMethod":"GET",
"id":"drive.files.generateIds",
"parameters":{
"maxResults":{
"default":"10",
"description":"Maximum number of IDs to return.",
"format":"int32",
"location":"query",
"maximum":"1000",
"minimum":"1",
"type":"integer"
},
"space":{
"default":"drive",
"description":"The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.",
"location":"query",
"type":"string"
}
},
"path":"files/generateIds",
"response":{
"$ref":"GeneratedIds"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.appdata",
"https://www.googleapis.com/auth/drive.file"
]
},
"get":{
"description":"Gets a file's metadata by ID.",
"httpMethod":"GET",
"id":"drive.files.get",
"parameterOrder":[
"fileId"
],
"parameters":{
"acknowledgeAbuse":{
"default":"false",
"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files.",
"location":"query",
"type":"boolean"
},
"fileId":{
"description":"The ID for the file in question.",
"location":"path",
"required":true,
"type":"string"
},
"projection":{
"description":"This parameter is deprecated and has no function.",
"enum":[
"BASIC",
"FULL"
],
"enumDescriptions":[
"Deprecated",
"Deprecated"
],
"location":"query",
"type":"string"
},
"revisionId":{
"description":"Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.",
"location":"query",
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"updateViewedDate":{
"default":"false",
"description":"Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.",
"description":"Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all other values must be used in isolation. Prefer 'default' or 'teamDrive' to 'allTeamDrives' for efficiency.",
"location":"query",
"type":"string"
},
"corpus":{
"description":"The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.",
"enum":[
"DEFAULT",
"DOMAIN"
],
"enumDescriptions":[
"The items that the user has accessed.",
"Items shared to the user's domain."
],
"location":"query",
"type":"string"
},
"includeTeamDriveItems":{
"default":"false",
"description":"Whether Team Drive items should be included in results.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"default":"100",
"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.",
"format":"int32",
"location":"query",
"minimum":"0",
"type":"integer"
},
"orderBy":{
"description":"A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. 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",
"type":"string"
},
"pageToken":{
"description":"Page token for files.",
"location":"query",
"type":"string"
},
"projection":{
"description":"This parameter is deprecated and has no function.",
"enum":[
"BASIC",
"FULL"
],
"enumDescriptions":[
"Deprecated",
"Deprecated"
],
"location":"query",
"type":"string"
},
"q":{
"description":"Query string for searching files.",
"location":"query",
"type":"string"
},
"spaces":{
"description":"A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.",
"location":"query",
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"description":"Updates file metadata and/or content. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"drive.files.patch",
"parameterOrder":[
"fileId"
],
"parameters":{
"addParents":{
"description":"Comma-separated list of parent IDs to add.",
"location":"query",
"type":"string"
},
"convert":{
"default":"false",
"description":"This parameter is deprecated and has no function.",
"location":"query",
"type":"boolean"
},
"fileId":{
"description":"The ID of the file to update.",
"location":"path",
"required":true,
"type":"string"
},
"modifiedDateBehavior":{
"description":"Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.",
"enum":[
"fromBody",
"fromBodyIfNeeded",
"fromBodyOrNow",
"noChange",
"now",
"nowIfNeeded"
],
"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",
"type":"string"
},
"newRevision":{
"default":"true",
"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.",
"location":"query",
"type":"boolean"
},
"ocr":{
"default":"false",
"description":"Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.",
"location":"query",
"type":"boolean"
},
"ocrLanguage":{
"description":"If ocr is true, hints at the language to use. Valid values are BCP 47 codes.",
"location":"query",
"type":"string"
},
"pinned":{
"default":"false",
"description":"Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.",
"location":"query",
"type":"boolean"
},
"removeParents":{
"description":"Comma-separated list of parent IDs to remove.",
"location":"query",
"type":"string"
},
"setModifiedDate":{
"default":"false",
"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"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"timedTextLanguage":{
"description":"The language of the timed text.",
"location":"query",
"type":"string"
},
"timedTextTrackName":{
"description":"The timed text track name.",
"location":"query",
"type":"string"
},
"updateViewedDate":{
"default":"true",
"description":"Whether to update the view date after successfully updating the file.",
"location":"query",
"type":"boolean"
},
"useContentAsIndexableText":{
"default":"false",
"description":"Whether to use the content as indexable text.",
"description":"Comma-separated list of parent IDs to add.",
"location":"query",
"type":"string"
},
"convert":{
"default":"false",
"description":"This parameter is deprecated and has no function.",
"location":"query",
"type":"boolean"
},
"fileId":{
"description":"The ID of the file to update.",
"location":"path",
"required":true,
"type":"string"
},
"modifiedDateBehavior":{
"description":"Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.",
"enum":[
"fromBody",
"fromBodyIfNeeded",
"fromBodyOrNow",
"noChange",
"now",
"nowIfNeeded"
],
"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",
"type":"string"
},
"newRevision":{
"default":"true",
"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.",
"location":"query",
"type":"boolean"
},
"ocr":{
"default":"false",
"description":"Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.",
"location":"query",
"type":"boolean"
},
"ocrLanguage":{
"description":"If ocr is true, hints at the language to use. Valid values are BCP 47 codes.",
"location":"query",
"type":"string"
},
"pinned":{
"default":"false",
"description":"Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.",
"location":"query",
"type":"boolean"
},
"removeParents":{
"description":"Comma-separated list of parent IDs to remove.",
"location":"query",
"type":"string"
},
"setModifiedDate":{
"default":"false",
"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"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"timedTextLanguage":{
"description":"The language of the timed text.",
"location":"query",
"type":"string"
},
"timedTextTrackName":{
"description":"The timed text track name.",
"location":"query",
"type":"string"
},
"updateViewedDate":{
"default":"true",
"description":"Whether to update the view date after successfully updating the file.",
"location":"query",
"type":"boolean"
},
"useContentAsIndexableText":{
"default":"false",
"description":"Whether to use the content as indexable text.",
"description":"Deletes a permission from a file or Team Drive.",
"httpMethod":"DELETE",
"id":"drive.permissions.delete",
"parameterOrder":[
"fileId",
"permissionId"
],
"parameters":{
"fileId":{
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"permissionId":{
"description":"The ID for the permission.",
"location":"path",
"required":true,
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"permissionId":{
"description":"The ID for the permission.",
"location":"path",
"required":true,
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"description":"Inserts a permission for a file or Team Drive.",
"httpMethod":"POST",
"id":"drive.permissions.insert",
"parameterOrder":[
"fileId"
],
"parameters":{
"emailMessage":{
"description":"A plain text custom message to include in notification emails.",
"location":"query",
"type":"string"
},
"fileId":{
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"sendNotificationEmails":{
"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",
"type":"boolean"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"location":"query",
"type":"boolean"
}
},
"path":"files/{fileId}/permissions",
"request":{
"$ref":"Permission"
},
"response":{
"$ref":"Permission"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file"
]
},
"list":{
"description":"Lists a file's or Team Drive's permissions.",
"httpMethod":"GET",
"id":"drive.permissions.list",
"parameterOrder":[
"fileId"
],
"parameters":{
"fileId":{
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"maxResults":{
"description":"The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned.",
"format":"int32",
"location":"query",
"maximum":"100",
"minimum":"1",
"type":"integer"
},
"pageToken":{
"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.",
"location":"query",
"type":"string"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"description":"Updates a permission using patch semantics.",
"httpMethod":"PATCH",
"id":"drive.permissions.patch",
"parameterOrder":[
"fileId",
"permissionId"
],
"parameters":{
"fileId":{
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"permissionId":{
"description":"The ID for the permission.",
"location":"path",
"required":true,
"type":"string"
},
"removeExpiration":{
"default":"false",
"description":"Whether to remove the expiration date.",
"location":"query",
"type":"boolean"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"transferOwnership":{
"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",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"description":"The ID for the file or Team Drive.",
"location":"path",
"required":true,
"type":"string"
},
"permissionId":{
"description":"The ID for the permission.",
"location":"path",
"required":true,
"type":"string"
},
"removeExpiration":{
"default":"false",
"description":"Whether to remove the expiration date.",
"location":"query",
"type":"boolean"
},
"supportsTeamDrives":{
"default":"false",
"description":"Whether the requesting application supports Team Drives.",
"location":"query",
"type":"boolean"
},
"transferOwnership":{
"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",
"type":"boolean"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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 item belongs.",
"description":"Exports the contents of the Realtime API data model associated with this file as JSON.",
"httpMethod":"GET",
"id":"drive.realtime.get",
"parameterOrder":[
"fileId"
],
"parameters":{
"fileId":{
"description":"The ID of the file that the Realtime API data model is associated with.",
"location":"path",
"required":true,
"type":"string"
},
"revision":{
"description":"The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.",
"format":"int32",
"location":"query",
"minimum":"1",
"type":"integer"
}
},
"path":"files/{fileId}/realtime",
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly"
],
"supportsMediaDownload":true
},
"update":{
"description":"Overwrites the Realtime API data model associated with this file with the provided JSON data model.",
"description":"The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server.",
"location":"query",
"type":"string"
},
"fileId":{
"description":"The ID of the file that the Realtime API data model is associated with.",
"description":"Lists all of the replies to a comment.",
"httpMethod":"GET",
"id":"drive.replies.list",
"parameterOrder":[
"fileId",
"commentId"
],
"parameters":{
"commentId":{
"description":"The ID of the comment.",
"location":"path",
"required":true,
"type":"string"
},
"fileId":{
"description":"The ID of the file.",
"location":"path",
"required":true,
"type":"string"
},
"includeDeleted":{
"default":"false",
"description":"If set, all replies, including deleted replies (with content stripped) will be returned.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"default":"20",
"description":"The maximum number of replies to include in the response, used for paging.",
"format":"int32",
"location":"query",
"maximum":"100",
"minimum":"0",
"type":"integer"
},
"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.",
"description":"Maximum number of revisions to return.",
"format":"int32",
"location":"query",
"maximum":"1000",
"minimum":"1",
"type":"integer"
},
"pageToken":{
"description":"Page token for revisions. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
"description":"Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.",
"httpMethod":"DELETE",
"id":"drive.teamdrives.delete",
"parameterOrder":[
"teamDriveId"
],
"parameters":{
"teamDriveId":{
"description":"The ID of the Team Drive",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"teamdrives/{teamDriveId}",
"scopes":[
"https://www.googleapis.com/auth/drive"
]
},
"get":{
"description":"Gets a Team Drive's metadata by ID.",
"httpMethod":"GET",
"id":"drive.teamdrives.get",
"parameterOrder":[
"teamDriveId"
],
"parameters":{
"teamDriveId":{
"description":"The ID of the Team Drive",
"location":"path",
"required":true,
"type":"string"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by 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"
}
},
"path":"teamdrives/{teamDriveId}",
"response":{
"$ref":"TeamDrive"
},
"scopes":[
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.readonly"
]
},
"insert":{
"description":"Creates a new Team Drive.",
"httpMethod":"POST",
"id":"drive.teamdrives.insert",
"parameterOrder":[
"requestId"
],
"parameters":{
"requestId":{
"description":"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,
"type":"string"
}
},
"path":"teamdrives",
"request":{
"$ref":"TeamDrive"
},
"response":{
"$ref":"TeamDrive"
},
"scopes":[
"https://www.googleapis.com/auth/drive"
]
},
"list":{
"description":"Lists the user's Team Drives.",
"httpMethod":"GET",
"id":"drive.teamdrives.list",
"parameters":{
"maxResults":{
"default":"10",
"description":"Maximum number of Team Drives to return.",
"format":"int32",
"location":"query",
"maximum":"100",
"minimum":"1",
"type":"integer"
},
"pageToken":{
"description":"Page token for Team Drives.",
"location":"query",
"type":"string"
},
"q":{
"description":"Query string for searching Team Drives.",
"location":"query",
"type":"string"
},
"useDomainAdminAccess":{
"default":"false",
"description":"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.",
"description":"Information about supported additional roles per file type. The most specific type takes precedence.",
"items":{
"properties":{
"roleSets":{
"description":"The supported additional roles per primary role.",
"items":{
"properties":{
"additionalRoles":{
"description":"The supported additional roles with the primary role.",
"items":{
"type":"string"
},
"type":"array"
},
"primaryRole":{
"description":"A primary permission role.",
"type":"string"
}
},
"type":"object"
},
"type":"array"
},
"type":{
"description":"The content type that this additional role info applies to.",
"type":"string"
}
},
"type":"object"
},
"type":"array"
},
"canCreateTeamDrives":{
"description":"Whether the user can create Team Drives.",
"type":"boolean"
},
"domainSharingPolicy":{
"description":"The domain sharing policy for the current user. Possible values are: \n- allowed \n- allowedWithWarning \n- incomingOnly \n- disallowed",
"type":"string"
},
"etag":{
"description":"The ETag of the item.",
"type":"string"
},
"exportFormats":{
"description":"The allowable export formats.",
"items":{
"properties":{
"source":{
"description":"The content type to convert from.",
"type":"string"
},
"targets":{
"description":"The possible content types to convert to.",
"items":{
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"type":"array"
},
"features":{
"description":"List of additional features enabled on this account.",
"items":{
"properties":{
"featureName":{
"description":"The name of the feature.",
"type":"string"
},
"featureRate":{
"description":"The request limit rate for this feature, in queries per second.",
"format":"double",
"type":"number"
}
},
"type":"object"
},
"type":"array"
},
"folderColorPalette":{
"description":"The palette of allowable folder colors as RGB hex strings.",
"items":{
"type":"string"
},
"type":"array"
},
"importFormats":{
"description":"The allowable import formats.",
"items":{
"properties":{
"source":{
"description":"The imported file's content type to convert from.",
"type":"string"
},
"targets":{
"description":"The possible content types to convert to.",
"items":{
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"type":"array"
},
"isCurrentAppInstalled":{
"description":"A boolean indicating whether the authenticated app is installed by the authenticated user.",
"type":"boolean"
},
"kind":{
"default":"drive#about",
"description":"This is always drive#about.",
"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"
},
"largestChangeId":{
"description":"The largest change id.",
"format":"int64",
"type":"string"
},
"maxUploadSizes":{
"description":"List of max upload sizes for each file type. The most specific type takes precedence.",
"items":{
"properties":{
"size":{
"description":"The max upload size for this type.",
"format":"int64",
"type":"string"
},
"type":{
"description":"The file type.",
"type":"string"
}
},
"type":"object"
},
"type":"array"
},
"name":{
"description":"The name of the current user.",
"type":"string"
},
"permissionId":{
"description":"The current user's ID as visible in the permissions collection.",
"type":"string"
},
"quotaBytesByService":{
"description":"The amount of storage quota used by different Google services.",
"items":{
"properties":{
"bytesUsed":{
"description":"The storage quota bytes used by the service.",
"format":"int64",
"type":"string"
},
"serviceName":{
"description":"The service's name, e.g. DRIVE, GMAIL, or PHOTOS.",
"type":"string"
}
},
"type":"object"
},
"type":"array"
},
"quotaBytesTotal":{
"description":"The total number of quota bytes.",
"format":"int64",
"type":"string"
},
"quotaBytesUsed":{
"description":"The number of quota bytes used by Google Drive.",
"format":"int64",
"type":"string"
},
"quotaBytesUsedAggregate":{
"description":"The number of quota bytes used by all Google apps (Drive, Picasa, etc.).",
"format":"int64",
"type":"string"
},
"quotaBytesUsedInTrash":{
"description":"The number of quota bytes used by trashed items.",
"format":"int64",
"type":"string"
},
"quotaType":{
"description":"The type of the user's storage quota. Possible values are: \n- LIMITED \n- UNLIMITED",
"type":"string"
},
"remainingChangeIds":{
"description":"The number of remaining change ids, limited to no more than 2500.",
"format":"int64",
"type":"string"
},
"rootFolderId":{
"description":"The id of the root folder.",
"type":"string"
},
"selfLink":{
"description":"A link back to this item.",
"type":"string"
},
"teamDriveThemes":{
"description":"A list of themes that are supported for Team Drives.",
"items":{
"properties":{
"backgroundImageLink":{
"description":"A link to this Team Drive theme's background image.",
"type":"string"
},
"colorRgb":{
"description":"The color of this Team Drive theme as an RGB hex 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.",
"id":"App",
"properties":{
"authorized":{
"description":"Whether the app is authorized to access data on the user's Drive.",
"type":"boolean"
},
"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"
},
"createUrl":{
"description":"The url to create a new file with this 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"
},
"icons":{
"description":"The various icons for the app.",
"items":{
"properties":{
"category":{
"description":"Category of the icon. Allowed values are: \n- application - icon for the application \n- document - icon for a file associated with the app \n- documentShared - icon for a shared file associated with the app",
"type":"string"
},
"iconUrl":{
"description":"URL for the icon.",
"type":"string"
},
"size":{
"description":"Size of the icon. Represented as the maximum of the width and height.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"type":"array"
},
"id":{
"description":"The ID of the app.",
"type":"string"
},
"installed":{
"description":"Whether the app is installed.",
"type":"boolean"
},
"kind":{
"default":"drive#app",
"description":"This is always drive#app.",
"type":"string"
},
"longDescription":{
"description":"A long description of the app.",
"type":"string"
},
"name":{
"description":"The name of the 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"
},
"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"
},
"primaryFileExtensions":{
"description":"The list of primary file extensions.",
"items":{
"type":"string"
},
"type":"array"
},
"primaryMimeTypes":{
"description":"The list of primary mime types.",
"items":{
"type":"string"
},
"type":"array"
},
"productId":{
"description":"The ID of the product listing for this app.",
"type":"string"
},
"productUrl":{
"description":"A link to the product listing for this app.",
"type":"string"
},
"secondaryFileExtensions":{
"description":"The list of secondary file extensions.",
"items":{
"type":"string"
},
"type":"array"
},
"secondaryMimeTypes":{
"description":"The list of secondary mime types.",
"items":{
"type":"string"
},
"type":"array"
},
"shortDescription":{
"description":"A short description of the app.",
"type":"string"
},
"supportsCreate":{
"description":"Whether this app supports creating new objects.",
"type":"boolean"
},
"supportsImport":{
"description":"Whether this app supports importing Google Docs.",
"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"
},
"useByDefault":{
"description":"Whether the app is selected as the default handler for the types it supports.",
"description":"Representation of a change to a file or Team Drive.",
"id":"Change",
"properties":{
"deleted":{
"description":"Whether the file or Team Drive has been removed from this list of changes, for example by deletion or loss of access.",
"type":"boolean"
},
"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."
},
"fileId":{
"description":"The ID of the file associated with this change.",
"type":"string"
},
"id":{
"description":"The ID of the change.",
"format":"int64",
"type":"string"
},
"kind":{
"default":"drive#change",
"description":"This is always drive#change.",
"type":"string"
},
"modificationDate":{
"description":"The time of this modification.",
"format":"date-time",
"type":"string"
},
"selfLink":{
"description":"A link back to this change.",
"type":"string"
},
"teamDrive":{
"$ref":"TeamDrive",
"description":"The updated state of the Team Drive. Present if the type is teamDrive, the user is still a member of the Team Drive, and the Team Drive has not been deleted."
},
"teamDriveId":{
"description":"The ID of the Team Drive associated with this change.",
"type":"string"
},
"type":{
"description":"The type of the change. Possible values are file and teamDrive.",
"description":"The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.",
"items":{
"$ref":"Change"
},
"type":"array"
},
"kind":{
"default":"drive#changeList",
"description":"This is always drive#changeList.",
"type":"string"
},
"largestChangeId":{
"description":"The current largest change ID.",
"format":"int64",
"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"
},
"nextLink":{
"description":"A link to the next page of changes.",
"type":"string"
},
"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.",
"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"
},
"kind":{
"default":"drive#childList",
"description":"This is always drive#childList.",
"type":"string"
},
"nextLink":{
"description":"A link to the next page of children.",
"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.",
"description":"A comment on a file in Google Drive.",
"id":"Comment",
"properties":{
"anchor":{
"description":"A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.",
"type":"string"
},
"author":{
"$ref":"User",
"description":"The user who wrote this comment."
},
"commentId":{
"description":"The ID of the comment.",
"type":"string"
},
"content":{
"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.",
"type":"string"
},
"context":{
"description":"The context of the file which is being commented on.",
"properties":{
"type":{
"description":"The MIME type of the context snippet.",
"type":"string"
},
"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":"object"
},
"createdDate":{
"description":"The date when this comment was first created.",
"format":"date-time",
"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"
},
"fileId":{
"description":"The file which this comment is addressing.",
"type":"string"
},
"fileTitle":{
"description":"The title of the file which this comment is addressing.",
"type":"string"
},
"htmlContent":{
"description":"HTML formatted content for this comment.",
"type":"string"
},
"kind":{
"default":"drive#comment",
"description":"This is always drive#comment.",
"type":"string"
},
"modifiedDate":{
"description":"The date when this comment or any of its replies were last modified.",
"format":"date-time",
"type":"string"
},
"replies":{
"description":"Replies to this post.",
"items":{
"$ref":"CommentReply"
},
"type":"array"
},
"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. \n- \"open\" - The comment is still open. \n- \"resolved\" - The comment has been resolved by one of its replies.",
"description":"A list of comments on a file in Google Drive.",
"id":"CommentList",
"properties":{
"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.",
"items":{
"$ref":"Comment"
},
"type":"array"
},
"kind":{
"default":"drive#commentList",
"description":"This is always drive#commentList.",
"type":"string"
},
"nextLink":{
"description":"A link to the next page of comments.",
"type":"string"
},
"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.",
"description":"A comment on a file in Google Drive.",
"id":"CommentReply",
"properties":{
"author":{
"$ref":"User",
"description":"The user who wrote this reply."
},
"content":{
"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).",
"type":"string"
},
"createdDate":{
"description":"The date when this reply was first created.",
"format":"date-time",
"type":"string"
},
"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"
},
"htmlContent":{
"description":"HTML formatted content for this reply.",
"type":"string"
},
"kind":{
"default":"drive#commentReply",
"description":"This is always drive#commentReply.",
"type":"string"
},
"modifiedDate":{
"description":"The date when this reply was last modified.",
"format":"date-time",
"type":"string"
},
"replyId":{
"description":"The ID of the reply.",
"type":"string"
},
"verb":{
"description":"The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: \n- \"resolve\" - To resolve a comment. \n- \"reopen\" - To reopen (un-resolve) a comment.",
"description":"A list of replies to a comment on a file in Google Drive.",
"id":"CommentReplyList",
"properties":{
"items":{
"description":"The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.",
"items":{
"$ref":"CommentReply"
},
"type":"array"
},
"kind":{
"default":"drive#commentReplyList",
"description":"This is always drive#commentReplyList.",
"type":"string"
},
"nextLink":{
"description":"A link to the next page of replies.",
"type":"string"
},
"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.",
"description":"A link for opening the file in a relevant Google editor or viewer.",
"type":"string"
},
"appDataContents":{
"description":"Whether this file is in the Application Data folder.",
"type":"boolean"
},
"canComment":{
"description":"Deprecated: use capabilities/canComment.",
"type":"boolean"
},
"canReadRevisions":{
"description":"Deprecated: use capabilities/canReadRevisions.",
"type":"boolean"
},
"capabilities":{
"description":"Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.",
"properties":{
"canAddChildren":{
"description":"Whether the current user can add children to this folder. This is always false when the item is not a folder.",
"type":"boolean"
},
"canChangeRestrictedDownload":{
"description":"Whether the current user can change the restricted download label of this file.",
"type":"boolean"
},
"canComment":{
"description":"Whether the current user can comment on this file.",
"type":"boolean"
},
"canCopy":{
"description":"Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.",
"type":"boolean"
},
"canDelete":{
"description":"Whether the current user can delete this file.",
"type":"boolean"
},
"canDownload":{
"description":"Whether the current user can download this file.",
"type":"boolean"
},
"canEdit":{
"description":"Whether the current user can edit this file.",
"type":"boolean"
},
"canListChildren":{
"description":"Whether the current user can list the children of this folder. This is always false when the item is not a folder.",
"type":"boolean"
},
"canMoveItemIntoTeamDrive":{
"description":"Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem.",
"type":"boolean"
},
"canMoveTeamDriveItem":{
"description":"Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files.",
"type":"boolean"
},
"canReadRevisions":{
"description":"Whether the current user can read the revisions resource of this file. For a Team 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"
},
"canReadTeamDrive":{
"description":"Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files.",
"type":"boolean"
},
"canRemoveChildren":{
"description":"Whether the current user can remove children from this folder. This is always false when the item is not a folder.",
"type":"boolean"
},
"canRename":{
"description":"Whether the current user can rename this file.",
"type":"boolean"
},
"canShare":{
"description":"Whether the current user can modify the sharing settings for this file.",
"type":"boolean"
},
"canTrash":{
"description":"Whether the current user can move this file to trash.",
"type":"boolean"
},
"canUntrash":{
"description":"Whether the current user can restore this file from trash.",
"type":"boolean"
}
},
"type":"object"
},
"copyable":{
"description":"Deprecated: use capabilities/canCopy.",
"type":"boolean"
},
"createdDate":{
"description":"Create time for this file (formatted RFC 3339 timestamp).",
"format":"date-time",
"type":"string"
},
"defaultOpenWithLink":{
"description":"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"
},
"description":{
"description":"A short description of the file.",
"type":"string"
},
"downloadUrl":{
"type":"string"
},
"editable":{
"description":"Deprecated: use capabilities/canEdit.",
"type":"boolean"
},
"embedLink":{
"description":"A link for embedding the file.",
"type":"string"
},
"etag":{
"description":"ETag of the file.",
"type":"string"
},
"explicitlyTrashed":{
"description":"Whether this file has been explicitly trashed, as opposed to recursively trashed.",
"type":"boolean"
},
"exportLinks":{
"additionalProperties":{
"description":"A mapping from export format to URL",
"type":"string"
},
"description":"Links for exporting Google Docs to specific formats.",
"type":"object"
},
"fileExtension":{
"description":"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 Drive; it is not populated for Google Docs or shortcut files.",
"type":"string"
},
"fileSize":{
"description":"The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.",
"format":"int64",
"type":"string"
},
"folderColorRgb":{
"description":"Folder color as an RGB hex string if the file is 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. Not populated for Team Drive files.",
"type":"string"
},
"fullFileExtension":{
"description":"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 Drive; it is not populated for Google Docs or shortcut files.",
"type":"string"
},
"hasAugmentedPermissions":{
"description":"Whether any users are granted file access directly on this file. This field is only populated for Team Drive files.",
"type":"boolean"
},
"hasThumbnail":{
"description":"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"
},
"headRevisionId":{
"description":"The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.",
"type":"string"
},
"iconLink":{
"description":"A link to the file's icon.",
"type":"string"
},
"id":{
"description":"The ID of the file.",
"type":"string"
},
"imageMediaMetadata":{
"description":"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.",
"properties":{
"aperture":{
"description":"The aperture used to create the photo (f-number).",
"format":"float",
"type":"number"
},
"cameraMake":{
"description":"The make of the camera used to create the photo.",
"type":"string"
},
"cameraModel":{
"description":"The model of the camera used to create the photo.",
"type":"string"
},
"colorSpace":{
"description":"The color space of the photo.",
"type":"string"
},
"date":{
"description":"The date and time the photo was taken (EXIF format timestamp).",
"type":"string"
},
"exposureBias":{
"description":"The exposure bias of the photo (APEX value).",
"format":"float",
"type":"number"
},
"exposureMode":{
"description":"The exposure mode used to create the photo.",
"type":"string"
},
"exposureTime":{
"description":"The length of the exposure, in seconds.",
"format":"float",
"type":"number"
},
"flashUsed":{
"description":"Whether a flash was used to create the photo.",
"type":"boolean"
},
"focalLength":{
"description":"The focal length used to create the photo, in millimeters.",
"format":"float",
"type":"number"
},
"height":{
"description":"The height of the image in pixels.",
"format":"int32",
"type":"integer"
},
"isoSpeed":{
"description":"The ISO speed used to create the photo.",
"format":"int32",
"type":"integer"
},
"lens":{
"description":"The lens used to create the photo.",
"type":"string"
},
"location":{
"description":"Geographic location information stored in the image.",
"properties":{
"altitude":{
"description":"The altitude stored in the image.",
"format":"double",
"type":"number"
},
"latitude":{
"description":"The latitude stored in the image.",
"format":"double",
"type":"number"
},
"longitude":{
"description":"The longitude stored in the image.",
"format":"double",
"type":"number"
}
},
"type":"object"
},
"maxApertureValue":{
"description":"The smallest f-number of the lens at the focal length used to create the photo (APEX value).",
"format":"float",
"type":"number"
},
"meteringMode":{
"description":"The metering mode used to create the photo.",
"type":"string"
},
"rotation":{
"description":"The rotation in clockwise degrees from the image's original orientation.",
"format":"int32",
"type":"integer"
},
"sensor":{
"description":"The type of sensor used to create the photo.",
"type":"string"
},
"subjectDistance":{
"description":"The distance to the subject of the photo, in meters.",
"format":"int32",
"type":"integer"
},
"whiteBalance":{
"description":"The white balance mode used to create the photo.",
"type":"string"
},
"width":{
"description":"The width of the image in pixels.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"indexableText":{
"description":"Indexable text attributes for the file (can only be written)",
"properties":{
"text":{
"description":"The text to be indexed for this file.",
"type":"string"
}
},
"type":"object"
},
"isAppAuthorized":{
"description":"Whether the file was created or opened by the requesting app.",
"type":"boolean"
},
"kind":{
"default":"drive#file",
"description":"The type of file. This is always drive#file.",
"type":"string"
},
"labels":{
"description":"A group of labels for the file.",
"properties":{
"hidden":{
"description":"Deprecated.",
"type":"boolean"
},
"modified":{
"description":"Whether the file has been modified by this user.",
"type":"boolean"
},
"restricted":{
"description":"Whether viewers and commenters are prevented from downloading, printing, and copying this file.",
"type":"boolean"
},
"starred":{
"description":"Whether this file is starred by the 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"
},
"viewed":{
"description":"Whether this file has been viewed by this user.",
"type":"boolean"
}
},
"type":"object"
},
"lastModifyingUser":{
"$ref":"User",
"description":"The last user to modify this file."
},
"lastModifyingUserName":{
"description":"Name of the last user to modify this file.",
"type":"string"
},
"lastViewedByMeDate":{
"description":"Last time this file was viewed by the user (formatted RFC 3339 timestamp).",
"format":"date-time",
"type":"string"
},
"markedViewedByMeDate":{
"description":"Deprecated.",
"format":"date-time",
"type":"string"
},
"md5Checksum":{
"description":"An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.",
"type":"string"
},
"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"
},
"modifiedByMeDate":{
"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.",
"format":"date-time",
"type":"string"
},
"modifiedDate":{
"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.",
"format":"date-time",
"type":"string"
},
"openWithLinks":{
"additionalProperties":{
"type":"string"
},
"description":"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"
},
"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 Drive.",
"type":"string"
},
"ownedByMe":{
"description":"Whether the file is owned by the current user. Not populated for Team Drive files.",
"type":"boolean"
},
"ownerNames":{
"description":"Name(s) of the owner(s) of this file. Not populated for Team Drive files.",
"items":{
"type":"string"
},
"type":"array"
},
"owners":{
"description":"The owner(s) of this file. Not populated for Team Drive files.",
"items":{
"$ref":"User"
},
"type":"array"
},
"parents":{
"description":"Collection of parent folders which contain this file.\nIf not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.",
"items":{
"$ref":"ParentReference"
},
"type":"array"
},
"permissionIds":{
"description":"List of permission IDs for users with access to this file.",
"items":{
"type":"string"
},
"type":"array"
},
"permissions":{
"description":"The list of permissions for users with access to this file. Not populated for Team Drive files.",
"items":{
"$ref":"Permission"
},
"type":"array"
},
"properties":{
"description":"The list of properties.",
"items":{
"$ref":"Property"
},
"type":"array"
},
"quotaBytesUsed":{
"description":"The number of quota bytes used by this file.",
"format":"int64",
"type":"string"
},
"selfLink":{
"description":"A link back to this file.",
"type":"string"
},
"shareable":{
"description":"Deprecated: use capabilities/canShare.",
"type":"boolean"
},
"shared":{
"description":"Whether the file has been shared. Not populated for Team Drive files.",
"type":"boolean"
},
"sharedWithMeDate":{
"description":"Time at which this file was shared with the user (formatted RFC 3339 timestamp).",
"format":"date-time",
"type":"string"
},
"sharingUser":{
"$ref":"User",
"description":"User that shared the item with the current user, if available."
},
"spaces":{
"description":"The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.",
"items":{
"type":"string"
},
"type":"array"
},
"teamDriveId":{
"description":"ID of the Team Drive the file resides in.",
"type":"string"
},
"thumbnail":{
"description":"A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.",
"properties":{
"image":{
"description":"The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.",
"format":"byte",
"type":"string"
},
"mimeType":{
"description":"The MIME type of the thumbnail.",
"type":"string"
}
},
"type":"object"
},
"thumbnailLink":{
"description":"A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.",
"type":"string"
},
"thumbnailVersion":{
"description":"The thumbnail version for use in thumbnail cache invalidation.",
"format":"int64",
"type":"string"
},
"title":{
"description":"The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.",
"type":"string"
},
"trashedDate":{
"description":"The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files.",
"format":"date-time",
"type":"string"
},
"trashingUser":{
"$ref":"User",
"description":"If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files."
},
"userPermission":{
"$ref":"Permission",
"description":"The permissions for the authenticated user on this file."
},
"version":{
"description":"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.",
"format":"int64",
"type":"string"
},
"videoMediaMetadata":{
"description":"Metadata about video media. This will only be present for video types.",
"properties":{
"durationMillis":{
"description":"The duration of the video in milliseconds.",
"format":"int64",
"type":"string"
},
"height":{
"description":"The height of the video in pixels.",
"format":"int32",
"type":"integer"
},
"width":{
"description":"The width of the video in pixels.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"webContentLink":{
"description":"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"
},
"webViewLink":{
"description":"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"
},
"writersCanShare":{
"description":"Whether writers can share the document with other users. Not populated for Team Drive files.",
"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 Team Drives with the \"default,allTeamDrives\" 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 \"teamDrive\".",
"type":"boolean"
},
"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"
},
"kind":{
"default":"drive#fileList",
"description":"This is always drive#fileList.",
"type":"string"
},
"nextLink":{
"description":"A link to the next page of files.",
"type":"string"
},
"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.",
"description":"Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.",
"items":{
"type":"string"
},
"type":"array"
},
"authKey":{
"description":"Deprecated.",
"type":"string"
},
"deleted":{
"description":"Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.",
"type":"boolean"
},
"domain":{
"description":"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"
},
"emailAddress":{
"description":"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"
},
"etag":{
"description":"The ETag of the permission.",
"type":"string"
},
"expirationDate":{
"description":"The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: \n- They can only be set on user and group permissions \n- The date must be in the future \n- The date cannot be more than a year in the future \n- The date can only be set on drive.permissions.update or drive.permissions.patch requests",
"format":"date-time",
"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"
},
"kind":{
"default":"drive#permission",
"description":"This is always drive#permission.",
"type":"string"
},
"name":{
"description":"The name for this permission.",
"type":"string"
},
"photoLink":{
"description":"A link to the profile photo, if available.",
"type":"string"
},
"role":{
"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: \n- organizer \n- owner \n- reader \n- writer",
"type":"string"
},
"selfLink":{
"description":"A link back to this permission.",
"type":"string"
},
"teamDrivePermissionDetails":{
"description":"Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items.",
"items":{
"properties":{
"additionalRoles":{
"description":"Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.",
"items":{
"type":"string"
},
"type":"array"
},
"inherited":{
"description":"Whether this permission is inherited. This field is always populated. This is an output-only field.",
"type":"boolean"
},
"inheritedFrom":{
"description":"The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive.",
"type":"string"
},
"role":{
"description":"The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- reader \n- writer",
"type":"string"
},
"teamDrivePermissionType":{
"description":"The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member",
"type":"string"
}
},
"type":"object"
},
"type":"array"
},
"type":{
"annotations":{
"required":[
"drive.permissions.insert"
]
},
"description":"The account type. Allowed values are: \n- user \n- group \n- domain \n- anyone",
"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"
},
"withLink":{
"description":"Whether the link is required for this permission.",
"description":"A list of permissions associated with a file.",
"id":"PermissionList",
"properties":{
"etag":{
"description":"The ETag of the list.",
"type":"string"
},
"items":{
"description":"The list of permissions.",
"items":{
"$ref":"Permission"
},
"type":"array"
},
"kind":{
"default":"drive#permissionList",
"description":"This is always drive#permissionList.",
"type":"string"
},
"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.",
"description":"A key-value pair attached to a file that is either public or private to an application.\nThe following limits apply to file properties: \n- Maximum of 100 properties total per file\n- Maximum of 30 private properties per app\n- Maximum of 30 public properties\n- Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.",
"description":"Short term download URL for the file. This will only be populated on files with content stored in Drive.",
"type":"string"
},
"etag":{
"description":"The ETag of the revision.",
"type":"string"
},
"exportLinks":{
"additionalProperties":{
"description":"A mapping from export format to URL",
"type":"string"
},
"description":"Links for exporting Google Docs to specific formats.",
"type":"object"
},
"fileSize":{
"description":"The size of the revision in bytes. This will only be populated on files with content stored in Drive.",
"format":"int64",
"type":"string"
},
"id":{
"description":"The ID of the revision.",
"type":"string"
},
"kind":{
"default":"drive#revision",
"description":"This is always drive#revision.",
"type":"string"
},
"lastModifyingUser":{
"$ref":"User",
"description":"The last user to modify this revision."
},
"lastModifyingUserName":{
"description":"Name of the last user to modify this revision.",
"type":"string"
},
"md5Checksum":{
"description":"An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.",
"type":"string"
},
"mimeType":{
"description":"The MIME type of the revision.",
"type":"string"
},
"modifiedDate":{
"description":"Last time this revision was modified (formatted RFC 3339 timestamp).",
"format":"date-time",
"type":"string"
},
"originalFilename":{
"description":"The original filename when this revision was created. 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. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.",
"type":"boolean"
},
"publishAuto":{
"description":"Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.",
"type":"boolean"
},
"published":{
"description":"Whether this revision is published. This is only populated and can only be modified for Google Docs.",
"type":"boolean"
},
"publishedLink":{
"description":"A link to the published revision.",
"type":"string"
},
"publishedOutsideDomain":{
"description":"Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.",
"description":"The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.",
"items":{
"$ref":"Revision"
},
"type":"array"
},
"kind":{
"default":"drive#revisionList",
"description":"This is always drive#revisionList.",
"type":"string"
},
"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.",
"description":"An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.",
"properties":{
"id":{
"description":"The ID of an image file in 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.",
"format":"float",
"type":"number"
},
"xCoordinate":{
"description":"The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.",
"format":"float",
"type":"number"
},
"yCoordinate":{
"description":"The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.",
"format":"float",
"type":"number"
}
},
"type":"object"
},
"backgroundImageLink":{
"description":"A short-lived link to this Team Drive's background image.",
"type":"string"
},
"capabilities":{
"description":"Capabilities the current user has on this Team Drive.",
"properties":{
"canAddChildren":{
"description":"Whether the current user can add children to folders in this Team Drive.",
"type":"boolean"
},
"canChangeTeamDriveBackground":{
"description":"Whether the current user can change the background of this Team Drive.",
"type":"boolean"
},
"canComment":{
"description":"Whether the current user can comment on files 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"
},
"canDownload":{
"description":"Whether the current user can download files in this Team Drive.",
"type":"boolean"
},
"canEdit":{
"description":"Whether the current user can edit files in this Team Drive",
"type":"boolean"
},
"canListChildren":{
"description":"Whether the current user can list the children of folders in this Team Drive.",
"type":"boolean"
},
"canManageMembers":{
"description":"Whether the current user can add members to this Team Drive or remove them or change their role.",
"type":"boolean"
},
"canReadRevisions":{
"description":"Whether the current user can read the revisions resource of files in this Team Drive.",
"type":"boolean"
},
"canRemoveChildren":{
"description":"Whether the current user can remove children from folders in this Team Drive.",
"type":"boolean"
},
"canRename":{
"description":"Whether the current user can rename files or folders in this Team Drive.",
"type":"boolean"
},
"canRenameTeamDrive":{
"description":"Whether the current user can rename this Team Drive.",
"type":"boolean"
},
"canShare":{
"description":"Whether the current user can share files or folders in this Team Drive.",
"type":"boolean"
}
},
"type":"object"
},
"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"
},
"createdDate":{
"description":"The time at which the Team Drive was created (RFC 3339 date-time).",
"format":"date-time",
"type":"string"
},
"id":{
"description":"The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.",
"type":"string"
},
"kind":{
"default":"drive#teamDrive",
"description":"This is always drive#teamDrive",
"type":"string"
},
"name":{
"annotations":{
"required":[
"drive.teamdrives.insert"
]
},
"description":"The name of this Team Drive.",
"type":"string"
},
"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.",
