OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_docs1_cli/documents_create/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

488 lines
16 KiB
HTML
Raw Blame History

<!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>Create - Docs v3.0.0+20220301</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"> Docs v3.0.0+20220301</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Documents</span>
<li class="toctree-l1 ">
<a class="" href="../documents_batch-update">Batch Update</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Create</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../documents_get">Get</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>Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/docs1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.</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/documents</em></li>
<li><em>https://www.googleapis.com/auth/drive</em></li>
<li><em>https://www.googleapis.com/auth/drive.file</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/documents</em>.
You can set the scope for this method like this: <code>docs1 --scope &lt;scope&gt; documents create ...</code></p>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>Document:
document-id: string
document-style:
background:
color:
color:
rgb-color:
blue: number
green: number
red: number
default-footer-id: string
default-header-id: string
even-page-footer-id: string
even-page-header-id: string
first-page-footer-id: string
first-page-header-id: string
margin-bottom:
magnitude: number
unit: string
margin-footer:
magnitude: number
unit: string
margin-header:
magnitude: number
unit: string
margin-left:
magnitude: number
unit: string
margin-right:
magnitude: number
unit: string
margin-top:
magnitude: number
unit: string
page-number-start: integer
page-size:
height:
magnitude: number
unit: string
width:
magnitude: number
unit: string
use-custom-header-footer-margins: boolean
use-even-page-header-footer: boolean
use-first-page-header-footer: boolean
revision-id: string
suggestions-view-mode: string
title: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . document-id=no</code><ul>
<li>Output only. The ID of the document.</li>
</ul>
</li>
<li><code>document-style.background.color.color.rgb-color blue=0.36584835924937553</code><ul>
<li>The blue component of the color, from 0.0 to 1.0.</li>
</ul>
</li>
<li><code>green=0.5857873539022715</code><ul>
<li>The green component of the color, from 0.0 to 1.0.</li>
</ul>
</li>
<li>
<p><code>red=0.16568728368878083</code></p>
<ul>
<li>The red component of the color, from 0.0 to 1.0.</li>
</ul>
</li>
<li>
<p><code>..... default-footer-id=takimata</code></p>
<ul>
<li>The ID of the default footer. If not set, there is no default footer. This property is read-only.</li>
</ul>
</li>
<li><code>default-header-id=amet.</code><ul>
<li>The ID of the default header. If not set, there is no default header. This property is read-only.</li>
</ul>
</li>
<li><code>even-page-footer-id=duo</code><ul>
<li>The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there is no even page footer. This property is read-only.</li>
</ul>
</li>
<li><code>even-page-header-id=ipsum</code><ul>
<li>The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there is no even page header. This property is read-only.</li>
</ul>
</li>
<li><code>first-page-footer-id=gubergren</code><ul>
<li>The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. This property is read-only.</li>
</ul>
</li>
<li><code>first-page-header-id=lorem</code><ul>
<li>The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there is no first page header. This property is read-only.</li>
</ul>
</li>
<li><code>margin-bottom magnitude=0.9922470725858205</code><ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=eos</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..margin-footer magnitude=0.7615363125225725</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=ipsum</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..margin-header magnitude=0.1092883976212714</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=duo</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..margin-left magnitude=0.39873905405496446</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=sed</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..margin-right magnitude=0.5053930334687853</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=rebum.</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..margin-top magnitude=0.34810194289930996</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=ipsum</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>.. page-number-start=51</code></p>
<ul>
<li>The page number from which to start counting the number of pages.</li>
</ul>
</li>
<li><code>page-size.height magnitude=0.8016125465746553</code><ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=gubergren</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>..width magnitude=0.6637488828437452</code></p>
<ul>
<li>The magnitude.</li>
</ul>
</li>
<li>
<p><code>unit=lorem</code></p>
<ul>
<li>The units for magnitude.</li>
</ul>
</li>
<li>
<p><code>... use-custom-header-footer-margins=false</code></p>
<ul>
<li>Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.</li>
</ul>
</li>
<li><code>use-even-page-header-footer=true</code><ul>
<li>Indicates whether to use the even page header / footer IDs for the even pages.</li>
</ul>
</li>
<li>
<p><code>use-first-page-header-footer=false</code></p>
<ul>
<li>Indicates whether to use the first page header / footer IDs for the first page.</li>
</ul>
</li>
<li>
<p><code>.. revision-id=sed</code></p>
<ul>
<li>Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes.</li>
</ul>
</li>
<li><code>suggestions-view-mode=no</code><ul>
<li>Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.</li>
</ul>
</li>
<li><code>title=stet</code><ul>
<li>The title of the document.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<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-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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../documents_get" class="btn btn-neutral float-right" title="Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../documents_batch-update" class="btn btn-neutral" title="Batch Update"><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="../documents_batch-update" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../documents_get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink