mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
451 lines
19 KiB
HTML
451 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-drive3-cli/files_list/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>List - drive v5.0.4+20240227</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "List";
|
|
var mkdocs_page_input_path = "files_list.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-drive3-cli/files_list/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> drive v5.0.4+20240227
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">About</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../about_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Apps</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../apps_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Changes</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../changes_get-start-page-token/">Get Start Page Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../changes_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../changes_watch/">Watch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Channels</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../channels_stop/">Stop</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Comments</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../comments_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../comments_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../comments_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../comments_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../comments_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Drives</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_hide/">Hide</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_unhide/">Unhide</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../drives_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Files</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_copy/">Copy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_empty-trash/">Empty Trash</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_export/">Export</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_generate-ids/">Generate Ids</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">List</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_list-labels/">List Labels</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_modify-labels/">Modify Labels</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_update/">Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../files_watch/">Watch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Permissions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Replies</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../replies_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../replies_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../replies_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../replies_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../replies_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Revisions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../revisions_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../revisions_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../revisions_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../revisions_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Teamdrives</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">drive v5.0.4+20240227</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Files »</li>
|
|
<li>List</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive3-cli/edit/master/docs/files_list.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Lists the user's files. This method accepts the <code>q</code> parameter, which is a search query combining one or more search terms. For more information, see the <a href="/drive/api/guides/search-files">Search for files & folders</a> guide. <em>Note:</em> This method returns <em>all</em> files by default, including trashed files. If you don't want trashed files to appear in the list, use the <code>trashed=false</code> query parameter to remove trashed files from the results.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/drive</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.appdata</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.file</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.metadata</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.metadata.readonly</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.photos.readonly</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.readonly</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/drive.metadata.readonly</em>.
|
|
You can set the scope for this method like this: <code>drive3 --scope <scope> files list ...</code></p>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p corpora=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p corpus=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated: The source of files to list. Use 'corpora' instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p drive-id=string</strong></p>
|
|
<ul>
|
|
<li>ID of the shared drive to search.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p include-items-from-all-drives=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether both My Drive and shared drive items should be included in results.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p include-labels=string</strong></p>
|
|
<ul>
|
|
<li>A comma-separated list of IDs of labels to include in the <code>labelInfo</code> part of the response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p include-permissions-for-view=string</strong></p>
|
|
<ul>
|
|
<li>Specifies which additional view's permissions to include in the response. Only 'published' is supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p include-team-drive-items=boolean</strong></p>
|
|
<ul>
|
|
<li>Deprecated: Use <code>includeItemsFromAllDrives</code> instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p order-by=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-size=integer</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-token=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p q=string</strong></p>
|
|
<ul>
|
|
<li>A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p spaces=string</strong></p>
|
|
<ul>
|
|
<li>A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p supports-all-drives=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether the requesting application supports both My Drives and shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p supports-team-drives=boolean</strong></p>
|
|
<ul>
|
|
<li>Deprecated: Use <code>supportsAllDrives</code> instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p team-drive-id=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated: Use <code>driveId</code> instead.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../files_get/" class="btn btn-neutral float-left" title="Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../files_list-labels/" class="btn btn-neutral float-right" title="List Labels">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../files_get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../files_list-labels/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|