blob: d29932e5f225baf74d50f3042f88bfa797e8e75c [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sheets_v4.html">Google Sheets API</a> . <a href="sheets_v4.spreadsheets.html">spreadsheets</a> . <a href="sheets_v4.spreadsheets.values.html">values</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080078 <code><a href="#append">append(spreadsheetId, range, body=None, responseDateTimeRenderOption=None, includeValuesInResponse=None, valueInputOption=None, insertDataOption=None, responseValueRenderOption=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070079<p class="firstline">Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` 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>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080087 <code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<p class="firstline">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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070095<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<p class="toc_element">
99 <code><a href="#clear">clear(spreadsheetId, range, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<p class="firstline">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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700101<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 <code><a href="#close">close()</a></code></p>
103<p class="firstline">Close httplib2 connections.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700104<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800105 <code><a href="#get">get(spreadsheetId, range, valueRenderOption=None, dateTimeRenderOption=None, majorDimension=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106<p class="firstline">Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.</p>
107<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800108 <code><a href="#update">update(spreadsheetId, range, body=None, responseDateTimeRenderOption=None, valueInputOption=None, includeValuesInResponse=None, responseValueRenderOption=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109<p class="firstline">Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700110<h3>Method Details</h3>
111<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800112 <code class="details" id="append">append(spreadsheetId, range, body=None, responseDateTimeRenderOption=None, includeValuesInResponse=None, valueInputOption=None, insertDataOption=None, responseValueRenderOption=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 <pre>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 [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700114
115Args:
116 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 range: string, The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700119 The object takes the form of:
120
121{ # Data within a range of the spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800122 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
123 [
124 &quot;&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700125 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800126 ],
127 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800128 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800129}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700130
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
132 Allowed values
133 SERIAL_NUMBER - Instructs date, time, datetime, and duration fields to be output as doubles in &quot;serial number&quot; format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it&#x27;s 2 days after December 30st 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.
134 FORMATTED_STRING - Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which is dependent on the spreadsheet locale).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800135 includeValuesInResponse: boolean, Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800136 valueInputOption: string, How the input data should be interpreted.
137 Allowed values
138 INPUT_VALUE_OPTION_UNSPECIFIED - Default input value. This value must not be used.
139 RAW - The values the user has entered will not be parsed and will be stored as-is.
140 USER_ENTERED - The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI.
141 insertDataOption: string, How the input data should be inserted.
142 Allowed values
143 OVERWRITE - The new data overwrites existing data in the areas it is written. (Note: adding data to the end of the sheet will still insert new rows or columns so the data can be written.)
144 INSERT_ROWS - Rows are inserted for the new data.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800145 responseValueRenderOption: string, Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
146 Allowed values
147 FORMATTED_VALUE - Values will be calculated &amp; formatted in the reply according to the cell&#x27;s formatting. Formatting is based on the spreadsheet&#x27;s locale, not the requesting user&#x27;s locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `&quot;$1.23&quot;`.
148 UNFORMATTED_VALUE - Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.
149 FORMULA - Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `&quot;=A1&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700154
155Returns:
156 An object of the form:
157
158 { # The response when updating a range of values in a spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800159 &quot;updates&quot;: { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied.
160 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800161 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800162 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800163 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. This is only included if the request&#x27;s `includeValuesInResponse` field was `true`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800164 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
165 [
166 &quot;&quot;,
167 ],
168 ],
169 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800170 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800171 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800172 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800173 &quot;updatedCells&quot;: 42, # The number of cells updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800174 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800175 &quot;tableRange&quot;: &quot;A String&quot;, # The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800176 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700177 }</pre>
178</div>
179
180<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700181 <code class="details" id="batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 <pre>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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700183
184Args:
185 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700186 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700187 The object takes the form of:
188
189{ # The request for clearing more than one range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700190 &quot;ranges&quot;: [ # The ranges to clear, in A1 notation.
191 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700192 ],
193 }
194
195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400203 { # The response when clearing a range of values in a spreadsheet.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700204 &quot;clearedRanges&quot;: [ # The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet&#x27;s limits.
Bu Sun Kim65020912020-05-20 12:08:20 -0700205 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700206 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800207 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700208 }</pre>
209</div>
210
211<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700212 <code class="details" id="batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700213 <pre>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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700214
215Args:
216 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700217 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700218 The object takes the form of:
219
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700220{ # The request for clearing more than one range selected by a DataFilter in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700221 &quot;dataFilters&quot;: [ # The DataFilters used to determine which ranges to clear.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222 { # Filter that describes what data should be selected or returned from a request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800223 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700224 &quot;developerMetadataLookup&quot;: { # 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. # Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800225 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800226 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800227 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
228 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
229 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
230 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700231 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800232 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800233 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
234 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700235 &quot;dimensionRange&quot;: { # 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. # Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700236 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800237 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800238 &quot;sheetId&quot;: 42, # The sheet this span is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800239 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700240 },
241 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700242 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800243 &quot;gridRange&quot;: { # 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 `&quot;Sheet1&quot;` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` 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 `#REF!`. # Selects data that matches the range described by the GridRange.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800244 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
245 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
247 &quot;sheetId&quot;: 42, # The sheet this range is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800248 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800249 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700250 },
251 ],
252 }
253
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262 { # The response when clearing a range of values selected with DataFilters in a spreadsheet.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800263 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700264 &quot;clearedRanges&quot;: [ # The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet&#x27;s limits.
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 ],
267 }</pre>
268</div>
269
270<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800271 <code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700272 <pre>Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700273
274Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700275 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700276 valueRenderOption: string, How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
277 Allowed values
278 FORMATTED_VALUE - Values will be calculated &amp; formatted in the reply according to the cell&#x27;s formatting. Formatting is based on the spreadsheet&#x27;s locale, not the requesting user&#x27;s locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `&quot;$1.23&quot;`.
279 UNFORMATTED_VALUE - Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.
280 FORMULA - Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `&quot;=A1&quot;`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800281 majorDimension: string, The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
282 Allowed values
283 DIMENSION_UNSPECIFIED - The default value, do not use.
284 ROWS - Operates on the rows of a sheet.
285 COLUMNS - Operates on the columns of a sheet.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800286 ranges: string, The A1 notation of the values to retrieve. (repeated)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800287 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
288 Allowed values
289 SERIAL_NUMBER - Instructs date, time, datetime, and duration fields to be output as doubles in &quot;serial number&quot; format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it&#x27;s 2 days after December 30st 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.
290 FORMATTED_STRING - Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which is dependent on the spreadsheet locale).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
295
296Returns:
297 An object of the form:
298
299 { # The response when retrieving more than one range of values in a spreadsheet.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800300 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The ID of the spreadsheet the data was retrieved from.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700301 &quot;valueRanges&quot;: [ # The requested values. The order of the ValueRanges is the same as the order of the requested ranges.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700302 { # Data within a range of the spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800303 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
304 [
305 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700306 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800307 ],
308 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800309 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800310 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700311 ],
312 }</pre>
313</div>
314
315<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 <code class="details" id="batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700317 <pre>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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318
319Args:
320 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700322 The object takes the form of:
323
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700324{ # The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800325 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700326 &quot;dataFilters&quot;: [ # The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.
327 { # Filter that describes what data should be selected or returned from a request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800328 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700329 &quot;developerMetadataLookup&quot;: { # 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. # Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800330 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800331 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800332 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
333 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
334 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
335 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700336 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800337 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800338 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
339 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700340 &quot;dimensionRange&quot;: { # 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. # Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700341 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800342 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800343 &quot;sheetId&quot;: 42, # The sheet this span is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800344 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700345 },
346 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700347 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800348 &quot;gridRange&quot;: { # 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 `&quot;Sheet1&quot;` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` 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 `#REF!`. # Selects data that matches the range described by the GridRange.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800349 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
350 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800351 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
352 &quot;sheetId&quot;: 42, # The sheet this range is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800353 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800354 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700355 },
356 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800357 &quot;dateTimeRenderOption&quot;: &quot;A String&quot;, # How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
358 &quot;valueRenderOption&quot;: &quot;A String&quot;, # How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700359 }
360
361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
365
366Returns:
367 An object of the form:
368
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700369 { # The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800370 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The ID of the spreadsheet the data was retrieved from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700371 &quot;valueRanges&quot;: [ # The requested values with the list of data filters that matched them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700372 { # A value range that was matched by one or more data filers.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800373 &quot;valueRange&quot;: { # Data within a range of the spreadsheet. # The values matched by the DataFilter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800374 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
375 [
376 &quot;&quot;,
377 ],
378 ],
379 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800380 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800381 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800382 &quot;dataFilters&quot;: [ # The DataFilters from the request that matched the range of values.
383 { # Filter that describes what data should be selected or returned from a request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800384 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800385 &quot;developerMetadataLookup&quot;: { # 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. # Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800386 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800387 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800388 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
389 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
390 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
391 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800392 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800393 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800394 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
395 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800396 &quot;dimensionRange&quot;: { # 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. # Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800397 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800398 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800399 &quot;sheetId&quot;: 42, # The sheet this span is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800400 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800401 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800402 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800403 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800404 &quot;gridRange&quot;: { # 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 `&quot;Sheet1&quot;` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` 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 `#REF!`. # Selects data that matches the range described by the GridRange.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800405 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
406 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800407 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
408 &quot;sheetId&quot;: 42, # The sheet this range is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800409 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800410 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800411 },
412 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 },
414 ],
415 }</pre>
416</div>
417
418<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700419 <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700420 <pre>Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700421
422Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700423 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700424 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700425 The object takes the form of:
426
427{ # The request for updating more than one range of values in a spreadsheet.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800428 &quot;responseValueRenderOption&quot;: &quot;A String&quot;, # Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700429 &quot;data&quot;: [ # The new values to apply to the spreadsheet.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700430 { # Data within a range of the spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800431 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
432 [
433 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700434 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800435 ],
436 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800437 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800438 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700439 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800440 &quot;valueInputOption&quot;: &quot;A String&quot;, # How the input data should be interpreted.
441 &quot;includeValuesInResponse&quot;: True or False, # Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
442 &quot;responseDateTimeRenderOption&quot;: &quot;A String&quot;, # Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700443 }
444
445 x__xgafv: string, V1 error format.
446 Allowed values
447 1 - v1 error format
448 2 - v2 error format
449
450Returns:
451 An object of the form:
452
453 { # The response when updating a range of values in a spreadsheet.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800454 &quot;responses&quot;: [ # One UpdateValuesResponse per requested range, in the same order as the requests appeared.
455 { # The response when updating a range of values in a spreadsheet.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800456 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800457 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800458 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800459 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. This is only included if the request&#x27;s `includeValuesInResponse` field was `true`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800460 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
461 [
462 &quot;&quot;,
463 ],
464 ],
465 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800466 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800467 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800468 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800469 &quot;updatedCells&quot;: 42, # The number of cells updated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800470 },
471 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800472 &quot;totalUpdatedRows&quot;: 42, # The total number of rows where at least one cell in the row was updated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800473 &quot;totalUpdatedSheets&quot;: 42, # The total number of sheets where at least one cell in the sheet was updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800474 &quot;totalUpdatedColumns&quot;: 42, # The total number of columns where at least one cell in the column was updated.
475 &quot;totalUpdatedCells&quot;: 42, # The total number of cells updated.
476 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700477 }</pre>
478</div>
479
480<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700481 <code class="details" id="batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700482 <pre>Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700483
484Args:
485 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700486 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700487 The object takes the form of:
488
489{ # The request for updating more than one range of values in a spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800490 &quot;responseValueRenderOption&quot;: &quot;A String&quot;, # Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800491 &quot;valueInputOption&quot;: &quot;A String&quot;, # How the input data should be interpreted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700492 &quot;data&quot;: [ # The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700493 { # A range of values whose location is specified by a DataFilter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700494 &quot;values&quot;: [ # The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700495 [
496 &quot;&quot;,
497 ],
498 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800499 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800500 &quot;dataFilter&quot;: { # Filter that describes what data should be selected or returned from a request. # The data filter describing the location of the values in the spreadsheet.
501 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
502 &quot;developerMetadataLookup&quot;: { # 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. # Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800503 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800504 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800505 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
506 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
507 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
508 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800509 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800510 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800511 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
512 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
513 &quot;dimensionRange&quot;: { # 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. # Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
514 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
515 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
516 &quot;sheetId&quot;: 42, # The sheet this span is on.
517 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
518 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800519 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800520 },
521 &quot;gridRange&quot;: { # 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 `&quot;Sheet1&quot;` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` 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 `#REF!`. # Selects data that matches the range described by the GridRange.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800522 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
523 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800524 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
525 &quot;sheetId&quot;: 42, # The sheet this range is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800526 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800527 },
528 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700529 },
530 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800531 &quot;includeValuesInResponse&quot;: True or False, # Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
532 &quot;responseDateTimeRenderOption&quot;: &quot;A String&quot;, # Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700533 }
534
535 x__xgafv: string, V1 error format.
536 Allowed values
537 1 - v1 error format
538 2 - v2 error format
539
540Returns:
541 An object of the form:
542
543 { # The response when updating a range of values in a spreadsheet.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800544 &quot;totalUpdatedCells&quot;: 42, # The total number of cells updated.
545 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800546 &quot;totalUpdatedColumns&quot;: 42, # The total number of columns where at least one cell in the column was updated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800547 &quot;totalUpdatedRows&quot;: 42, # The total number of rows where at least one cell in the row was updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700548 &quot;responses&quot;: [ # The response for each range updated.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700549 { # The response when updating a range of values by a data filter in a spreadsheet.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800550 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
551 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request&#x27;s `includeValuesInResponse` field was `true`.
552 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
553 [
554 &quot;&quot;,
555 ],
556 ],
557 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
558 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
559 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800560 &quot;updatedCells&quot;: 42, # The number of cells updated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800561 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800562 &quot;dataFilter&quot;: { # Filter that describes what data should be selected or returned from a request. # The data filter that selected the range that was updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800563 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700564 &quot;developerMetadataLookup&quot;: { # 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. # Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800565 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800566 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800567 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
568 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
569 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
570 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700571 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800572 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800573 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
574 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700575 &quot;dimensionRange&quot;: { # 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. # Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700576 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800577 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800578 &quot;sheetId&quot;: 42, # The sheet this span is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800579 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700580 },
581 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700582 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800583 &quot;gridRange&quot;: { # 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 `&quot;Sheet1&quot;` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` 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 `#REF!`. # Selects data that matches the range described by the GridRange.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800584 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
585 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800586 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
587 &quot;sheetId&quot;: 42, # The sheet this range is on.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800588 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800589 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700590 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800591 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700592 },
593 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800594 &quot;totalUpdatedSheets&quot;: 42, # The total number of sheets where at least one cell in the sheet was updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700595 }</pre>
596</div>
597
598<div class="method">
599 <code class="details" id="clear">clear(spreadsheetId, range, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700600 <pre>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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700601
602Args:
603 spreadsheetId: string, The ID of the spreadsheet to update. (required)
604 range: string, The A1 notation of the values to clear. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700606 The object takes the form of:
607
608{ # The request for clearing a range of values in a spreadsheet.
609 }
610
611 x__xgafv: string, V1 error format.
612 Allowed values
613 1 - v1 error format
614 2 - v2 error format
615
616Returns:
617 An object of the form:
618
619 { # The response when clearing a range of values in a spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800620 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800621 &quot;clearedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet&#x27;s limits.)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700622 }</pre>
623</div>
624
625<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700626 <code class="details" id="close">close()</code>
627 <pre>Close httplib2 connections.</pre>
628</div>
629
630<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800631 <code class="details" id="get">get(spreadsheetId, range, valueRenderOption=None, dateTimeRenderOption=None, majorDimension=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700632 <pre>Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700633
634Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700635 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700636 range: string, The A1 notation of the values to retrieve. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800637 valueRenderOption: string, How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
638 Allowed values
639 FORMATTED_VALUE - Values will be calculated &amp; formatted in the reply according to the cell&#x27;s formatting. Formatting is based on the spreadsheet&#x27;s locale, not the requesting user&#x27;s locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `&quot;$1.23&quot;`.
640 UNFORMATTED_VALUE - Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.
641 FORMULA - Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `&quot;=A1&quot;`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700642 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
643 Allowed values
644 SERIAL_NUMBER - Instructs date, time, datetime, and duration fields to be output as doubles in &quot;serial number&quot; format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it&#x27;s 2 days after December 30st 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.
645 FORMATTED_STRING - Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which is dependent on the spreadsheet locale).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800646 majorDimension: string, The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
647 Allowed values
648 DIMENSION_UNSPECIFIED - The default value, do not use.
649 ROWS - Operates on the rows of a sheet.
650 COLUMNS - Operates on the columns of a sheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700651 x__xgafv: string, V1 error format.
652 Allowed values
653 1 - v1 error format
654 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700655
656Returns:
657 An object of the form:
658
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700659 { # Data within a range of the spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800660 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
661 [
662 &quot;&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700663 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800664 ],
665 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800666 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800667 }</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700668</div>
669
670<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800671 <code class="details" id="update">update(spreadsheetId, range, body=None, responseDateTimeRenderOption=None, valueInputOption=None, includeValuesInResponse=None, responseValueRenderOption=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700672 <pre>Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
673
674Args:
675 spreadsheetId: string, The ID of the spreadsheet to update. (required)
676 range: string, The A1 notation of the values to update. (required)
677 body: object, The request body.
678 The object takes the form of:
679
680{ # Data within a range of the spreadsheet.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800681 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
682 [
683 &quot;&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700684 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800685 ],
686 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800687 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800688}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700689
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800690 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
691 Allowed values
692 SERIAL_NUMBER - Instructs date, time, datetime, and duration fields to be output as doubles in &quot;serial number&quot; format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it&#x27;s 2 days after December 30st 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year.
693 FORMATTED_STRING - Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which is dependent on the spreadsheet locale).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700694 valueInputOption: string, How the input data should be interpreted.
695 Allowed values
696 INPUT_VALUE_OPTION_UNSPECIFIED - Default input value. This value must not be used.
697 RAW - The values the user has entered will not be parsed and will be stored as-is.
698 USER_ENTERED - The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800699 includeValuesInResponse: boolean, Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
700 responseValueRenderOption: string, Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
701 Allowed values
702 FORMATTED_VALUE - Values will be calculated &amp; formatted in the reply according to the cell&#x27;s formatting. Formatting is based on the spreadsheet&#x27;s locale, not the requesting user&#x27;s locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `&quot;$1.23&quot;`.
703 UNFORMATTED_VALUE - Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.
704 FORMULA - Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `&quot;=A1&quot;`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700705 x__xgafv: string, V1 error format.
706 Allowed values
707 1 - v1 error format
708 2 - v2 error format
709
710Returns:
711 An object of the form:
712
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700713 { # The response when updating a range of values in a spreadsheet.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800714 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800715 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800716 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800717 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. This is only included if the request&#x27;s `includeValuesInResponse` field was `true`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800718 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
719 [
720 &quot;&quot;,
721 ],
722 ],
723 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800724 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800725 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800726 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800727 &quot;updatedCells&quot;: 42, # The number of cells updated.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700728 }</pre>
729</div>
730
731</body></html>