OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-30 13:54:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_sheets4/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

275 lines
95 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_sheets4`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_sheets4::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_sheets4/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_sheets4</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_sheets4</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_sheets4/api.rs.html#1-10956" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.AddBandingRequest.html" title="google_sheets4::api::AddBandingRequest struct">AddBandingRequest</a></td><td class="docblock-short"><p>Adds a new banded range to the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddBandingResponse.html" title="google_sheets4::api::AddBandingResponse struct">AddBandingResponse</a></td><td class="docblock-short"><p>The result of adding a banded range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddChartRequest.html" title="google_sheets4::api::AddChartRequest struct">AddChartRequest</a></td><td class="docblock-short"><p>Adds a chart to a sheet in the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddChartResponse.html" title="google_sheets4::api::AddChartResponse struct">AddChartResponse</a></td><td class="docblock-short"><p>The result of adding a chart to a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddConditionalFormatRuleRequest.html" title="google_sheets4::api::AddConditionalFormatRuleRequest struct">AddConditionalFormatRuleRequest</a></td><td class="docblock-short"><p>Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddDataSourceRequest.html" title="google_sheets4::api::AddDataSourceRequest struct">AddDataSourceRequest</a></td><td class="docblock-short"><p>Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional <code>bigquery.readonly</code> OAuth scope.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddDataSourceResponse.html" title="google_sheets4::api::AddDataSourceResponse struct">AddDataSourceResponse</a></td><td class="docblock-short"><p>The result of adding a data source.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddDimensionGroupRequest.html" title="google_sheets4::api::AddDimensionGroupRequest struct">AddDimensionGroupRequest</a></td><td class="docblock-short"><p>Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddDimensionGroupResponse.html" title="google_sheets4::api::AddDimensionGroupResponse struct">AddDimensionGroupResponse</a></td><td class="docblock-short"><p>The result of adding a group.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddFilterViewRequest.html" title="google_sheets4::api::AddFilterViewRequest struct">AddFilterViewRequest</a></td><td class="docblock-short"><p>Adds a filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddFilterViewResponse.html" title="google_sheets4::api::AddFilterViewResponse struct">AddFilterViewResponse</a></td><td class="docblock-short"><p>The result of adding a filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddNamedRangeRequest.html" title="google_sheets4::api::AddNamedRangeRequest struct">AddNamedRangeRequest</a></td><td class="docblock-short"><p>Adds a named range to the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddNamedRangeResponse.html" title="google_sheets4::api::AddNamedRangeResponse struct">AddNamedRangeResponse</a></td><td class="docblock-short"><p>The result of adding a named range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddProtectedRangeRequest.html" title="google_sheets4::api::AddProtectedRangeRequest struct">AddProtectedRangeRequest</a></td><td class="docblock-short"><p>Adds a new protected range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddProtectedRangeResponse.html" title="google_sheets4::api::AddProtectedRangeResponse struct">AddProtectedRangeResponse</a></td><td class="docblock-short"><p>The result of adding a new protected range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddSheetRequest.html" title="google_sheets4::api::AddSheetRequest struct">AddSheetRequest</a></td><td class="docblock-short"><p>Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddSheetResponse.html" title="google_sheets4::api::AddSheetResponse struct">AddSheetResponse</a></td><td class="docblock-short"><p>The result of adding a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddSlicerRequest.html" title="google_sheets4::api::AddSlicerRequest struct">AddSlicerRequest</a></td><td class="docblock-short"><p>Adds a slicer to a sheet in the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddSlicerResponse.html" title="google_sheets4::api::AddSlicerResponse struct">AddSlicerResponse</a></td><td class="docblock-short"><p>The result of adding a slicer to a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppendCellsRequest.html" title="google_sheets4::api::AppendCellsRequest struct">AppendCellsRequest</a></td><td class="docblock-short"><p>Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppendDimensionRequest.html" title="google_sheets4::api::AppendDimensionRequest struct">AppendDimensionRequest</a></td><td class="docblock-short"><p>Appends rows or columns to the end of a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppendValuesResponse.html" title="google_sheets4::api::AppendValuesResponse struct">AppendValuesResponse</a></td><td class="docblock-short"><p>The response when updating a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AutoFillRequest.html" title="google_sheets4::api::AutoFillRequest struct">AutoFillRequest</a></td><td class="docblock-short"><p>Fills in more data based on existing data.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AutoResizeDimensionsRequest.html" title="google_sheets4::api::AutoResizeDimensionsRequest struct">AutoResizeDimensionsRequest</a></td><td class="docblock-short"><p>Automatically resizes one or more dimensions based on the contents of the cells in that dimension.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BandedRange.html" title="google_sheets4::api::BandedRange struct">BandedRange</a></td><td class="docblock-short"><p>A banded (alternating colors) range in a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BandingProperties.html" title="google_sheets4::api::BandingProperties struct">BandingProperties</a></td><td class="docblock-short"><p>Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BaselineValueFormat.html" title="google_sheets4::api::BaselineValueFormat struct">BaselineValueFormat</a></td><td class="docblock-short"><p>Formatting options for baseline value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicChartAxis.html" title="google_sheets4::api::BasicChartAxis struct">BasicChartAxis</a></td><td class="docblock-short"><p>An axis of the chart. A chart may not have more than one axis per axis position.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicChartDomain.html" title="google_sheets4::api::BasicChartDomain struct">BasicChartDomain</a></td><td class="docblock-short"><p>The domain of a chart. For example, if charting stock prices over time, this would be the date.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicChartSeries.html" title="google_sheets4::api::BasicChartSeries struct">BasicChartSeries</a></td><td class="docblock-short"><p>A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the &quot;Open Price&quot;, &quot;High Price&quot;, &quot;Low Price&quot; and &quot;Close Price&quot;.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicChartSpec.html" title="google_sheets4::api::BasicChartSpec struct">BasicChartSpec</a></td><td class="docblock-short"><p>The specification for a basic chart. See BasicChartType for the list of charts this supports.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicFilter.html" title="google_sheets4::api::BasicFilter struct">BasicFilter</a></td><td class="docblock-short"><p>The default filter associated with a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicSeriesDataPointStyleOverride.html" title="google_sheets4::api::BasicSeriesDataPointStyleOverride struct">BasicSeriesDataPointStyleOverride</a></td><td class="docblock-short"><p>Style override settings for a single series data point.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchClearValuesByDataFilterRequest.html" title="google_sheets4::api::BatchClearValuesByDataFilterRequest struct">BatchClearValuesByDataFilterRequest</a></td><td class="docblock-short"><p>The request for clearing more than one range selected by a DataFilter in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchClearValuesByDataFilterResponse.html" title="google_sheets4::api::BatchClearValuesByDataFilterResponse struct">BatchClearValuesByDataFilterResponse</a></td><td class="docblock-short"><p>The response when clearing a range of values selected with DataFilters in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchClearValuesRequest.html" title="google_sheets4::api::BatchClearValuesRequest struct">BatchClearValuesRequest</a></td><td class="docblock-short"><p>The request for clearing more than one range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchClearValuesResponse.html" title="google_sheets4::api::BatchClearValuesResponse struct">BatchClearValuesResponse</a></td><td class="docblock-short"><p>The response when clearing a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchGetValuesByDataFilterRequest.html" title="google_sheets4::api::BatchGetValuesByDataFilterRequest struct">BatchGetValuesByDataFilterRequest</a></td><td class="docblock-short"><p>The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchGetValuesByDataFilterResponse.html" title="google_sheets4::api::BatchGetValuesByDataFilterResponse struct">BatchGetValuesByDataFilterResponse</a></td><td class="docblock-short"><p>The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchGetValuesResponse.html" title="google_sheets4::api::BatchGetValuesResponse struct">BatchGetValuesResponse</a></td><td class="docblock-short"><p>The response when retrieving more than one range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateSpreadsheetRequest.html" title="google_sheets4::api::BatchUpdateSpreadsheetRequest struct">BatchUpdateSpreadsheetRequest</a></td><td class="docblock-short"><p>The request for updating any aspect of a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateSpreadsheetResponse.html" title="google_sheets4::api::BatchUpdateSpreadsheetResponse struct">BatchUpdateSpreadsheetResponse</a></td><td class="docblock-short"><p>The reply for batch updating a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateValuesByDataFilterRequest.html" title="google_sheets4::api::BatchUpdateValuesByDataFilterRequest struct">BatchUpdateValuesByDataFilterRequest</a></td><td class="docblock-short"><p>The request for updating more than one range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateValuesByDataFilterResponse.html" title="google_sheets4::api::BatchUpdateValuesByDataFilterResponse struct">BatchUpdateValuesByDataFilterResponse</a></td><td class="docblock-short"><p>The response when updating a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateValuesRequest.html" title="google_sheets4::api::BatchUpdateValuesRequest struct">BatchUpdateValuesRequest</a></td><td class="docblock-short"><p>The request for updating more than one range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchUpdateValuesResponse.html" title="google_sheets4::api::BatchUpdateValuesResponse struct">BatchUpdateValuesResponse</a></td><td class="docblock-short"><p>The response when updating a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BigQueryDataSourceSpec.html" title="google_sheets4::api::BigQueryDataSourceSpec struct">BigQueryDataSourceSpec</a></td><td class="docblock-short"><p>The specification of a BigQuery data source that's connected to a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BigQueryQuerySpec.html" title="google_sheets4::api::BigQueryQuerySpec struct">BigQueryQuerySpec</a></td><td class="docblock-short"><p>Specifies a custom BigQuery query.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BigQueryTableSpec.html" title="google_sheets4::api::BigQueryTableSpec struct">BigQueryTableSpec</a></td><td class="docblock-short"><p>Specifies a BigQuery table definition. Only <a href="https://cloud.google.com/bigquery/docs/tables-intro">native tables</a> is allowed.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BooleanCondition.html" title="google_sheets4::api::BooleanCondition struct">BooleanCondition</a></td><td class="docblock-short"><p>A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BooleanRule.html" title="google_sheets4::api::BooleanRule struct">BooleanRule</a></td><td class="docblock-short"><p>A rule that may or may not match, depending on the condition.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Border.html" title="google_sheets4::api::Border struct">Border</a></td><td class="docblock-short"><p>A border along a cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Borders.html" title="google_sheets4::api::Borders struct">Borders</a></td><td class="docblock-short"><p>The borders of the cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BubbleChartSpec.html" title="google_sheets4::api::BubbleChartSpec struct">BubbleChartSpec</a></td><td class="docblock-short"><p>A bubble chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CandlestickChartSpec.html" title="google_sheets4::api::CandlestickChartSpec struct">CandlestickChartSpec</a></td><td class="docblock-short"><p>A candlestick chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CandlestickData.html" title="google_sheets4::api::CandlestickData struct">CandlestickData</a></td><td class="docblock-short"><p>The Candlestick chart data, each containing the low, open, close, and high values for a series.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CandlestickDomain.html" title="google_sheets4::api::CandlestickDomain struct">CandlestickDomain</a></td><td class="docblock-short"><p>The domain of a CandlestickChart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CandlestickSeries.html" title="google_sheets4::api::CandlestickSeries struct">CandlestickSeries</a></td><td class="docblock-short"><p>The series of a CandlestickData.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CellData.html" title="google_sheets4::api::CellData struct">CellData</a></td><td class="docblock-short"><p>Data about a specific cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CellFormat.html" title="google_sheets4::api::CellFormat struct">CellFormat</a></td><td class="docblock-short"><p>The format of a cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartAxisViewWindowOptions.html" title="google_sheets4::api::ChartAxisViewWindowOptions struct">ChartAxisViewWindowOptions</a></td><td class="docblock-short"><p>The options that define a &quot;view window&quot; for a chart (such as the visible values in an axis).</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartCustomNumberFormatOptions.html" title="google_sheets4::api::ChartCustomNumberFormatOptions struct">ChartCustomNumberFormatOptions</a></td><td class="docblock-short"><p>Custom number formatting options for chart attributes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartData.html" title="google_sheets4::api::ChartData struct">ChartData</a></td><td class="docblock-short"><p>The data included in a domain or series.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartDateTimeRule.html" title="google_sheets4::api::ChartDateTimeRule struct">ChartDateTimeRule</a></td><td class="docblock-short"><p>Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartGroupRule.html" title="google_sheets4::api::ChartGroupRule struct">ChartGroupRule</a></td><td class="docblock-short"><p>An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartHistogramRule.html" title="google_sheets4::api::ChartHistogramRule struct">ChartHistogramRule</a></td><td class="docblock-short"><p>Allows you to organize numeric values in a source data column into buckets of constant size.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartSourceRange.html" title="google_sheets4::api::ChartSourceRange struct">ChartSourceRange</a></td><td class="docblock-short"><p>Source ranges for a chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChartSpec.html" title="google_sheets4::api::ChartSpec struct">ChartSpec</a></td><td class="docblock-short"><p>The specifications of a chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ClearBasicFilterRequest.html" title="google_sheets4::api::ClearBasicFilterRequest struct">ClearBasicFilterRequest</a></td><td class="docblock-short"><p>Clears the basic filter, if any exists on the sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ClearValuesRequest.html" title="google_sheets4::api::ClearValuesRequest struct">ClearValuesRequest</a></td><td class="docblock-short"><p>The request for clearing a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ClearValuesResponse.html" title="google_sheets4::api::ClearValuesResponse struct">ClearValuesResponse</a></td><td class="docblock-short"><p>The response when clearing a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Color.html" title="google_sheets4::api::Color struct">Color</a></td><td class="docblock-short"><p>Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of <code>java.awt.Color</code> in Java; it can also be trivially provided to UIColor's <code>+colorWithRed:green:blue:alpha</code> method in iOS; and, with just a little work, it can be easily formatted into a CSS <code>rgba()</code> string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&amp;red green:&amp;green blue:&amp;blue alpha:&amp;alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha &lt;= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red &lt;&lt; 16) | (green &lt;&lt; 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i &lt; missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ColorStyle.html" title="google_sheets4::api::ColorStyle struct">ColorStyle</a></td><td class="docblock-short"><p>A color value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ConditionValue.html" title="google_sheets4::api::ConditionValue struct">ConditionValue</a></td><td class="docblock-short"><p>The value of the condition.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ConditionalFormatRule.html" title="google_sheets4::api::ConditionalFormatRule struct">ConditionalFormatRule</a></td><td class="docblock-short"><p>A rule describing a conditional format.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CopyPasteRequest.html" title="google_sheets4::api::CopyPasteRequest struct">CopyPasteRequest</a></td><td class="docblock-short"><p>Copies data from the source to the destination.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CopySheetToAnotherSpreadsheetRequest.html" title="google_sheets4::api::CopySheetToAnotherSpreadsheetRequest struct">CopySheetToAnotherSpreadsheetRequest</a></td><td class="docblock-short"><p>The request to copy a sheet across spreadsheets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CreateDeveloperMetadataRequest.html" title="google_sheets4::api::CreateDeveloperMetadataRequest struct">CreateDeveloperMetadataRequest</a></td><td class="docblock-short"><p>A request to create developer metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CreateDeveloperMetadataResponse.html" title="google_sheets4::api::CreateDeveloperMetadataResponse struct">CreateDeveloperMetadataResponse</a></td><td class="docblock-short"><p>The response from creating developer metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CutPasteRequest.html" title="google_sheets4::api::CutPasteRequest struct">CutPasteRequest</a></td><td class="docblock-short"><p>Moves data from the source to the destination.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataExecutionStatus.html" title="google_sheets4::api::DataExecutionStatus struct">DataExecutionStatus</a></td><td class="docblock-short"><p>The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataFilter.html" title="google_sheets4::api::DataFilter struct">DataFilter</a></td><td class="docblock-short"><p>Filter that describes what data should be selected or returned from a request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataFilterValueRange.html" title="google_sheets4::api::DataFilterValueRange struct">DataFilterValueRange</a></td><td class="docblock-short"><p>A range of values whose location is specified by a DataFilter.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataLabel.html" title="google_sheets4::api::DataLabel struct">DataLabel</a></td><td class="docblock-short"><p>Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSource.html" title="google_sheets4::api::DataSource struct">DataSource</a></td><td class="docblock-short"><p>Information about an external data source in the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceChartProperties.html" title="google_sheets4::api::DataSourceChartProperties struct">DataSourceChartProperties</a></td><td class="docblock-short"><p>Properties of a data source chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceColumn.html" title="google_sheets4::api::DataSourceColumn struct">DataSourceColumn</a></td><td class="docblock-short"><p>A column in a data source.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceColumnReference.html" title="google_sheets4::api::DataSourceColumnReference struct">DataSourceColumnReference</a></td><td class="docblock-short"><p>An unique identifier that references a data source column.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceFormula.html" title="google_sheets4::api::DataSourceFormula struct">DataSourceFormula</a></td><td class="docblock-short"><p>A data source formula.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceObjectReference.html" title="google_sheets4::api::DataSourceObjectReference struct">DataSourceObjectReference</a></td><td class="docblock-short"><p>Reference to a data source object.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceObjectReferences.html" title="google_sheets4::api::DataSourceObjectReferences struct">DataSourceObjectReferences</a></td><td class="docblock-short"><p>A list of references to data source objects.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceParameter.html" title="google_sheets4::api::DataSourceParameter struct">DataSourceParameter</a></td><td class="docblock-short"><p>A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceRefreshDailySchedule.html" title="google_sheets4::api::DataSourceRefreshDailySchedule struct">DataSourceRefreshDailySchedule</a></td><td class="docblock-short"><p>A schedule for data to refresh every day in a given time interval.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceRefreshMonthlySchedule.html" title="google_sheets4::api::DataSourceRefreshMonthlySchedule struct">DataSourceRefreshMonthlySchedule</a></td><td class="docblock-short"><p>A monthly schedule for data to refresh on specific days in the month in a given time interval.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceRefreshSchedule.html" title="google_sheets4::api::DataSourceRefreshSchedule struct">DataSourceRefreshSchedule</a></td><td class="docblock-short"><p>Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8am , the refresh will take place between 8am and 12pm every day.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceRefreshWeeklySchedule.html" title="google_sheets4::api::DataSourceRefreshWeeklySchedule struct">DataSourceRefreshWeeklySchedule</a></td><td class="docblock-short"><p>A weekly schedule for data to refresh on specific days in a given time interval.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceSheetDimensionRange.html" title="google_sheets4::api::DataSourceSheetDimensionRange struct">DataSourceSheetDimensionRange</a></td><td class="docblock-short"><p>A range along a single dimension on a DATA_SOURCE sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceSheetProperties.html" title="google_sheets4::api::DataSourceSheetProperties struct">DataSourceSheetProperties</a></td><td class="docblock-short"><p>Additional properties of a DATA_SOURCE sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceSpec.html" title="google_sheets4::api::DataSourceSpec struct">DataSourceSpec</a></td><td class="docblock-short"><p>This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataSourceTable.html" title="google_sheets4::api::DataSourceTable struct">DataSourceTable</a></td><td class="docblock-short"><p>A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as &quot;Extract&quot; in the Sheets editor.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataValidationRule.html" title="google_sheets4::api::DataValidationRule struct">DataValidationRule</a></td><td class="docblock-short"><p>A data validation rule.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DateTimeRule.html" title="google_sheets4::api::DateTimeRule struct">DateTimeRule</a></td><td class="docblock-short"><p>Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteBandingRequest.html" title="google_sheets4::api::DeleteBandingRequest struct">DeleteBandingRequest</a></td><td class="docblock-short"><p>Removes the banded range with the given ID from the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteConditionalFormatRuleRequest.html" title="google_sheets4::api::DeleteConditionalFormatRuleRequest struct">DeleteConditionalFormatRuleRequest</a></td><td class="docblock-short"><p>Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteConditionalFormatRuleResponse.html" title="google_sheets4::api::DeleteConditionalFormatRuleResponse struct">DeleteConditionalFormatRuleResponse</a></td><td class="docblock-short"><p>The result of deleting a conditional format rule.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDataSourceRequest.html" title="google_sheets4::api::DeleteDataSourceRequest struct">DeleteDataSourceRequest</a></td><td class="docblock-short"><p>Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDeveloperMetadataRequest.html" title="google_sheets4::api::DeleteDeveloperMetadataRequest struct">DeleteDeveloperMetadataRequest</a></td><td class="docblock-short"><p>A request to delete developer metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDeveloperMetadataResponse.html" title="google_sheets4::api::DeleteDeveloperMetadataResponse struct">DeleteDeveloperMetadataResponse</a></td><td class="docblock-short"><p>The response from deleting developer metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDimensionGroupRequest.html" title="google_sheets4::api::DeleteDimensionGroupRequest struct">DeleteDimensionGroupRequest</a></td><td class="docblock-short"><p>Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDimensionGroupResponse.html" title="google_sheets4::api::DeleteDimensionGroupResponse struct">DeleteDimensionGroupResponse</a></td><td class="docblock-short"><p>The result of deleting a group.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDimensionRequest.html" title="google_sheets4::api::DeleteDimensionRequest struct">DeleteDimensionRequest</a></td><td class="docblock-short"><p>Deletes the dimensions from the sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDuplicatesRequest.html" title="google_sheets4::api::DeleteDuplicatesRequest struct">DeleteDuplicatesRequest</a></td><td class="docblock-short"><p>Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteDuplicatesResponse.html" title="google_sheets4::api::DeleteDuplicatesResponse struct">DeleteDuplicatesResponse</a></td><td class="docblock-short"><p>The result of removing duplicates in a range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteEmbeddedObjectRequest.html" title="google_sheets4::api::DeleteEmbeddedObjectRequest struct">DeleteEmbeddedObjectRequest</a></td><td class="docblock-short"><p>Deletes the embedded object with the given ID.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteFilterViewRequest.html" title="google_sheets4::api::DeleteFilterViewRequest struct">DeleteFilterViewRequest</a></td><td class="docblock-short"><p>Deletes a particular filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteNamedRangeRequest.html" title="google_sheets4::api::DeleteNamedRangeRequest struct">DeleteNamedRangeRequest</a></td><td class="docblock-short"><p>Removes the named range with the given ID from the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteProtectedRangeRequest.html" title="google_sheets4::api::DeleteProtectedRangeRequest struct">DeleteProtectedRangeRequest</a></td><td class="docblock-short"><p>Deletes the protected range with the given ID.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteRangeRequest.html" title="google_sheets4::api::DeleteRangeRequest struct">DeleteRangeRequest</a></td><td class="docblock-short"><p>Deletes a range of cells, shifting other cells into the deleted area.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteSheetRequest.html" title="google_sheets4::api::DeleteSheetRequest struct">DeleteSheetRequest</a></td><td class="docblock-short"><p>Deletes the requested sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeveloperMetadata.html" title="google_sheets4::api::DeveloperMetadata struct">DeveloperMetadata</a></td><td class="docblock-short"><p>Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeveloperMetadataLocation.html" title="google_sheets4::api::DeveloperMetadataLocation struct">DeveloperMetadataLocation</a></td><td class="docblock-short"><p>A location where metadata may be associated in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DeveloperMetadataLookup.html" title="google_sheets4::api::DeveloperMetadataLookup struct">DeveloperMetadataLookup</a></td><td class="docblock-short"><p>Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionGroup.html" title="google_sheets4::api::DimensionGroup struct">DimensionGroup</a></td><td class="docblock-short"><p>A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionProperties.html" title="google_sheets4::api::DimensionProperties struct">DimensionProperties</a></td><td class="docblock-short"><p>Properties about a dimension.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionRange.html" title="google_sheets4::api::DimensionRange struct">DimensionRange</a></td><td class="docblock-short"><p>A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DuplicateFilterViewRequest.html" title="google_sheets4::api::DuplicateFilterViewRequest struct">DuplicateFilterViewRequest</a></td><td class="docblock-short"><p>Duplicates a particular filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DuplicateFilterViewResponse.html" title="google_sheets4::api::DuplicateFilterViewResponse struct">DuplicateFilterViewResponse</a></td><td class="docblock-short"><p>The result of a filter view being duplicated.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DuplicateSheetRequest.html" title="google_sheets4::api::DuplicateSheetRequest struct">DuplicateSheetRequest</a></td><td class="docblock-short"><p>Duplicates the contents of a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DuplicateSheetResponse.html" title="google_sheets4::api::DuplicateSheetResponse struct">DuplicateSheetResponse</a></td><td class="docblock-short"><p>The result of duplicating a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Editors.html" title="google_sheets4::api::Editors struct">Editors</a></td><td class="docblock-short"><p>The editors of a protected range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EmbeddedChart.html" title="google_sheets4::api::EmbeddedChart struct">EmbeddedChart</a></td><td class="docblock-short"><p>A chart embedded in a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EmbeddedObjectBorder.html" title="google_sheets4::api::EmbeddedObjectBorder struct">EmbeddedObjectBorder</a></td><td class="docblock-short"><p>A border along an embedded object.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EmbeddedObjectPosition.html" title="google_sheets4::api::EmbeddedObjectPosition struct">EmbeddedObjectPosition</a></td><td class="docblock-short"><p>The position of an embedded object such as a chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ErrorValue.html" title="google_sheets4::api::ErrorValue struct">ErrorValue</a></td><td class="docblock-short"><p>An error in a cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ExtendedValue.html" title="google_sheets4::api::ExtendedValue struct">ExtendedValue</a></td><td class="docblock-short"><p>The kinds of value that a cell in a spreadsheet can have.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FilterCriteria.html" title="google_sheets4::api::FilterCriteria struct">FilterCriteria</a></td><td class="docblock-short"><p>Criteria for showing/hiding rows in a filter or filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FilterSpec.html" title="google_sheets4::api::FilterSpec struct">FilterSpec</a></td><td class="docblock-short"><p>The filter criteria associated with a specific column.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FilterView.html" title="google_sheets4::api::FilterView struct">FilterView</a></td><td class="docblock-short"><p>A filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FindReplaceRequest.html" title="google_sheets4::api::FindReplaceRequest struct">FindReplaceRequest</a></td><td class="docblock-short"><p>Finds and replaces data in cells over a range, sheet, or all sheets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FindReplaceResponse.html" title="google_sheets4::api::FindReplaceResponse struct">FindReplaceResponse</a></td><td class="docblock-short"><p>The result of the find/replace.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetSpreadsheetByDataFilterRequest.html" title="google_sheets4::api::GetSpreadsheetByDataFilterRequest struct">GetSpreadsheetByDataFilterRequest</a></td><td class="docblock-short"><p>The request for retrieving a Spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GradientRule.html" title="google_sheets4::api::GradientRule struct">GradientRule</a></td><td class="docblock-short"><p>A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GridCoordinate.html" title="google_sheets4::api::GridCoordinate struct">GridCoordinate</a></td><td class="docblock-short"><p>A coordinate in a sheet. All indexes are zero-based.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GridData.html" title="google_sheets4::api::GridData struct">GridData</a></td><td class="docblock-short"><p>Data in the grid, as well as metadata about the dimensions.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GridProperties.html" title="google_sheets4::api::GridProperties struct">GridProperties</a></td><td class="docblock-short"><p>Properties of a grid.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GridRange.html" title="google_sheets4::api::GridRange struct">GridRange</a></td><td class="docblock-short"><p>A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if <code>&quot;Sheet1&quot;</code> is sheet ID 0, then: <code>Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1</code> <code>Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2</code> <code>Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2</code> <code>Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2</code> <code>Sheet1 == sheet_id:0</code> The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as <code>#REF!</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HistogramChartSpec.html" title="google_sheets4::api::HistogramChartSpec struct">HistogramChartSpec</a></td><td class="docblock-short"><p>A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HistogramRule.html" title="google_sheets4::api::HistogramRule struct">HistogramRule</a></td><td class="docblock-short"><p>Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | &lt; 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | &gt; 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HistogramSeries.html" title="google_sheets4::api::HistogramSeries struct">HistogramSeries</a></td><td class="docblock-short"><p>A histogram series containing the series color and data.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InsertDimensionRequest.html" title="google_sheets4::api::InsertDimensionRequest struct">InsertDimensionRequest</a></td><td class="docblock-short"><p>Inserts rows or columns in a sheet at a particular index.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InsertRangeRequest.html" title="google_sheets4::api::InsertRangeRequest struct">InsertRangeRequest</a></td><td class="docblock-short"><p>Inserts cells into a range, shifting the existing cells over or down.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InterpolationPoint.html" title="google_sheets4::api::InterpolationPoint struct">InterpolationPoint</a></td><td class="docblock-short"><p>A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Interval.html" title="google_sheets4::api::Interval struct">Interval</a></td><td class="docblock-short"><p>Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.IterativeCalculationSettings.html" title="google_sheets4::api::IterativeCalculationSettings struct">IterativeCalculationSettings</a></td><td class="docblock-short"><p>Settings to control how circular dependencies are resolved with iterative calculation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.KeyValueFormat.html" title="google_sheets4::api::KeyValueFormat struct">KeyValueFormat</a></td><td class="docblock-short"><p>Formatting options for key value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LineStyle.html" title="google_sheets4::api::LineStyle struct">LineStyle</a></td><td class="docblock-short"><p>Properties that describe the style of a line.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Link.html" title="google_sheets4::api::Link struct">Link</a></td><td class="docblock-short"><p>An external or local reference.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManualRule.html" title="google_sheets4::api::ManualRule struct">ManualRule</a></td><td class="docblock-short"><p>Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManualRuleGroup.html" title="google_sheets4::api::ManualRuleGroup struct">ManualRuleGroup</a></td><td class="docblock-short"><p>A group name and a list of items from the source data that should be placed in the group with this name.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MatchedDeveloperMetadata.html" title="google_sheets4::api::MatchedDeveloperMetadata struct">MatchedDeveloperMetadata</a></td><td class="docblock-short"><p>A developer metadata entry and the data filters specified in the original request that matched it.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MatchedValueRange.html" title="google_sheets4::api::MatchedValueRange struct">MatchedValueRange</a></td><td class="docblock-short"><p>A value range that was matched by one or more data filers.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MergeCellsRequest.html" title="google_sheets4::api::MergeCellsRequest struct">MergeCellsRequest</a></td><td class="docblock-short"><p>Merges all cells in the range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MoveDimensionRequest.html" title="google_sheets4::api::MoveDimensionRequest struct">MoveDimensionRequest</a></td><td class="docblock-short"><p>Moves one or more rows or columns.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NamedRange.html" title="google_sheets4::api::NamedRange struct">NamedRange</a></td><td class="docblock-short"><p>A named range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NumberFormat.html" title="google_sheets4::api::NumberFormat struct">NumberFormat</a></td><td class="docblock-short"><p>The number format of a cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrgChartSpec.html" title="google_sheets4::api::OrgChartSpec struct">OrgChartSpec</a></td><td class="docblock-short"><p>An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain &quot;Alice&quot;, &quot;Bob&quot;, &quot;Cathy&quot;, parent_labels contain &quot;&quot;, &quot;Alice&quot;, &quot;Alice&quot; and tooltips contain &quot;CEO&quot;, &quot;President&quot;, &quot;VP Sales&quot;.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OverlayPosition.html" title="google_sheets4::api::OverlayPosition struct">OverlayPosition</a></td><td class="docblock-short"><p>The location an object is overlaid on top of a grid.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Padding.html" title="google_sheets4::api::Padding struct">Padding</a></td><td class="docblock-short"><p>The amount of padding around the cell, in pixels. When updating padding, every field must be specified.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PasteDataRequest.html" title="google_sheets4::api::PasteDataRequest struct">PasteDataRequest</a></td><td class="docblock-short"><p>Inserts data into the spreadsheet starting at the specified coordinate.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PieChartSpec.html" title="google_sheets4::api::PieChartSpec struct">PieChartSpec</a></td><td class="docblock-short"><p>A pie chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotFilterCriteria.html" title="google_sheets4::api::PivotFilterCriteria struct">PivotFilterCriteria</a></td><td class="docblock-short"><p>Criteria for showing/hiding rows in a pivot table.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotFilterSpec.html" title="google_sheets4::api::PivotFilterSpec struct">PivotFilterSpec</a></td><td class="docblock-short"><p>The pivot table filter criteria associated with a specific source column offset.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotGroup.html" title="google_sheets4::api::PivotGroup struct">PivotGroup</a></td><td class="docblock-short"><p>A single grouping (either row or column) in a pivot table.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotGroupLimit.html" title="google_sheets4::api::PivotGroupLimit struct">PivotGroupLimit</a></td><td class="docblock-short"><p>The count limit on rows or columns in the pivot group.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotGroupRule.html" title="google_sheets4::api::PivotGroupRule struct">PivotGroupRule</a></td><td class="docblock-short"><p>An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotGroupSortValueBucket.html" title="google_sheets4::api::PivotGroupSortValueBucket struct">PivotGroupSortValueBucket</a></td><td class="docblock-short"><p>Information about which values in a pivot group should be used for sorting.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotGroupValueMetadata.html" title="google_sheets4::api::PivotGroupValueMetadata struct">PivotGroupValueMetadata</a></td><td class="docblock-short"><p>Metadata about a value in a pivot grouping.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotTable.html" title="google_sheets4::api::PivotTable struct">PivotTable</a></td><td class="docblock-short"><p>A pivot table.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotValue.html" title="google_sheets4::api::PivotValue struct">PivotValue</a></td><td class="docblock-short"><p>The definition of how a value in a pivot table should be calculated.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PointStyle.html" title="google_sheets4::api::PointStyle struct">PointStyle</a></td><td class="docblock-short"><p>The style of a point on the chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProtectedRange.html" title="google_sheets4::api::ProtectedRange struct">ProtectedRange</a></td><td class="docblock-short"><p>A protected range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RandomizeRangeRequest.html" title="google_sheets4::api::RandomizeRangeRequest struct">RandomizeRangeRequest</a></td><td class="docblock-short"><p>Randomizes the order of the rows in a range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RefreshDataSourceObjectExecutionStatus.html" title="google_sheets4::api::RefreshDataSourceObjectExecutionStatus struct">RefreshDataSourceObjectExecutionStatus</a></td><td class="docblock-short"><p>The execution status of refreshing one data source object.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RefreshDataSourceRequest.html" title="google_sheets4::api::RefreshDataSourceRequest struct">RefreshDataSourceRequest</a></td><td class="docblock-short"><p>Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional <code>bigquery.readonly</code> OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RefreshDataSourceResponse.html" title="google_sheets4::api::RefreshDataSourceResponse struct">RefreshDataSourceResponse</a></td><td class="docblock-short"><p>The response from refreshing one or multiple data source objects.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RepeatCellRequest.html" title="google_sheets4::api::RepeatCellRequest struct">RepeatCellRequest</a></td><td class="docblock-short"><p>Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula <code>=A1</code> into range B2:C4, B2 would be <code>=A1</code>, B3 would be <code>=A2</code>, B4 would be <code>=A3</code>, C2 would be <code>=B1</code>, C3 would be <code>=B2</code>, C4 would be <code>=B3</code>. To keep the formula's ranges static, use the <code>$</code> indicator. For example, use the formula <code>=$A$1</code> to prevent both the row and the column from incrementing.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Request.html" title="google_sheets4::api::Request struct">Request</a></td><td class="docblock-short"><p>A single kind of update to apply to a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Response.html" title="google_sheets4::api::Response struct">Response</a></td><td class="docblock-short"><p>A single response from an update.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RowData.html" title="google_sheets4::api::RowData struct">RowData</a></td><td class="docblock-short"><p>Data about each cell in a row.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ScorecardChartSpec.html" title="google_sheets4::api::ScorecardChartSpec struct">ScorecardChartSpec</a></td><td class="docblock-short"><p>A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchDeveloperMetadataRequest.html" title="google_sheets4::api::SearchDeveloperMetadataRequest struct">SearchDeveloperMetadataRequest</a></td><td class="docblock-short"><p>A request to retrieve all developer metadata matching the set of specified criteria.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchDeveloperMetadataResponse.html" title="google_sheets4::api::SearchDeveloperMetadataResponse struct">SearchDeveloperMetadataResponse</a></td><td class="docblock-short"><p>A reply to a developer metadata search request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetBasicFilterRequest.html" title="google_sheets4::api::SetBasicFilterRequest struct">SetBasicFilterRequest</a></td><td class="docblock-short"><p>Sets the basic filter associated with a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetDataValidationRequest.html" title="google_sheets4::api::SetDataValidationRequest struct">SetDataValidationRequest</a></td><td class="docblock-short"><p>Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Sheet.html" title="google_sheets4::api::Sheet struct">Sheet</a></td><td class="docblock-short"><p>A sheet in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SheetProperties.html" title="google_sheets4::api::SheetProperties struct">SheetProperties</a></td><td class="docblock-short"><p>Properties of a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Sheets.html" title="google_sheets4::api::Sheets struct">Sheets</a></td><td class="docblock-short"><p>Central instance to access all Sheets related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Slicer.html" title="google_sheets4::api::Slicer struct">Slicer</a></td><td class="docblock-short"><p>A slicer in a sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SlicerSpec.html" title="google_sheets4::api::SlicerSpec struct">SlicerSpec</a></td><td class="docblock-short"><p>The specifications of a slicer.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SortRangeRequest.html" title="google_sheets4::api::SortRangeRequest struct">SortRangeRequest</a></td><td class="docblock-short"><p>Sorts data in rows based on a sort order per column.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SortSpec.html" title="google_sheets4::api::SortSpec struct">SortSpec</a></td><td class="docblock-short"><p>A sort order associated with a specific column or row.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SourceAndDestination.html" title="google_sheets4::api::SourceAndDestination struct">SourceAndDestination</a></td><td class="docblock-short"><p>A combination of a source range and how to extend that source.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Spreadsheet.html" title="google_sheets4::api::Spreadsheet struct">Spreadsheet</a></td><td class="docblock-short"><p>Resource that represents a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetBatchUpdateCall.html" title="google_sheets4::api::SpreadsheetBatchUpdateCall struct">SpreadsheetBatchUpdateCall</a></td><td class="docblock-short"><p>Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetCreateCall.html" title="google_sheets4::api::SpreadsheetCreateCall struct">SpreadsheetCreateCall</a></td><td class="docblock-short"><p>Creates a spreadsheet, returning the newly created spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetDeveloperMetadataGetCall.html" title="google_sheets4::api::SpreadsheetDeveloperMetadataGetCall struct">SpreadsheetDeveloperMetadataGetCall</a></td><td class="docblock-short"><p>Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetDeveloperMetadataSearchCall.html" title="google_sheets4::api::SpreadsheetDeveloperMetadataSearchCall struct">SpreadsheetDeveloperMetadataSearchCall</a></td><td class="docblock-short"><p>Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetGetByDataFilterCall.html" title="google_sheets4::api::SpreadsheetGetByDataFilterCall struct">SpreadsheetGetByDataFilterCall</a></td><td class="docblock-short"><p>Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the <code>fields</code> URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the <code>includeGridData</code> parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetGetCall.html" title="google_sheets4::api::SpreadsheetGetCall struct">SpreadsheetGetCall</a></td><td class="docblock-short"><p>Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the <code>fields</code> URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the <code>includeGridData</code> parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetMethods.html" title="google_sheets4::api::SpreadsheetMethods struct">SpreadsheetMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>spreadsheet</em> resources.
It is not used directly, but through the <code>Sheets</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetProperties.html" title="google_sheets4::api::SpreadsheetProperties struct">SpreadsheetProperties</a></td><td class="docblock-short"><p>Properties of a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetSheetCopyToCall.html" title="google_sheets4::api::SpreadsheetSheetCopyToCall struct">SpreadsheetSheetCopyToCall</a></td><td class="docblock-short"><p>Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetTheme.html" title="google_sheets4::api::SpreadsheetTheme struct">SpreadsheetTheme</a></td><td class="docblock-short"><p>Represents spreadsheet theme</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueAppendCall.html" title="google_sheets4::api::SpreadsheetValueAppendCall struct">SpreadsheetValueAppendCall</a></td><td class="docblock-short"><p>Appends values to a spreadsheet. The input range is used to search for existing data and find a &quot;table&quot; 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>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchClearByDataFilterCall.html" title="google_sheets4::api::SpreadsheetValueBatchClearByDataFilterCall struct">SpreadsheetValueBatchClearByDataFilterCall</a></td><td class="docblock-short"><p>Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchClearCall.html" title="google_sheets4::api::SpreadsheetValueBatchClearCall struct">SpreadsheetValueBatchClearCall</a></td><td class="docblock-short"><p>Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchGetByDataFilterCall.html" title="google_sheets4::api::SpreadsheetValueBatchGetByDataFilterCall struct">SpreadsheetValueBatchGetByDataFilterCall</a></td><td class="docblock-short"><p>Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchGetCall.html" title="google_sheets4::api::SpreadsheetValueBatchGetCall struct">SpreadsheetValueBatchGetCall</a></td><td class="docblock-short"><p>Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchUpdateByDataFilterCall.html" title="google_sheets4::api::SpreadsheetValueBatchUpdateByDataFilterCall struct">SpreadsheetValueBatchUpdateByDataFilterCall</a></td><td class="docblock-short"><p>Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueBatchUpdateCall.html" title="google_sheets4::api::SpreadsheetValueBatchUpdateCall struct">SpreadsheetValueBatchUpdateCall</a></td><td class="docblock-short"><p>Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueClearCall.html" title="google_sheets4::api::SpreadsheetValueClearCall struct">SpreadsheetValueClearCall</a></td><td class="docblock-short"><p>Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueGetCall.html" title="google_sheets4::api::SpreadsheetValueGetCall struct">SpreadsheetValueGetCall</a></td><td class="docblock-short"><p>Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpreadsheetValueUpdateCall.html" title="google_sheets4::api::SpreadsheetValueUpdateCall struct">SpreadsheetValueUpdateCall</a></td><td class="docblock-short"><p>Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TextFormat.html" title="google_sheets4::api::TextFormat struct">TextFormat</a></td><td class="docblock-short"><p>The format of a run of text in a cell. Absent values indicate that the field isn't specified.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TextFormatRun.html" title="google_sheets4::api::TextFormatRun struct">TextFormatRun</a></td><td class="docblock-short"><p>A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TextPosition.html" title="google_sheets4::api::TextPosition struct">TextPosition</a></td><td class="docblock-short"><p>Position settings for text.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TextRotation.html" title="google_sheets4::api::TextRotation struct">TextRotation</a></td><td class="docblock-short"><p>The rotation applied to text in a cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TextToColumnsRequest.html" title="google_sheets4::api::TextToColumnsRequest struct">TextToColumnsRequest</a></td><td class="docblock-short"><p>Splits a column of text into multiple columns, based on a delimiter in each cell.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThemeColorPair.html" title="google_sheets4::api::ThemeColorPair struct">ThemeColorPair</a></td><td class="docblock-short"><p>A pair mapping a spreadsheet theme color type to the concrete color it represents.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TimeOfDay.html" title="google_sheets4::api::TimeOfDay struct">TimeOfDay</a></td><td class="docblock-short"><p>Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and <code>google.protobuf.Timestamp</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TreemapChartColorScale.html" title="google_sheets4::api::TreemapChartColorScale struct">TreemapChartColorScale</a></td><td class="docblock-short"><p>A color scale for a treemap chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TreemapChartSpec.html" title="google_sheets4::api::TreemapChartSpec struct">TreemapChartSpec</a></td><td class="docblock-short"><p>A Treemap chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TrimWhitespaceRequest.html" title="google_sheets4::api::TrimWhitespaceRequest struct">TrimWhitespaceRequest</a></td><td class="docblock-short"><p>Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TrimWhitespaceResponse.html" title="google_sheets4::api::TrimWhitespaceResponse struct">TrimWhitespaceResponse</a></td><td class="docblock-short"><p>The result of trimming whitespace in cells.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UnmergeCellsRequest.html" title="google_sheets4::api::UnmergeCellsRequest struct">UnmergeCellsRequest</a></td><td class="docblock-short"><p>Unmerges cells in the given range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateBandingRequest.html" title="google_sheets4::api::UpdateBandingRequest struct">UpdateBandingRequest</a></td><td class="docblock-short"><p>Updates properties of the supplied banded range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateBordersRequest.html" title="google_sheets4::api::UpdateBordersRequest struct">UpdateBordersRequest</a></td><td class="docblock-short"><p>Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 <code>{ top: RED, bottom: WHITE }</code> 2. range: A1:A5 <code>{ left: BLUE }</code> That would result in A1:A5 having a borders of <code>{ top: RED, bottom: WHITE, left: BLUE }</code>. If you want to clear a border, explicitly set the style to NONE.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateCellsRequest.html" title="google_sheets4::api::UpdateCellsRequest struct">UpdateCellsRequest</a></td><td class="docblock-short"><p>Updates all cells in a range with new data.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateChartSpecRequest.html" title="google_sheets4::api::UpdateChartSpecRequest struct">UpdateChartSpecRequest</a></td><td class="docblock-short"><p>Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateConditionalFormatRuleRequest.html" title="google_sheets4::api::UpdateConditionalFormatRuleRequest struct">UpdateConditionalFormatRuleRequest</a></td><td class="docblock-short"><p>Updates a conditional format rule at the given index, or moves a conditional format rule to another index.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateConditionalFormatRuleResponse.html" title="google_sheets4::api::UpdateConditionalFormatRuleResponse struct">UpdateConditionalFormatRuleResponse</a></td><td class="docblock-short"><p>The result of updating a conditional format rule.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDataSourceRequest.html" title="google_sheets4::api::UpdateDataSourceRequest struct">UpdateDataSourceRequest</a></td><td class="docblock-short"><p>Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional <code>bigquery.readonly</code> OAuth scope.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDataSourceResponse.html" title="google_sheets4::api::UpdateDataSourceResponse struct">UpdateDataSourceResponse</a></td><td class="docblock-short"><p>The response from updating data source.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDeveloperMetadataRequest.html" title="google_sheets4::api::UpdateDeveloperMetadataRequest struct">UpdateDeveloperMetadataRequest</a></td><td class="docblock-short"><p>A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDeveloperMetadataResponse.html" title="google_sheets4::api::UpdateDeveloperMetadataResponse struct">UpdateDeveloperMetadataResponse</a></td><td class="docblock-short"><p>The response from updating developer metadata.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDimensionGroupRequest.html" title="google_sheets4::api::UpdateDimensionGroupRequest struct">UpdateDimensionGroupRequest</a></td><td class="docblock-short"><p>Updates the state of the specified group.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateDimensionPropertiesRequest.html" title="google_sheets4::api::UpdateDimensionPropertiesRequest struct">UpdateDimensionPropertiesRequest</a></td><td class="docblock-short"><p>Updates properties of dimensions within the specified range.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateEmbeddedObjectBorderRequest.html" title="google_sheets4::api::UpdateEmbeddedObjectBorderRequest struct">UpdateEmbeddedObjectBorderRequest</a></td><td class="docblock-short"><p>Updates an embedded object's border property.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateEmbeddedObjectPositionRequest.html" title="google_sheets4::api::UpdateEmbeddedObjectPositionRequest struct">UpdateEmbeddedObjectPositionRequest</a></td><td class="docblock-short"><p>Update an embedded object's position (such as a moving or resizing a chart or image).</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateEmbeddedObjectPositionResponse.html" title="google_sheets4::api::UpdateEmbeddedObjectPositionResponse struct">UpdateEmbeddedObjectPositionResponse</a></td><td class="docblock-short"><p>The result of updating an embedded object's position.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateFilterViewRequest.html" title="google_sheets4::api::UpdateFilterViewRequest struct">UpdateFilterViewRequest</a></td><td class="docblock-short"><p>Updates properties of the filter view.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateNamedRangeRequest.html" title="google_sheets4::api::UpdateNamedRangeRequest struct">UpdateNamedRangeRequest</a></td><td class="docblock-short"><p>Updates properties of the named range with the specified namedRangeId.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateProtectedRangeRequest.html" title="google_sheets4::api::UpdateProtectedRangeRequest struct">UpdateProtectedRangeRequest</a></td><td class="docblock-short"><p>Updates an existing protected range with the specified protectedRangeId.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateSheetPropertiesRequest.html" title="google_sheets4::api::UpdateSheetPropertiesRequest struct">UpdateSheetPropertiesRequest</a></td><td class="docblock-short"><p>Updates properties of the sheet with the specified sheetId.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateSlicerSpecRequest.html" title="google_sheets4::api::UpdateSlicerSpecRequest struct">UpdateSlicerSpecRequest</a></td><td class="docblock-short"><p>Updates a slicer's specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateSpreadsheetPropertiesRequest.html" title="google_sheets4::api::UpdateSpreadsheetPropertiesRequest struct">UpdateSpreadsheetPropertiesRequest</a></td><td class="docblock-short"><p>Updates properties of a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateValuesByDataFilterResponse.html" title="google_sheets4::api::UpdateValuesByDataFilterResponse struct">UpdateValuesByDataFilterResponse</a></td><td class="docblock-short"><p>The response when updating a range of values by a data filter in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateValuesResponse.html" title="google_sheets4::api::UpdateValuesResponse struct">UpdateValuesResponse</a></td><td class="docblock-short"><p>The response when updating a range of values in a spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ValueRange.html" title="google_sheets4::api::ValueRange struct">ValueRange</a></td><td class="docblock-short"><p>Data within a range of the spreadsheet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaterfallChartColumnStyle.html" title="google_sheets4::api::WaterfallChartColumnStyle struct">WaterfallChartColumnStyle</a></td><td class="docblock-short"><p>Styles for a waterfall chart column.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaterfallChartCustomSubtotal.html" title="google_sheets4::api::WaterfallChartCustomSubtotal struct">WaterfallChartCustomSubtotal</a></td><td class="docblock-short"><p>A custom subtotal column for a waterfall chart series.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaterfallChartDomain.html" title="google_sheets4::api::WaterfallChartDomain struct">WaterfallChartDomain</a></td><td class="docblock-short"><p>The domain of a waterfall chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaterfallChartSeries.html" title="google_sheets4::api::WaterfallChartSeries struct">WaterfallChartSeries</a></td><td class="docblock-short"><p>A single series of data for a waterfall chart.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaterfallChartSpec.html" title="google_sheets4::api::WaterfallChartSpec struct">WaterfallChartSpec</a></td><td class="docblock-short"><p>A waterfall chart.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_sheets4::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
A scope is needed when requesting an
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_sheets4"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink