Files
google-apis-rs/google_drive2_cli/about_get/index.html
2022-03-08 15:36:16 +08:00

675 lines
20 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Get - drive v3.0.0+20220225</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> drive v3.0.0+20220225</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>About</span>
<li class="toctree-l1 current">
<a class="current" href=".">Get</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<span>Apps</span>
<li class="toctree-l1 ">
<a class="" href="../apps_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../apps_list">List</a>
</li>
<span>Changes</span>
<li class="toctree-l1 ">
<a class="" href="../changes_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../changes_get-start-page-token">Get Start Page Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../changes_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../changes_watch">Watch</a>
</li>
<span>Channels</span>
<li class="toctree-l1 ">
<a class="" href="../channels_stop">Stop</a>
</li>
<span>Children</span>
<li class="toctree-l1 ">
<a class="" href="../children_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../children_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../children_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../children_list">List</a>
</li>
<span>Comments</span>
<li class="toctree-l1 ">
<a class="" href="../comments_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_update">Update</a>
</li>
<span>Drives</span>
<li class="toctree-l1 ">
<a class="" href="../drives_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_hide">Hide</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_unhide">Unhide</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_update">Update</a>
</li>
<span>Files</span>
<li class="toctree-l1 ">
<a class="" href="../files_copy">Copy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_empty-trash">Empty Trash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_export">Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_generate-ids">Generate Ids</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_touch">Touch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_trash">Trash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_untrash">Untrash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_update">Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_watch">Watch</a>
</li>
<span>Parents</span>
<li class="toctree-l1 ">
<a class="" href="../parents_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../parents_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../parents_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../parents_list">List</a>
</li>
<span>Permissions</span>
<li class="toctree-l1 ">
<a class="" href="../permissions_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_get-id-for-email">Get Id For Email</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_update">Update</a>
</li>
<span>Properties</span>
<li class="toctree-l1 ">
<a class="" href="../properties_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_update">Update</a>
</li>
<span>Replies</span>
<li class="toctree-l1 ">
<a class="" href="../replies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_update">Update</a>
</li>
<span>Revisions</span>
<li class="toctree-l1 ">
<a class="" href="../revisions_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_update">Update</a>
</li>
<span>Teamdrives</span>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_update">Update</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Gets the information about the current user along with Drive API settings</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>drive2 --scope &lt;scope&gt; about get ...</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 include-subscribed=boolean</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p max-change-id-count=string</strong></p>
<ul>
<li>Maximum number of remaining change IDs to count</li>
</ul>
</li>
<li>
<p><strong>-p start-change-id=string</strong></p>
<ul>
<li>Change ID to start counting from when calculating number of remaining change IDs</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 alt=string</strong></p>
<ul>
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../apps_get" class="btn btn-neutral float-right" title="Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../apps_get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>