Lists the user's files.
This method accepts the q
parameter, which is a search query combining one or more search terms. For more information, see the Search for files & folders guide.
HTTP request
GET https://www.googleapis.com/drive/v2/files
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters | |
---|---|
corpora |
Bodies of items (files/documents) to which the query applies. Supported bodies are |
corpus |
Deprecated: The body of items (files/documents) to which the query applies. Use |
driveId |
ID of the shared drive to search. |
includeItemsFromAllDrives |
Whether both My Drive and shared drive items should be included in results. |
includeTeamDriveItems |
Deprecated: Use |
maxResults |
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. |
orderBy |
A comma-separated list of sort keys. Valid keys are:
Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: Note that there's a current limitation for users with approximately one million files in which the requested sort order is ignored. |
pageToken |
Page token for files. |
projection |
Deprecated: This parameter has no function. |
q |
Query string for searching files. |
spaces |
A comma-separated list of spaces to query. Supported values are |
supportsAllDrives |
Whether the requesting application supports both My Drives and shared drives. |
supportsTeamDrives |
Deprecated: Use |
teamDriveId |
Deprecated: Use |
includePermissionsForView |
Specifies which additional view's permissions to include in the response. Only |
includeLabels |
A comma-separated list of IDs of labels to include in the |
Request body
The request body must be empty.
Response body
A list of files.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"nextPageToken": string,
"kind": string,
"etag": string,
"selfLink": string,
"incompleteSearch": boolean,
"nextLink": string,
"items": [
{
object ( |
Fields | |
---|---|
nextPageToken |
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. |
kind |
This is always |
etag |
The ETag of the list. |
selfLink |
A link back to this list. |
incompleteSearch |
Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive". |
nextLink |
A link to the next page of files. |
items[] |
The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.apps.readonly
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.meet.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.
Corpus
Enums | |
---|---|
DEFAULT |
The items that the user has accessed. |
DOMAIN |
Items shared to the user's domain. |