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. Note: This method returns all files by default, including trashed files. If you don't want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

If unset, the scope for this method defaults to https://www.googleapis.com/auth/drive.metadata.readonly. You can set the scope for this method like this: drive3 --scope <scope> files list ...

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p corpora=string

    • Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.

  • -p corpus=string

    • Deprecated: The source of files to list. Use 'corpora' instead.

  • -p drive-id=string

    • ID of the shared drive to search.

  • -p include-items-from-all-drives=boolean

    • Whether both My Drive and shared drive items should be included in results.

  • -p include-labels=string

    • A comma-separated list of IDs of labels to include in the labelInfo part of the response.

  • -p include-permissions-for-view=string

    • Specifies which additional view's permissions to include in the response. Only 'published' is supported.

  • -p include-team-drive-items=boolean

    • Deprecated: Use includeItemsFromAllDrives instead.

  • -p order-by=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 can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.

  • -p page-size=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.

  • -p page-token=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.

  • -p q=string

    • A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.

  • -p spaces=string

    • A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.

  • -p supports-all-drives=boolean

    • Whether the requesting application supports both My Drives and shared drives.

  • -p supports-team-drives=boolean

    • Deprecated: Use supportsAllDrives instead.

  • -p team-drive-id=string

    • Deprecated: Use driveId instead.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").