Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 85c2c6d80859c466d29946e66ccd6a1c3a2df748 / . / docs / dyn / sheets_v4.spreadsheets.values.html
blob: f8d20f26d1dfca16b7b2ccfdeeb680deeae9f7bc [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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]78 <code><a href="#append">append(spreadsheetId, range=None, body, insertDataOption=None, valueInputOption=None, x__xgafv=None)</a></code></p>
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">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]84 <code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns one or more ranges of values from a spreadsheet.</p>
86<p class="toc_element">
87 <code><a href="#batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]88<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]89<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90 <code><a href="#clear">clear(spreadsheetId, range, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Clears values from a spreadsheet.</p>
92<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]93 <code><a href="#get">get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Returns a range of values from a spreadsheet.</p>
95<p class="toc_element">
96 <code><a href="#update">update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Sets values in a range of a spreadsheet.</p>
98<h3>Method Details</h3>
99<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]100 <code class="details" id="append">append(spreadsheetId, range=None, body, insertDataOption=None, valueInputOption=None, x__xgafv=None)</code>
101 <pre>Appends values to a spreadsheet. The input range is used to search for
102existing data and find a "table" within that range. Values will be
103appended to the next row of the table, starting with the first column of
104the table. See the
105[guide](/sheets/guides/values#appending_values)
106and
107[sample code](/sheets/samples/writing#append_values)
108for specific details of how tables are detected and data is appended.
109
110The caller must specify the spreadsheet ID, range, and
111a valueInputOption. The `valueInputOption` only
112controls how the input data will be added to the sheet (column-wise or
113row-wise), it does not influence what cell the data starts being written
114to.
115
116Args:
117 spreadsheetId: string, The ID of the spreadsheet to update. (required)
118 range: string, The A1 notation of a range to search for a logical table of data.
119Values will be appended after the last row of the table. (required)
120 body: object, The request body. (required)
121 The object takes the form of:
122
123{ # Data within a range of the spreadsheet.
124 "range": "A String", # The range the values cover, in A1 notation.
125 # For output, this range indicates the entire requested range,
126 # even though the values will exclude trailing rows and columns.
127 # When appending values, this field represents the range to search for a
128 # table, after which values will be appended.
129 "values": [ # The data that was read or to be written. This is an array of arrays,
130 # the outer array representing all the data and each inner array
131 # representing a major dimension. Each item in the inner array
132 # corresponds with one cell.
133 #
134 # For output, empty trailing rows and columns will not be included.
135 #
136 # For input, supported value types are: bool, string, and double.
137 # Null values will be skipped.
138 # To set a cell to an empty value, set the string value to an empty string.
139 [
140 "",
141 ],
142 ],
143 "majorDimension": "A String", # The major dimension of the values.
144 #
145 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
146 # then requesting `range=A1:B2,majorDimension=ROWS` will return
147 # `[[1,2],[3,4]]`,
148 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
149 # `[[1,3],[2,4]]`.
150 #
151 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
152 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
153 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
154 #
155 # When writing, if this field is not set, it defaults to ROWS.
156}
157
158 insertDataOption: string, How the input data should be inserted.
159 valueInputOption: string, How the input data should be interpreted.
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
168 { # The response when updating a range of values in a spreadsheet.
169 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
170 "tableRange": "A String", # The range (in A1 notation) of the table that values are being appended to
171 # (before the values were appended).
172 # Empty if no table was found.
173 "updates": { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied.
174 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
175 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
176 "updatedCells": 42, # The number of cells updated.
177 "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
178 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
179 },
180 }</pre>
181</div>
182
183<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]184 <code class="details" id="batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</code>
185 <pre>Clears one or more ranges of values from a spreadsheet.
186The caller must specify the spreadsheet ID and one or more ranges.
187Only values are cleared -- all other properties of the cell (such as
188formatting, data validation, etc..) are kept.
189
190Args:
191 spreadsheetId: string, The ID of the spreadsheet to update. (required)
192 body: object, The request body. (required)
193 The object takes the form of:
194
195{ # The request for clearing more than one range of values in a spreadsheet.
196 "ranges": [ # The ranges to clear, in A1 notation.
197 "A String",
198 ],
199 }
200
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # The response when updating a range of values in a spreadsheet.
210 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
211 "clearedRanges": [ # The ranges that were cleared, in A1 notation.
212 # (If the requests were for an unbounded range or a ranger larger
213 # than the bounds of the sheet, this will be the actual ranges
214 # that were cleared, bounded to the sheet's limits.)
215 "A String",
216 ],
217 }</pre>
218</div>
219
220<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]221 <code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</code>
222 <pre>Returns one or more ranges of values from a spreadsheet.
223The caller must specify the spreadsheet ID and one or more ranges.
224
225Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]226 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]227 valueRenderOption: string, How values should be represented in the output.
228 majorDimension: string, The major dimension that results should use.
229
230For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
231then requesting `range=A1:B2,majorDimension=ROWS` will return
232`[[1,2],[3,4]]`,
233whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
234`[[1,3],[2,4]]`.
235 ranges: string, The A1 notation of the values to retrieve. (repeated)
236 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]237This is ignored if value_render_option is
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238FORMATTED_VALUE.
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # The response when retrieving more than one range of values in a spreadsheet.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]248 "spreadsheetId": "A String", # The ID of the spreadsheet the data was retrieved from.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]249 "valueRanges": [ # The requested values. The order of the ValueRanges is the same as the
250 # order of the requested ranges.
251 { # Data within a range of the spreadsheet.
252 "range": "A String", # The range the values cover, in A1 notation.
253 # For output, this range indicates the entire requested range,
254 # even though the values will exclude trailing rows and columns.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]255 # When appending values, this field represents the range to search for a
256 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]257 "values": [ # The data that was read or to be written. This is an array of arrays,
258 # the outer array representing all the data and each inner array
259 # representing a major dimension. Each item in the inner array
260 # corresponds with one cell.
261 #
262 # For output, empty trailing rows and columns will not be included.
263 #
264 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]265 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]266 # To set a cell to an empty value, set the string value to an empty string.
267 [
268 "",
269 ],
270 ],
271 "majorDimension": "A String", # The major dimension of the values.
272 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]273 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
274 # then requesting `range=A1:B2,majorDimension=ROWS` will return
275 # `[[1,2],[3,4]]`,
276 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
277 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]278 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]279 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
280 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
281 # 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]282 #
283 # When writing, if this field is not set, it defaults to ROWS.
284 },
285 ],
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]291 <pre>Sets values in one or more ranges of a spreadsheet.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]292The caller must specify the spreadsheet ID,
293a valueInputOption, and one or more
294ValueRanges.
295
296Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]297 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]298 body: object, The request body. (required)
299 The object takes the form of:
300
301{ # The request for updating more than one range of values in a spreadsheet.
302 "data": [ # The new values to apply to the spreadsheet.
303 { # Data within a range of the spreadsheet.
304 "range": "A String", # The range the values cover, in A1 notation.
305 # For output, this range indicates the entire requested range,
306 # even though the values will exclude trailing rows and columns.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]307 # When appending values, this field represents the range to search for a
308 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]309 "values": [ # The data that was read or to be written. This is an array of arrays,
310 # the outer array representing all the data and each inner array
311 # representing a major dimension. Each item in the inner array
312 # corresponds with one cell.
313 #
314 # For output, empty trailing rows and columns will not be included.
315 #
316 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]317 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]318 # To set a cell to an empty value, set the string value to an empty string.
319 [
320 "",
321 ],
322 ],
323 "majorDimension": "A String", # The major dimension of the values.
324 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]325 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
326 # then requesting `range=A1:B2,majorDimension=ROWS` will return
327 # `[[1,2],[3,4]]`,
328 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
329 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]330 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]331 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
332 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
333 # 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]334 #
335 # When writing, if this field is not set, it defaults to ROWS.
336 },
337 ],
338 "valueInputOption": "A String", # How the input data should be interpreted.
339 }
340
341 x__xgafv: string, V1 error format.
342 Allowed values
343 1 - v1 error format
344 2 - v2 error format
345
346Returns:
347 An object of the form:
348
349 { # The response when updating a range of values in a spreadsheet.
350 "responses": [ # One UpdateValuesResponse per requested range, in the same order as
351 # the requests appeared.
352 { # The response when updating a range of values in a spreadsheet.
353 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
354 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
355 "updatedCells": 42, # The number of cells updated.
356 "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
357 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
358 },
359 ],
360 "totalUpdatedCells": 42, # The total number of cells updated.
361 "totalUpdatedColumns": 42, # The total number of columns where at least one cell in the column was
362 # updated.
363 "totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated.
364 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
365 "totalUpdatedSheets": 42, # The total number of sheets where at least one cell in the sheet was
366 # updated.
367 }</pre>
368</div>
369
370<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 <code class="details" id="clear">clear(spreadsheetId, range, body, x__xgafv=None)</code>
372 <pre>Clears values from a spreadsheet.
373The caller must specify the spreadsheet ID and range.
374Only values are cleared -- all other properties of the cell (such as
375formatting, data validation, etc..) are kept.
376
377Args:
378 spreadsheetId: string, The ID of the spreadsheet to update. (required)
379 range: string, The A1 notation of the values to clear. (required)
380 body: object, The request body. (required)
381 The object takes the form of:
382
383{ # The request for clearing a range of values in a spreadsheet.
384 }
385
386 x__xgafv: string, V1 error format.
387 Allowed values
388 1 - v1 error format
389 2 - v2 error format
390
391Returns:
392 An object of the form:
393
394 { # The response when clearing a range of values in a spreadsheet.
395 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
396 "clearedRange": "A String", # The range (in A1 notation) that was cleared.
397 # (If the request was for an unbounded range or a ranger larger
398 # than the bounds of the sheet, this will be the actual range
399 # that was cleared, bounded to the sheet's limits.)
400 }</pre>
401</div>
402
403<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]404 <code class="details" id="get">get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</code>
405 <pre>Returns a range of values from a spreadsheet.
406The caller must specify the spreadsheet ID and a range.
407
408Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]409 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]410 range: string, The A1 notation of the values to retrieve. (required)
411 valueRenderOption: string, How values should be represented in the output.
412 majorDimension: string, The major dimension that results should use.
413
414For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
415then requesting `range=A1:B2,majorDimension=ROWS` will return
416`[[1,2],[3,4]]`,
417whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
418`[[1,3],[2,4]]`.
419 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]420This is ignored if value_render_option is
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]421FORMATTED_VALUE.
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427Returns:
428 An object of the form:
429
430 { # Data within a range of the spreadsheet.
431 "range": "A String", # The range the values cover, in A1 notation.
432 # For output, this range indicates the entire requested range,
433 # even though the values will exclude trailing rows and columns.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]434 # When appending values, this field represents the range to search for a
435 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]436 "values": [ # The data that was read or to be written. This is an array of arrays,
437 # the outer array representing all the data and each inner array
438 # representing a major dimension. Each item in the inner array
439 # corresponds with one cell.
440 #
441 # For output, empty trailing rows and columns will not be included.
442 #
443 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]444 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]445 # To set a cell to an empty value, set the string value to an empty string.
446 [
447 "",
448 ],
449 ],
450 "majorDimension": "A String", # The major dimension of the values.
451 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]452 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
453 # then requesting `range=A1:B2,majorDimension=ROWS` will return
454 # `[[1,2],[3,4]]`,
455 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
456 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]457 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]458 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
459 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
460 # 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]461 #
462 # When writing, if this field is not set, it defaults to ROWS.
463 }</pre>
464</div>
465
466<div class="method">
467 <code class="details" id="update">update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None)</code>
468 <pre>Sets values in a range of a spreadsheet.
469The caller must specify the spreadsheet ID, range, and
470a valueInputOption.
471
472Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]473 spreadsheetId: string, The ID of the spreadsheet to update. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]474 range: string, The A1 notation of the values to update. (required)
475 body: object, The request body. (required)
476 The object takes the form of:
477
478{ # Data within a range of the spreadsheet.
479 "range": "A String", # The range the values cover, in A1 notation.
480 # For output, this range indicates the entire requested range,
481 # even though the values will exclude trailing rows and columns.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]482 # When appending values, this field represents the range to search for a
483 # table, after which values will be appended.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]484 "values": [ # The data that was read or to be written. This is an array of arrays,
485 # the outer array representing all the data and each inner array
486 # representing a major dimension. Each item in the inner array
487 # corresponds with one cell.
488 #
489 # For output, empty trailing rows and columns will not be included.
490 #
491 # For input, supported value types are: bool, string, and double.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]492 # Null values will be skipped.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]493 # To set a cell to an empty value, set the string value to an empty string.
494 [
495 "",
496 ],
497 ],
498 "majorDimension": "A String", # The major dimension of the values.
499 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]500 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
501 # then requesting `range=A1:B2,majorDimension=ROWS` will return
502 # `[[1,2],[3,4]]`,
503 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
504 # `[[1,3],[2,4]]`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]505 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]506 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
507 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
508 # 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]509 #
510 # When writing, if this field is not set, it defaults to ROWS.
511}
512
513 valueInputOption: string, How the input data should be interpreted.
514 x__xgafv: string, V1 error format.
515 Allowed values
516 1 - v1 error format
517 2 - v2 error format
518
519Returns:
520 An object of the form:
521
522 { # The response when updating a range of values in a spreadsheet.
523 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
524 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
525 "updatedCells": 42, # The number of cells updated.
526 "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
527 "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
528 }</pre>
529</div>
530
531</body></html>