mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
330 lines
15 KiB
HTML
330 lines
15 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-sheets4-cli/spreadsheets_values-append/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Values Append - Sheets v5.0.4+20240229</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 = "Values Append";
|
|
var mkdocs_page_input_path = "spreadsheets_values-append.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-sheets4-cli/spreadsheets_values-append/";
|
|
</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"> Sheets v5.0.4+20240229
|
|
</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">Spreadsheets</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_batch-update/">Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_developer-metadata-get/">Developer Metadata Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_developer-metadata-search/">Developer Metadata Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_get-by-data-filter/">Get By Data Filter</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_sheets-copy-to/">Sheets Copy To</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Values Append</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-clear/">Values Batch Clear</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-clear-by-data-filter/">Values Batch Clear By Data Filter</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-get/">Values Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-get-by-data-filter/">Values Batch Get By Data Filter</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-update/">Values Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-batch-update-by-data-filter/">Values Batch Update By Data Filter</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-clear/">Values Clear</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-get/">Values Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spreadsheets_values-update/">Values 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="..">Sheets v5.0.4+20240229</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>Spreadsheets »</li>
|
|
<li>Values Append</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/sheets4-cli/edit/master/docs/spreadsheets_values-append.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>Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the <a href="/sheets/api/guides/values#appending_values">guide</a> and <a href="/sheets/api/samples/writing#append_values">sample code</a> for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The <code>valueInputOption</code> only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.</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.file</em></li>
|
|
<li><em>https://www.googleapis.com/auth/spreadsheets</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/drive</em>.
|
|
You can set the scope for this method like this: <code>sheets4 --scope <scope> spreadsheets values-append ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><spreadsheet-id></strong> <em>(string)</em><ul>
|
|
<li>The ID of the spreadsheet to update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><range></strong> <em>(string)</em><ul>
|
|
<li>The <a href="/sheets/api/guides/concepts#cell">A1 notation</a> of a range to search for a logical table of data. Values are appended after the last row of the table.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<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>ValueRange:
|
|
major-dimension: string
|
|
range: 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 . major-dimension=aliquyam</code><ul>
|
|
<li>The major dimension of the values. For output, if the spreadsheet data is: <code>A1=1,B1=2,A2=3,B2=4</code>, then requesting <code>range=A1:B2,majorDimension=ROWS</code> will return <code>[[1,2],[3,4]]</code>, whereas requesting <code>range=A1:B2,majorDimension=COLUMNS</code> will return <code>[[1,3],[2,4]]</code>. For input, with <code>range=A1:B2,majorDimension=ROWS</code> then <code>[[1,2],[3,4]]</code> will set <code>A1=1,B1=2,A2=3,B2=4</code>. With <code>range=A1:B2,majorDimension=COLUMNS</code> then <code>[[1,2],[3,4]]</code> will set <code>A1=1,B1=3,A2=2,B2=4</code>. When writing, if this field is not set, it defaults to ROWS.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>range=amet</code><ul>
|
|
<li>The range the values cover, in <a href="/sheets/api/guides/concepts#cell">A1 notation</a>. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.</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-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-values-in-response=boolean</strong></p>
|
|
<ul>
|
|
<li>Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p insert-data-option=string</strong></p>
|
|
<ul>
|
|
<li>How the input data should be inserted.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p response-date-time-render-option=string</strong></p>
|
|
<ul>
|
|
<li>Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p response-value-render-option=string</strong></p>
|
|
<ul>
|
|
<li>Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p value-input-option=string</strong></p>
|
|
<ul>
|
|
<li>How the input data should be interpreted.</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="../spreadsheets_sheets-copy-to/" class="btn btn-neutral float-left" title="Sheets Copy To"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../spreadsheets_values-batch-clear/" class="btn btn-neutral float-right" title="Values Batch Clear">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/sheets4-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../spreadsheets_sheets-copy-to/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../spreadsheets_values-batch-clear/" 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>
|