Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / sheets_v4.spreadsheets.values.html
blob: 9596c7f56428beccc7713d7ba167b78fbc2d0994 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#append">append(spreadsheetId, range, body=None, responseValueRenderOption=None, responseDateTimeRenderOption=None, insertDataOption=None, valueInputOption=None, includeValuesInResponse=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]79<p class="firstline">Appends values to a spreadsheet. The input range is used to search for</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]82<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="firstline">Returns one or more ranges of values from a spreadsheet.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Returns one or more ranges of values that match the specified data filters.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94<p class="firstline">Sets values in one or more ranges of a spreadsheet.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Sets values in one or more ranges of a spreadsheet.</p>
98<p class="toc_element">
99 <code><a href="#clear">clear(spreadsheetId, range, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Clears values from a spreadsheet.</p>
101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 <code><a href="#get">get(spreadsheetId, range, dateTimeRenderOption=None, valueRenderOption=None, majorDimension=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]103<p class="firstline">Returns a range of values from a spreadsheet.</p>
104<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]105 <code><a href="#update">update(spreadsheetId, range, body=None, responseValueRenderOption=None, responseDateTimeRenderOption=None, includeValuesInResponse=None, valueInputOption=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]106<p class="firstline">Sets values in a range of a spreadsheet.</p>
107<h3>Method Details</h3>
108<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]109 <code class="details" id="append">append(spreadsheetId, range, body=None, responseValueRenderOption=None, responseDateTimeRenderOption=None, insertDataOption=None, valueInputOption=None, includeValuesInResponse=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]110 <pre>Appends values to a spreadsheet. The input range is used to search for
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111existing data and find a &quot;table&quot; within that range. Values will be
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]112appended to the next row of the table, starting with the first column of
113the table. See the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]114[guide](/sheets/api/guides/values#appending_values)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115and
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]116[sample code](/sheets/api/samples/writing#append_values)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117for specific details of how tables are detected and data is appended.
118
119The caller must specify the spreadsheet ID, range, and
120a valueInputOption. The `valueInputOption` only
121controls how the input data will be added to the sheet (column-wise or
122row-wise), it does not influence what cell the data starts being written
123to.
124
125Args:
126 spreadsheetId: string, The ID of the spreadsheet to update. (required)
127 range: string, The A1 notation of a range to search for a logical table of data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]128Values are appended after the last row of the table. (required)
129 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]130 The object takes the form of:
131
132{ # Data within a range of the spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]134 # the outer array representing all the data and each inner array
135 # representing a major dimension. Each item in the inner array
136 # corresponds with one cell.
137 #
138 # For output, empty trailing rows and columns will not be included.
139 #
140 # For input, supported value types are: bool, string, and double.
141 # Null values will be skipped.
142 # To set a cell to an empty value, set the string value to an empty string.
143 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]145 ],
146 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]148 #
149 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
150 # then requesting `range=A1:B2,majorDimension=ROWS` will return
151 # `[[1,2],[3,4]]`,
152 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
153 # `[[1,3],[2,4]]`.
154 #
155 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
156 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
157 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
158 #
159 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]160 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
161 # For output, this range indicates the entire requested range,
162 # even though the values will exclude trailing rows and columns.
163 # When appending values, this field represents the range to search for a
164 # table, after which values will be appended.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165}
166
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]167 responseValueRenderOption: string, Determines how values in the response should be rendered.
168The default render option is ValueRenderOption.FORMATTED_VALUE.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]169 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be
170rendered. This is ignored if response_value_render_option is
171FORMATTED_VALUE.
172The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]173 insertDataOption: string, How the input data should be inserted.
174 valueInputOption: string, How the input data should be interpreted.
175 includeValuesInResponse: boolean, Determines if the update response should include the values
176of the cells that were appended. By default, responses
177do not include the updated values.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]182
183Returns:
184 An object of the form:
185
186 { # The response when updating a range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
188 &quot;updates&quot;: { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]190 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]191 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
192 &quot;updatedCells&quot;: 42, # The number of cells updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]193 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
195 # This is only included if the request&#x27;s `includeValuesInResponse` field
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]196 # was `true`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]198 # the outer array representing all the data and each inner array
199 # representing a major dimension. Each item in the inner array
200 # corresponds with one cell.
201 #
202 # For output, empty trailing rows and columns will not be included.
203 #
204 # For input, supported value types are: bool, string, and double.
205 # Null values will be skipped.
206 # To set a cell to an empty value, set the string value to an empty string.
207 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]209 ],
210 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]212 #
213 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
214 # then requesting `range=A1:B2,majorDimension=ROWS` will return
215 # `[[1,2],[3,4]]`,
216 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
217 # `[[1,3],[2,4]]`.
218 #
219 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
220 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
221 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
222 #
223 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]224 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
225 # For output, this range indicates the entire requested range,
226 # even though the values will exclude trailing rows and columns.
227 # When appending values, this field represents the range to search for a
228 # table, after which values will be appended.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]229 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]230 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]231 &quot;tableRange&quot;: &quot;A String&quot;, # The range (in A1 notation) of the table that values are being appended to
232 # (before the values were appended).
233 # Empty if no table was found.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]234 }</pre>
235</div>
236
237<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]238 <code class="details" id="batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]239 <pre>Clears one or more ranges of values from a spreadsheet.
240The caller must specify the spreadsheet ID and one or more ranges.
241Only values are cleared -- all other properties of the cell (such as
242formatting, data validation, etc..) are kept.
243
244Args:
245 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247 The object takes the form of:
248
249{ # The request for clearing more than one range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 &quot;ranges&quot;: [ # The ranges to clear, in A1 notation.
251 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]252 ],
253 }
254
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]263 { # The response when clearing a range of values in a spreadsheet.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]264 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 &quot;clearedRanges&quot;: [ # The ranges that were cleared, in A1 notation. If the requests are for an
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266 # unbounded range or a ranger larger than the bounds of the sheet, this is
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 # the actual ranges that were cleared, bounded to the sheet&#x27;s limits.
268 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]269 ],
270 }</pre>
271</div>
272
273<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]274 <code class="details" id="batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 <pre>Clears one or more ranges of values from a spreadsheet.
276The caller must specify the spreadsheet ID and one or more
277DataFilters. Ranges matching any of the specified data
278filters will be cleared. Only values are cleared -- all other properties
279of the cell (such as formatting, data validation, etc..) are kept.
280
281Args:
282 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 The object takes the form of:
285
286{ # The request for clearing more than one range selected by a
287 # DataFilter in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;dataFilters&quot;: [ # The DataFilters used to determine which ranges to clear.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 { # Filter that describes what data should be selected or returned from a
290 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]291 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
292 # described by this DeveloperMetadataLookup.
293 # example, if only a metadata ID is specified this considers the
294 # DeveloperMetadata with that particular unique ID. If a metadata key is
295 # specified, this considers all developer metadata with that key. If a
296 # key, visibility, and location type are all specified, this considers all
297 # developer metadata with that key and visibility that are associated with a
298 # location of that type. In general, this
299 # selects all DeveloperMetadata that matches the intersection of all the
300 # specified fields; any field or combination of fields may be specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]301 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
302 # specified as EXACT, only developer metadata associated on the exact
303 # location specified is matched. If this field is specified to INTERSECTING,
304 # developer metadata associated on intersecting locations is also
305 # matched. If left unspecified, this field assumes a default value of
306 # INTERSECTING.
307 # If this field is specified, a metadataLocation
308 # must also be specified.
309 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
310 # DeveloperMetadata.visibility. If left unspecified, all developer
311 # metadata visibile to the requesting project is considered.
312 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
313 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]314 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
315 # associated with locations of the specified type. For example, when this
316 # field is specified as ROW this lookup
317 # only considers developer metadata associated on rows. If the field is left
318 # unspecified, all location types are considered. This field cannot be
319 # specified as SPREADSHEET when
320 # the locationMatchingStrategy
321 # is specified as INTERSECTING or when the
322 # metadataLocation is specified as a
323 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
324 # developer metadata location. This field also must be left unspecified when
325 # the locationMatchingStrategy
326 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]327 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
328 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]329 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
330 # the specified location. This field either matches exact locations or all
331 # intersecting locations according the specified
332 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]333 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
334 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
335 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
336 # a dimension. The specified DimensionRange must represent a single row
337 # or column; it cannot be unbounded or span multiple rows or columns.
338 # All indexes are zero-based.
339 # Indexes are half open: the start index is inclusive
340 # and the end index is exclusive.
341 # Missing indexes indicate the range is unbounded on that side.
342 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]343 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]344 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
345 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]346 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]347 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]348 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]349 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
350 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]351 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]354 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 # and the end index is exclusive -- [start_index, end_index).
356 # Missing indexes indicate the range is unbounded on that side.
357 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 #
360 # `Sheet1!A1:A1 == sheet_id: 0,
361 # start_row_index: 0, end_row_index: 1,
362 # start_column_index: 0, end_column_index: 1`
363 #
364 # `Sheet1!A3:B4 == sheet_id: 0,
365 # start_row_index: 2, end_row_index: 4,
366 # start_column_index: 0, end_column_index: 2`
367 #
368 # `Sheet1!A:B == sheet_id: 0,
369 # start_column_index: 0, end_column_index: 2`
370 #
371 # `Sheet1!A5:B == sheet_id: 0,
372 # start_row_index: 4,
373 # start_column_index: 0, end_column_index: 2`
374 #
375 # `Sheet1 == sheet_id:0`
376 #
377 # The start index must always be less than or equal to the end index.
378 # If the start index equals the end index, then the range is empty.
379 # Empty ranges are typically not meaningful and are usually rendered in the
380 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]381 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]382 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]383 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
384 &quot;sheetId&quot;: 42, # The sheet this range is on.
385 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]387 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 },
389 ],
390 }
391
392 x__xgafv: string, V1 error format.
393 Allowed values
394 1 - v1 error format
395 2 - v2 error format
396
397Returns:
398 An object of the form:
399
400 { # The response when clearing a range of values selected with
401 # DataFilters in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]402 &quot;clearedRanges&quot;: [ # The ranges that were cleared, in A1 notation. If the requests are for an
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]403 # unbounded range or a ranger larger than the bounds of the sheet, this is
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404 # the actual ranges that were cleared, bounded to the sheet&#x27;s limits.
405 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]407 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 }</pre>
409</div>
410
411<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]412 <code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]413 <pre>Returns one or more ranges of values from a spreadsheet.
414The caller must specify the spreadsheet ID and one or more ranges.
415
416Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]417 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]418 valueRenderOption: string, How values should be represented in the output.
419The default render option is ValueRenderOption.FORMATTED_VALUE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]420 majorDimension: string, The major dimension that results should use.
421
422For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]423then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,
424whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]425`[[1,3],[2,4]]`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]426 ranges: string, The A1 notation of the values to retrieve. (repeated)
427 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
428This is ignored if value_render_option is
429FORMATTED_VALUE.
430The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]431 x__xgafv: string, V1 error format.
432 Allowed values
433 1 - v1 error format
434 2 - v2 error format
435
436Returns:
437 An object of the form:
438
439 { # The response when retrieving more than one range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]440 &quot;valueRanges&quot;: [ # The requested values. The order of the ValueRanges is the same as the
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]441 # order of the requested ranges.
442 { # Data within a range of the spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 # the outer array representing all the data and each inner array
445 # representing a major dimension. Each item in the inner array
446 # corresponds with one cell.
447 #
448 # For output, empty trailing rows and columns will not be included.
449 #
450 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]451 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]452 # To set a cell to an empty value, set the string value to an empty string.
453 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]454 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]455 ],
456 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]457 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]458 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]459 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
460 # then requesting `range=A1:B2,majorDimension=ROWS` will return
461 # `[[1,2],[3,4]]`,
462 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
463 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]464 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]465 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
466 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
467 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]468 #
469 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]470 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
471 # For output, this range indicates the entire requested range,
472 # even though the values will exclude trailing rows and columns.
473 # When appending values, this field represents the range to search for a
474 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]475 },
476 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]477 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The ID of the spreadsheet the data was retrieved from.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]478 }</pre>
479</div>
480
481<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]482 <code class="details" id="batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 <pre>Returns one or more ranges of values that match the specified data filters.
484The caller must specify the spreadsheet ID and one or more
485DataFilters. Ranges that match any of the data filters in
486the request will be returned.
487
488Args:
489 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]490 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 The object takes the form of:
492
493{ # The request for retrieving a range of values in a spreadsheet selected by a
494 # set of DataFilters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]495 &quot;dateTimeRenderOption&quot;: &quot;A String&quot;, # How dates, times, and durations should be represented in the output.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 # This is ignored if value_render_option is
497 # FORMATTED_VALUE.
498 # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]499 &quot;valueRenderOption&quot;: &quot;A String&quot;, # How values should be represented in the output.
500 # The default render option is ValueRenderOption.FORMATTED_VALUE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]501 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension that results should use.
502 #
503 # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
504 # then a request that selects that range and sets `majorDimension=ROWS`
505 # returns `[[1,2],[3,4]]`, whereas a request that sets
506 # `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;dataFilters&quot;: [ # The data filters used to match the ranges of values to retrieve. Ranges
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]508 # that match any of the specified data filters are included in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]509 { # Filter that describes what data should be selected or returned from a
510 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]511 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
512 # described by this DeveloperMetadataLookup.
513 # example, if only a metadata ID is specified this considers the
514 # DeveloperMetadata with that particular unique ID. If a metadata key is
515 # specified, this considers all developer metadata with that key. If a
516 # key, visibility, and location type are all specified, this considers all
517 # developer metadata with that key and visibility that are associated with a
518 # location of that type. In general, this
519 # selects all DeveloperMetadata that matches the intersection of all the
520 # specified fields; any field or combination of fields may be specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]521 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
522 # specified as EXACT, only developer metadata associated on the exact
523 # location specified is matched. If this field is specified to INTERSECTING,
524 # developer metadata associated on intersecting locations is also
525 # matched. If left unspecified, this field assumes a default value of
526 # INTERSECTING.
527 # If this field is specified, a metadataLocation
528 # must also be specified.
529 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
530 # DeveloperMetadata.visibility. If left unspecified, all developer
531 # metadata visibile to the requesting project is considered.
532 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
533 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]534 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
535 # associated with locations of the specified type. For example, when this
536 # field is specified as ROW this lookup
537 # only considers developer metadata associated on rows. If the field is left
538 # unspecified, all location types are considered. This field cannot be
539 # specified as SPREADSHEET when
540 # the locationMatchingStrategy
541 # is specified as INTERSECTING or when the
542 # metadataLocation is specified as a
543 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
544 # developer metadata location. This field also must be left unspecified when
545 # the locationMatchingStrategy
546 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]547 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
548 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]549 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
550 # the specified location. This field either matches exact locations or all
551 # intersecting locations according the specified
552 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]553 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
554 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
555 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
556 # a dimension. The specified DimensionRange must represent a single row
557 # or column; it cannot be unbounded or span multiple rows or columns.
558 # All indexes are zero-based.
559 # Indexes are half open: the start index is inclusive
560 # and the end index is exclusive.
561 # Missing indexes indicate the range is unbounded on that side.
562 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]563 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]564 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
565 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]566 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]567 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]568 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]569 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
570 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]571 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]572 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]574 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]575 # and the end index is exclusive -- [start_index, end_index).
576 # Missing indexes indicate the range is unbounded on that side.
577 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]578 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]579 #
580 # `Sheet1!A1:A1 == sheet_id: 0,
581 # start_row_index: 0, end_row_index: 1,
582 # start_column_index: 0, end_column_index: 1`
583 #
584 # `Sheet1!A3:B4 == sheet_id: 0,
585 # start_row_index: 2, end_row_index: 4,
586 # start_column_index: 0, end_column_index: 2`
587 #
588 # `Sheet1!A:B == sheet_id: 0,
589 # start_column_index: 0, end_column_index: 2`
590 #
591 # `Sheet1!A5:B == sheet_id: 0,
592 # start_row_index: 4,
593 # start_column_index: 0, end_column_index: 2`
594 #
595 # `Sheet1 == sheet_id:0`
596 #
597 # The start index must always be less than or equal to the end index.
598 # If the start index equals the end index, then the range is empty.
599 # Empty ranges are typically not meaningful and are usually rendered in the
600 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]601 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]602 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]603 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
604 &quot;sheetId&quot;: 42, # The sheet this range is on.
605 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]606 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]607 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]608 },
609 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 }
611
612 x__xgafv: string, V1 error format.
613 Allowed values
614 1 - v1 error format
615 2 - v2 error format
616
617Returns:
618 An object of the form:
619
620 { # The response when retrieving more than one range of values in a spreadsheet
621 # selected by DataFilters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]622 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The ID of the spreadsheet the data was retrieved from.
623 &quot;valueRanges&quot;: [ # The requested values with the list of data filters that matched them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]624 { # A value range that was matched by one or more data filers.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]625 &quot;dataFilters&quot;: [ # The DataFilters from the request that matched the range of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 # values.
627 { # Filter that describes what data should be selected or returned from a
628 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]629 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
630 # described by this DeveloperMetadataLookup.
631 # example, if only a metadata ID is specified this considers the
632 # DeveloperMetadata with that particular unique ID. If a metadata key is
633 # specified, this considers all developer metadata with that key. If a
634 # key, visibility, and location type are all specified, this considers all
635 # developer metadata with that key and visibility that are associated with a
636 # location of that type. In general, this
637 # selects all DeveloperMetadata that matches the intersection of all the
638 # specified fields; any field or combination of fields may be specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]639 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
640 # specified as EXACT, only developer metadata associated on the exact
641 # location specified is matched. If this field is specified to INTERSECTING,
642 # developer metadata associated on intersecting locations is also
643 # matched. If left unspecified, this field assumes a default value of
644 # INTERSECTING.
645 # If this field is specified, a metadataLocation
646 # must also be specified.
647 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
648 # DeveloperMetadata.visibility. If left unspecified, all developer
649 # metadata visibile to the requesting project is considered.
650 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
651 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]652 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
653 # associated with locations of the specified type. For example, when this
654 # field is specified as ROW this lookup
655 # only considers developer metadata associated on rows. If the field is left
656 # unspecified, all location types are considered. This field cannot be
657 # specified as SPREADSHEET when
658 # the locationMatchingStrategy
659 # is specified as INTERSECTING or when the
660 # metadataLocation is specified as a
661 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
662 # developer metadata location. This field also must be left unspecified when
663 # the locationMatchingStrategy
664 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]665 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
666 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]667 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
668 # the specified location. This field either matches exact locations or all
669 # intersecting locations according the specified
670 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]671 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
672 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
673 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
674 # a dimension. The specified DimensionRange must represent a single row
675 # or column; it cannot be unbounded or span multiple rows or columns.
676 # All indexes are zero-based.
677 # Indexes are half open: the start index is inclusive
678 # and the end index is exclusive.
679 # Missing indexes indicate the range is unbounded on that side.
680 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]681 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]682 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
683 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]684 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]685 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]686 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]687 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
688 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]689 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]690 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]691 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]692 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]693 # and the end index is exclusive -- [start_index, end_index).
694 # Missing indexes indicate the range is unbounded on that side.
695 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]696 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]697 #
698 # `Sheet1!A1:A1 == sheet_id: 0,
699 # start_row_index: 0, end_row_index: 1,
700 # start_column_index: 0, end_column_index: 1`
701 #
702 # `Sheet1!A3:B4 == sheet_id: 0,
703 # start_row_index: 2, end_row_index: 4,
704 # start_column_index: 0, end_column_index: 2`
705 #
706 # `Sheet1!A:B == sheet_id: 0,
707 # start_column_index: 0, end_column_index: 2`
708 #
709 # `Sheet1!A5:B == sheet_id: 0,
710 # start_row_index: 4,
711 # start_column_index: 0, end_column_index: 2`
712 #
713 # `Sheet1 == sheet_id:0`
714 #
715 # The start index must always be less than or equal to the end index.
716 # If the start index equals the end index, then the range is empty.
717 # Empty ranges are typically not meaningful and are usually rendered in the
718 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]719 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]720 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]721 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
722 &quot;sheetId&quot;: 42, # The sheet this range is on.
723 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]724 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]725 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 },
727 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]728 &quot;valueRange&quot;: { # Data within a range of the spreadsheet. # The values matched by the DataFilter.
729 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
730 # the outer array representing all the data and each inner array
731 # representing a major dimension. Each item in the inner array
732 # corresponds with one cell.
733 #
734 # For output, empty trailing rows and columns will not be included.
735 #
736 # For input, supported value types are: bool, string, and double.
737 # Null values will be skipped.
738 # To set a cell to an empty value, set the string value to an empty string.
739 [
740 &quot;&quot;,
741 ],
742 ],
743 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
744 #
745 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
746 # then requesting `range=A1:B2,majorDimension=ROWS` will return
747 # `[[1,2],[3,4]]`,
748 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
749 # `[[1,3],[2,4]]`.
750 #
751 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
752 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
753 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
754 #
755 # When writing, if this field is not set, it defaults to ROWS.
756 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
757 # For output, this range indicates the entire requested range,
758 # even though the values will exclude trailing rows and columns.
759 # When appending values, this field represents the range to search for a
760 # table, after which values will be appended.
761 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]762 },
763 ],
764 }</pre>
765</div>
766
767<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]768 <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]769 <pre>Sets values in one or more ranges of a spreadsheet.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]770The caller must specify the spreadsheet ID,
771a valueInputOption, and one or more
772ValueRanges.
773
774Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]775 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]776 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]777 The object takes the form of:
778
779{ # The request for updating more than one range of values in a spreadsheet.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]780 &quot;valueInputOption&quot;: &quot;A String&quot;, # How the input data should be interpreted.
781 &quot;responseDateTimeRenderOption&quot;: &quot;A String&quot;, # Determines how dates, times, and durations in the response should be
782 # rendered. This is ignored if response_value_render_option is
783 # FORMATTED_VALUE.
784 # The default dateTime render option is
785 # DateTimeRenderOption.SERIAL_NUMBER.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]786 &quot;data&quot;: [ # The new values to apply to the spreadsheet.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]787 { # Data within a range of the spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]788 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]789 # the outer array representing all the data and each inner array
790 # representing a major dimension. Each item in the inner array
791 # corresponds with one cell.
792 #
793 # For output, empty trailing rows and columns will not be included.
794 #
795 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]796 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]797 # To set a cell to an empty value, set the string value to an empty string.
798 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]799 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]800 ],
801 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]802 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]803 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]804 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
805 # then requesting `range=A1:B2,majorDimension=ROWS` will return
806 # `[[1,2],[3,4]]`,
807 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
808 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]809 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]810 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
811 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
812 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]813 #
814 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]815 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
816 # For output, this range indicates the entire requested range,
817 # even though the values will exclude trailing rows and columns.
818 # When appending values, this field represents the range to search for a
819 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]820 },
821 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]822 &quot;includeValuesInResponse&quot;: True or False, # Determines if the update response should include the values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]823 # of the cells that were updated. By default, responses
824 # do not include the updated values. The `updatedData` field within
825 # each of the BatchUpdateValuesResponse.responses contains the updated
826 # values. If the range to write was larger than the range actually written,
827 # the response includes all values in the requested range (excluding trailing
828 # empty rows and columns).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]829 &quot;responseValueRenderOption&quot;: &quot;A String&quot;, # Determines how values in the response should be rendered.
830 # The default render option is ValueRenderOption.FORMATTED_VALUE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]831 }
832
833 x__xgafv: string, V1 error format.
834 Allowed values
835 1 - v1 error format
836 2 - v2 error format
837
838Returns:
839 An object of the form:
840
841 { # The response when updating a range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]842 &quot;totalUpdatedCells&quot;: 42, # The total number of cells updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]843 &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 -0700[diff] [blame]844 &quot;responses&quot;: [ # One UpdateValuesResponse per requested range, in the same order as
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]845 # the requests appeared.
846 { # The response when updating a range of values in a spreadsheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]847 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]848 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]849 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
850 &quot;updatedCells&quot;: 42, # The number of cells updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]851 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]852 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
853 # This is only included if the request&#x27;s `includeValuesInResponse` field
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]854 # was `true`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]855 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]856 # the outer array representing all the data and each inner array
857 # representing a major dimension. Each item in the inner array
858 # corresponds with one cell.
859 #
860 # For output, empty trailing rows and columns will not be included.
861 #
862 # For input, supported value types are: bool, string, and double.
863 # Null values will be skipped.
864 # To set a cell to an empty value, set the string value to an empty string.
865 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]866 &quot;&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]867 ],
868 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]869 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]870 #
871 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
872 # then requesting `range=A1:B2,majorDimension=ROWS` will return
873 # `[[1,2],[3,4]]`,
874 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
875 # `[[1,3],[2,4]]`.
876 #
877 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
878 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
879 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
880 #
881 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]882 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
883 # For output, this range indicates the entire requested range,
884 # even though the values will exclude trailing rows and columns.
885 # When appending values, this field represents the range to search for a
886 # table, after which values will be appended.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]887 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]888 },
889 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]890 &quot;totalUpdatedSheets&quot;: 42, # The total number of sheets where at least one cell in the sheet was
891 # updated.
892 &quot;totalUpdatedColumns&quot;: 42, # The total number of columns where at least one cell in the column was
893 # updated.
894 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]895 }</pre>
896</div>
897
898<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]899 <code class="details" id="batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]900 <pre>Sets values in one or more ranges of a spreadsheet.
901The caller must specify the spreadsheet ID,
902a valueInputOption, and one or more
903DataFilterValueRanges.
904
905Args:
906 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]907 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]908 The object takes the form of:
909
910{ # The request for updating more than one range of values in a spreadsheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]911 &quot;responseValueRenderOption&quot;: &quot;A String&quot;, # Determines how values in the response should be rendered.
912 # The default render option is ValueRenderOption.FORMATTED_VALUE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]913 &quot;valueInputOption&quot;: &quot;A String&quot;, # How the input data should be interpreted.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]914 &quot;includeValuesInResponse&quot;: True or False, # Determines if the update response should include the values
915 # of the cells that were updated. By default, responses
916 # do not include the updated values. The `updatedData` field within
917 # each of the BatchUpdateValuesResponse.responses contains the updated
918 # values. If the range to write was larger than the range actually written,
919 # the response includes all values in the requested range (excluding trailing
920 # empty rows and columns).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]921 &quot;data&quot;: [ # The new values to apply to the spreadsheet. If more than one range is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]922 # matched by the specified DataFilter the specified values are applied to
923 # all of those ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]924 { # A range of values whose location is specified by a DataFilter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]925 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
926 &quot;dataFilter&quot;: { # Filter that describes what data should be selected or returned from a # The data filter describing the location of the values in the spreadsheet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]927 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]928 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
929 # described by this DeveloperMetadataLookup.
930 # example, if only a metadata ID is specified this considers the
931 # DeveloperMetadata with that particular unique ID. If a metadata key is
932 # specified, this considers all developer metadata with that key. If a
933 # key, visibility, and location type are all specified, this considers all
934 # developer metadata with that key and visibility that are associated with a
935 # location of that type. In general, this
936 # selects all DeveloperMetadata that matches the intersection of all the
937 # specified fields; any field or combination of fields may be specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]938 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
939 # specified as EXACT, only developer metadata associated on the exact
940 # location specified is matched. If this field is specified to INTERSECTING,
941 # developer metadata associated on intersecting locations is also
942 # matched. If left unspecified, this field assumes a default value of
943 # INTERSECTING.
944 # If this field is specified, a metadataLocation
945 # must also be specified.
946 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
947 # DeveloperMetadata.visibility. If left unspecified, all developer
948 # metadata visibile to the requesting project is considered.
949 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
950 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]951 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
952 # associated with locations of the specified type. For example, when this
953 # field is specified as ROW this lookup
954 # only considers developer metadata associated on rows. If the field is left
955 # unspecified, all location types are considered. This field cannot be
956 # specified as SPREADSHEET when
957 # the locationMatchingStrategy
958 # is specified as INTERSECTING or when the
959 # metadataLocation is specified as a
960 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
961 # developer metadata location. This field also must be left unspecified when
962 # the locationMatchingStrategy
963 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]964 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
965 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]966 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
967 # the specified location. This field either matches exact locations or all
968 # intersecting locations according the specified
969 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]970 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
971 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
972 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
973 # a dimension. The specified DimensionRange must represent a single row
974 # or column; it cannot be unbounded or span multiple rows or columns.
975 # All indexes are zero-based.
976 # Indexes are half open: the start index is inclusive
977 # and the end index is exclusive.
978 # Missing indexes indicate the range is unbounded on that side.
979 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]980 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]981 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
982 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]983 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]984 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]985 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]986 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
987 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]988 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]989 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]990 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]991 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]992 # and the end index is exclusive -- [start_index, end_index).
993 # Missing indexes indicate the range is unbounded on that side.
994 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]995 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]996 #
997 # `Sheet1!A1:A1 == sheet_id: 0,
998 # start_row_index: 0, end_row_index: 1,
999 # start_column_index: 0, end_column_index: 1`
1000 #
1001 # `Sheet1!A3:B4 == sheet_id: 0,
1002 # start_row_index: 2, end_row_index: 4,
1003 # start_column_index: 0, end_column_index: 2`
1004 #
1005 # `Sheet1!A:B == sheet_id: 0,
1006 # start_column_index: 0, end_column_index: 2`
1007 #
1008 # `Sheet1!A5:B == sheet_id: 0,
1009 # start_row_index: 4,
1010 # start_column_index: 0, end_column_index: 2`
1011 #
1012 # `Sheet1 == sheet_id:0`
1013 #
1014 # The start index must always be less than or equal to the end index.
1015 # If the start index equals the end index, then the range is empty.
1016 # Empty ranges are typically not meaningful and are usually rendered in the
1017 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1018 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1019 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1020 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
1021 &quot;sheetId&quot;: 42, # The sheet this range is on.
1022 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1023 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1024 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1025 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1026 &quot;values&quot;: [ # The data to be written. If the provided values exceed any of the ranges
1027 # matched by the data filter then the request fails. If the provided values
1028 # are less than the matched ranges only the specified values are written,
1029 # existing values in the matched ranges remain unaffected.
1030 [
1031 &quot;&quot;,
1032 ],
1033 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1034 },
1035 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1036 &quot;responseDateTimeRenderOption&quot;: &quot;A String&quot;, # Determines how dates, times, and durations in the response should be
1037 # rendered. This is ignored if response_value_render_option is
1038 # FORMATTED_VALUE.
1039 # The default dateTime render option is
1040 # DateTimeRenderOption.SERIAL_NUMBER.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1041 }
1042
1043 x__xgafv: string, V1 error format.
1044 Allowed values
1045 1 - v1 error format
1046 2 - v2 error format
1047
1048Returns:
1049 An object of the form:
1050
1051 { # The response when updating a range of values in a spreadsheet.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1052 &quot;totalUpdatedSheets&quot;: 42, # The total number of sheets where at least one cell in the sheet was
1053 # updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1054 &quot;totalUpdatedColumns&quot;: 42, # The total number of columns where at least one cell in the column was
1055 # updated.
1056 &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 -0700[diff] [blame]1057 &quot;totalUpdatedCells&quot;: 42, # The total number of cells updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1058 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1059 &quot;responses&quot;: [ # The response for each range updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1060 { # The response when updating a range of values by a data filter in a
1061 # spreadsheet.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1062 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1063 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells in the range matched by the dataFilter after all
1064 # updates were applied. This is only included if the request&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1065 # `includeValuesInResponse` field was `true`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1066 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1067 # the outer array representing all the data and each inner array
1068 # representing a major dimension. Each item in the inner array
1069 # corresponds with one cell.
1070 #
1071 # For output, empty trailing rows and columns will not be included.
1072 #
1073 # For input, supported value types are: bool, string, and double.
1074 # Null values will be skipped.
1075 # To set a cell to an empty value, set the string value to an empty string.
1076 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1077 &quot;&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1078 ],
1079 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1080 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1081 #
1082 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
1083 # then requesting `range=A1:B2,majorDimension=ROWS` will return
1084 # `[[1,2],[3,4]]`,
1085 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
1086 # `[[1,3],[2,4]]`.
1087 #
1088 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
1089 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
1090 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
1091 #
1092 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1093 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
1094 # For output, this range indicates the entire requested range,
1095 # even though the values will exclude trailing rows and columns.
1096 # When appending values, this field represents the range to search for a
1097 # table, after which values will be appended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1098 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1099 &quot;dataFilter&quot;: { # Filter that describes what data should be selected or returned from a # The data filter that selected the range that was updated.
1100 # request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1101 &quot;developerMetadataLookup&quot;: { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
1102 # described by this DeveloperMetadataLookup.
1103 # example, if only a metadata ID is specified this considers the
1104 # DeveloperMetadata with that particular unique ID. If a metadata key is
1105 # specified, this considers all developer metadata with that key. If a
1106 # key, visibility, and location type are all specified, this considers all
1107 # developer metadata with that key and visibility that are associated with a
1108 # location of that type. In general, this
1109 # selects all DeveloperMetadata that matches the intersection of all the
1110 # specified fields; any field or combination of fields may be specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1111 &quot;locationMatchingStrategy&quot;: &quot;A String&quot;, # Determines how this lookup matches the location. If this field is
1112 # specified as EXACT, only developer metadata associated on the exact
1113 # location specified is matched. If this field is specified to INTERSECTING,
1114 # developer metadata associated on intersecting locations is also
1115 # matched. If left unspecified, this field assumes a default value of
1116 # INTERSECTING.
1117 # If this field is specified, a metadataLocation
1118 # must also be specified.
1119 &quot;visibility&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
1120 # DeveloperMetadata.visibility. If left unspecified, all developer
1121 # metadata visibile to the requesting project is considered.
1122 &quot;metadataValue&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
1123 # DeveloperMetadata.metadata_value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1124 &quot;locationType&quot;: &quot;A String&quot;, # Limits the selected developer metadata to those entries which are
1125 # associated with locations of the specified type. For example, when this
1126 # field is specified as ROW this lookup
1127 # only considers developer metadata associated on rows. If the field is left
1128 # unspecified, all location types are considered. This field cannot be
1129 # specified as SPREADSHEET when
1130 # the locationMatchingStrategy
1131 # is specified as INTERSECTING or when the
1132 # metadataLocation is specified as a
1133 # non-spreadsheet location: spreadsheet metadata cannot intersect any other
1134 # developer metadata location. This field also must be left unspecified when
1135 # the locationMatchingStrategy
1136 # is specified as EXACT.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1137 &quot;metadataId&quot;: 42, # Limits the selected developer metadata to that which has a matching
1138 # DeveloperMetadata.metadata_id.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1139 &quot;metadataLocation&quot;: { # A location where metadata may be associated in a spreadsheet. # Limits the selected developer metadata to those entries associated with
1140 # the specified location. This field either matches exact locations or all
1141 # intersecting locations according the specified
1142 # locationMatchingStrategy.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1143 &quot;spreadsheet&quot;: True or False, # True when metadata is associated with an entire spreadsheet.
1144 &quot;locationType&quot;: &quot;A String&quot;, # The type of location this object represents. This field is read-only.
1145 &quot;dimensionRange&quot;: { # A range along a single dimension on a sheet. # Represents the row or column when metadata is associated with
1146 # a dimension. The specified DimensionRange must represent a single row
1147 # or column; it cannot be unbounded or span multiple rows or columns.
1148 # All indexes are zero-based.
1149 # Indexes are half open: the start index is inclusive
1150 # and the end index is exclusive.
1151 # Missing indexes indicate the range is unbounded on that side.
1152 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the span.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1153 &quot;startIndex&quot;: 42, # The start (inclusive) of the span, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1154 &quot;endIndex&quot;: 42, # The end (exclusive) of the span, or not set if unbounded.
1155 &quot;sheetId&quot;: 42, # The sheet this span is on.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1156 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1157 &quot;sheetId&quot;: 42, # The ID of the sheet when metadata is associated with an entire sheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1158 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1159 &quot;metadataKey&quot;: &quot;A String&quot;, # Limits the selected developer metadata to that which has a matching
1160 # DeveloperMetadata.metadata_key.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1161 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1162 &quot;gridRange&quot;: { # A range on a sheet. # Selects data that matches the range described by the GridRange.
1163 # All indexes are zero-based.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1164 # Indexes are half open, i.e. the start index is inclusive
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1165 # and the end index is exclusive -- [start_index, end_index).
1166 # Missing indexes indicate the range is unbounded on that side.
1167 #
1168 # For example, if `&quot;Sheet1&quot;` is sheet ID 0, then:
1169 #
1170 # `Sheet1!A1:A1 == sheet_id: 0,
1171 # start_row_index: 0, end_row_index: 1,
1172 # start_column_index: 0, end_column_index: 1`
1173 #
1174 # `Sheet1!A3:B4 == sheet_id: 0,
1175 # start_row_index: 2, end_row_index: 4,
1176 # start_column_index: 0, end_column_index: 2`
1177 #
1178 # `Sheet1!A:B == sheet_id: 0,
1179 # start_column_index: 0, end_column_index: 2`
1180 #
1181 # `Sheet1!A5:B == sheet_id: 0,
1182 # start_row_index: 4,
1183 # start_column_index: 0, end_column_index: 2`
1184 #
1185 # `Sheet1 == sheet_id:0`
1186 #
1187 # The start index must always be less than or equal to the end index.
1188 # If the start index equals the end index, then the range is empty.
1189 # Empty ranges are typically not meaningful and are usually rendered in the
1190 # UI as `#REF!`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1191 &quot;endColumnIndex&quot;: 42, # The end column (exclusive) of the range, or not set if unbounded.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1192 &quot;startColumnIndex&quot;: 42, # The start column (inclusive) of the range, or not set if unbounded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1193 &quot;endRowIndex&quot;: 42, # The end row (exclusive) of the range, or not set if unbounded.
1194 &quot;sheetId&quot;: 42, # The sheet this range is on.
1195 &quot;startRowIndex&quot;: 42, # The start row (inclusive) of the range, or not set if unbounded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1196 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1197 &quot;a1Range&quot;: &quot;A String&quot;, # Selects data that matches the specified A1 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1198 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1199 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1200 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1201 &quot;updatedCells&quot;: 42, # The number of cells updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1202 },
1203 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1204 }</pre>
1205</div>
1206
1207<div class="method">
1208 <code class="details" id="clear">clear(spreadsheetId, range, body=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1209 <pre>Clears values from a spreadsheet.
1210The caller must specify the spreadsheet ID and range.
1211Only values are cleared -- all other properties of the cell (such as
1212formatting, data validation, etc..) are kept.
1213
1214Args:
1215 spreadsheetId: string, The ID of the spreadsheet to update. (required)
1216 range: string, The A1 notation of the values to clear. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1217 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1218 The object takes the form of:
1219
1220{ # The request for clearing a range of values in a spreadsheet.
1221 }
1222
1223 x__xgafv: string, V1 error format.
1224 Allowed values
1225 1 - v1 error format
1226 2 - v2 error format
1227
1228Returns:
1229 An object of the form:
1230
1231 { # The response when clearing a range of values in a spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1232 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
1233 &quot;clearedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that was cleared.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1234 # (If the request was for an unbounded range or a ranger larger
1235 # than the bounds of the sheet, this will be the actual range
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1236 # that was cleared, bounded to the sheet&#x27;s limits.)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1237 }</pre>
1238</div>
1239
1240<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1241 <code class="details" id="get">get(spreadsheetId, range, dateTimeRenderOption=None, valueRenderOption=None, majorDimension=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1242 <pre>Returns a range of values from a spreadsheet.
1243The caller must specify the spreadsheet ID and a range.
1244
1245Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1246 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1247 range: string, The A1 notation of the values to retrieve. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1248 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
1249This is ignored if value_render_option is
1250FORMATTED_VALUE.
1251The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1252 valueRenderOption: string, How values should be represented in the output.
1253The default render option is ValueRenderOption.FORMATTED_VALUE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1254 majorDimension: string, The major dimension that results should use.
1255
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1256For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then
1257requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,
1258whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1259`[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1260 x__xgafv: string, V1 error format.
1261 Allowed values
1262 1 - v1 error format
1263 2 - v2 error format
1264
1265Returns:
1266 An object of the form:
1267
1268 { # Data within a range of the spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1269 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1270 # the outer array representing all the data and each inner array
1271 # representing a major dimension. Each item in the inner array
1272 # corresponds with one cell.
1273 #
1274 # For output, empty trailing rows and columns will not be included.
1275 #
1276 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1277 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1278 # To set a cell to an empty value, set the string value to an empty string.
1279 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1280 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1281 ],
1282 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1283 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1284 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1285 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
1286 # then requesting `range=A1:B2,majorDimension=ROWS` will return
1287 # `[[1,2],[3,4]]`,
1288 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
1289 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1290 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1291 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
1292 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
1293 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1294 #
1295 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1296 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
1297 # For output, this range indicates the entire requested range,
1298 # even though the values will exclude trailing rows and columns.
1299 # When appending values, this field represents the range to search for a
1300 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1301 }</pre>
1302</div>
1303
1304<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1305 <code class="details" id="update">update(spreadsheetId, range, body=None, responseValueRenderOption=None, responseDateTimeRenderOption=None, includeValuesInResponse=None, valueInputOption=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1306 <pre>Sets values in a range of a spreadsheet.
1307The caller must specify the spreadsheet ID, range, and
1308a valueInputOption.
1309
1310Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1311 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1312 range: string, The A1 notation of the values to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1313 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1314 The object takes the form of:
1315
1316{ # Data within a range of the spreadsheet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1317 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1318 # the outer array representing all the data and each inner array
1319 # representing a major dimension. Each item in the inner array
1320 # corresponds with one cell.
1321 #
1322 # For output, empty trailing rows and columns will not be included.
1323 #
1324 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1325 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1326 # To set a cell to an empty value, set the string value to an empty string.
1327 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1328 &quot;&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1329 ],
1330 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1331 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1332 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1333 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
1334 # then requesting `range=A1:B2,majorDimension=ROWS` will return
1335 # `[[1,2],[3,4]]`,
1336 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
1337 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1338 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1339 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
1340 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
1341 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1342 #
1343 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1344 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
1345 # For output, this range indicates the entire requested range,
1346 # even though the values will exclude trailing rows and columns.
1347 # When appending values, this field represents the range to search for a
1348 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1349}
1350
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1351 responseValueRenderOption: string, Determines how values in the response should be rendered.
1352The default render option is ValueRenderOption.FORMATTED_VALUE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1353 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be
1354rendered. This is ignored if response_value_render_option is
1355FORMATTED_VALUE.
1356The default dateTime render option is
1357DateTimeRenderOption.SERIAL_NUMBER.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1358 includeValuesInResponse: boolean, Determines if the update response should include the values
1359of the cells that were updated. By default, responses
1360do not include the updated values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1361If the range to write was larger than the range actually written, the
1362response includes all values in the requested range (excluding trailing
1363empty rows and columns).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1364 valueInputOption: string, How the input data should be interpreted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1365 x__xgafv: string, V1 error format.
1366 Allowed values
1367 1 - v1 error format
1368 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1369
1370Returns:
1371 An object of the form:
1372
1373 { # The response when updating a range of values in a spreadsheet.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1374 &quot;updatedRows&quot;: 42, # The number of rows where at least one cell in the row was updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1375 &quot;updatedColumns&quot;: 42, # The number of columns where at least one cell in the column was updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1376 &quot;updatedRange&quot;: &quot;A String&quot;, # The range (in A1 notation) that updates were applied to.
1377 &quot;updatedCells&quot;: 42, # The number of cells updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1378 &quot;spreadsheetId&quot;: &quot;A String&quot;, # The spreadsheet the updates were applied to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1379 &quot;updatedData&quot;: { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
1380 # This is only included if the request&#x27;s `includeValuesInResponse` field
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1381 # was `true`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1382 &quot;values&quot;: [ # The data that was read or to be written. This is an array of arrays,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1383 # the outer array representing all the data and each inner array
1384 # representing a major dimension. Each item in the inner array
1385 # corresponds with one cell.
1386 #
1387 # For output, empty trailing rows and columns will not be included.
1388 #
1389 # For input, supported value types are: bool, string, and double.
1390 # Null values will be skipped.
1391 # To set a cell to an empty value, set the string value to an empty string.
1392 [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1393 &quot;&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1394 ],
1395 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1396 &quot;majorDimension&quot;: &quot;A String&quot;, # The major dimension of the values.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1397 #
1398 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
1399 # then requesting `range=A1:B2,majorDimension=ROWS` will return
1400 # `[[1,2],[3,4]]`,
1401 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
1402 # `[[1,3],[2,4]]`.
1403 #
1404 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
1405 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
1406 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
1407 #
1408 # When writing, if this field is not set, it defaults to ROWS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]1409 &quot;range&quot;: &quot;A String&quot;, # The range the values cover, in A1 notation.
1410 # For output, this range indicates the entire requested range,
1411 # even though the values will exclude trailing rows and columns.
1412 # When appending values, this field represents the range to search for a
1413 # table, after which values will be appended.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1414 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1415 }</pre>
1416</div>
1417
1418</body></html>