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