1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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"> 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> 79 <p class="firstline">Appends values to a spreadsheet. The input range is used to search for</p> 80 <p class="toc_element"> 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"> 84 <code><a href="#batchGet">batchGet(spreadsheetId, majorDimension=None, ranges=None, dateTimeRenderOption=None, valueRenderOption=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> 88 <p class="firstline">Sets values in one or more ranges of a spreadsheet.</p> 89 <p class="toc_element"> 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"> 93 <code><a href="#get">get(spreadsheetId, range, majorDimension=None, dateTimeRenderOption=None, valueRenderOption=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, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=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"> 100 <code class="details" id="append">append(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, insertDataOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code> 101 <pre>Appends values to a spreadsheet. The input range is used to search for 102 existing data and find a "table" within that range. Values will be 103 appended to the next row of the table, starting with the first column of 104 the table. See the 105 [guide](/sheets/api/guides/values#appending_values) 106 and 107 [sample code](/sheets/api/samples/writing#append_values) 108 for specific details of how tables are detected and data is appended. 109 110 The caller must specify the spreadsheet ID, range, and 111 a valueInputOption. The `valueInputOption` only 112 controls how the input data will be added to the sheet (column-wise or 113 row-wise), it does not influence what cell the data starts being written 114 to. 115 116 Args: 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. 119 Values 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 valueInputOption: string, How the input data should be interpreted. 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 responseValueRenderOption: string, Determines how values in the response should be rendered. 164 The default render option is ValueRenderOption.FORMATTED_VALUE. 165 insertDataOption: string, How the input data should be inserted. 166 includeValuesInResponse: boolean, Determines if the update response should include the values 167 of the cells that were appended. By default, responses 168 do not include the updated values. 169 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be 170 rendered. This is ignored if response_value_render_option is 171 FORMATTED_VALUE. 172 The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. 173 174 Returns: 175 An object of the form: 176 177 { # The response when updating a range of values in a spreadsheet. 178 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 179 "tableRange": "A String", # The range (in A1 notation) of the table that values are being appended to 180 # (before the values were appended). 181 # Empty if no table was found. 182 "updates": { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied. 183 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to. 184 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated. 185 "updatedRows": 42, # The number of rows where at least one cell in the row was updated. 186 "updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. 187 # This is only included if the request's `includeValuesInResponse` field 188 # was `true`. 189 "range": "A String", # The range the values cover, in A1 notation. 190 # For output, this range indicates the entire requested range, 191 # even though the values will exclude trailing rows and columns. 192 # When appending values, this field represents the range to search for a 193 # table, after which values will be appended. 194 "values": [ # The data that was read or to be written. This is an array of arrays, 195 # the outer array representing all the data and each inner array 196 # representing a major dimension. Each item in the inner array 197 # corresponds with one cell. 198 # 199 # For output, empty trailing rows and columns will not be included. 200 # 201 # For input, supported value types are: bool, string, and double. 202 # Null values will be skipped. 203 # To set a cell to an empty value, set the string value to an empty string. 204 [ 205 "", 206 ], 207 ], 208 "majorDimension": "A String", # The major dimension of the values. 209 # 210 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 211 # then requesting `range=A1:B2,majorDimension=ROWS` will return 212 # `[[1,2],[3,4]]`, 213 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 214 # `[[1,3],[2,4]]`. 215 # 216 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 217 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 218 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 219 # 220 # When writing, if this field is not set, it defaults to ROWS. 221 }, 222 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 223 "updatedCells": 42, # The number of cells updated. 224 }, 225 }</pre> 226 </div> 227 228 <div class="method"> 229 <code class="details" id="batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</code> 230 <pre>Clears one or more ranges of values from a spreadsheet. 231 The caller must specify the spreadsheet ID and one or more ranges. 232 Only values are cleared -- all other properties of the cell (such as 233 formatting, data validation, etc..) are kept. 234 235 Args: 236 spreadsheetId: string, The ID of the spreadsheet to update. (required) 237 body: object, The request body. (required) 238 The object takes the form of: 239 240 { # The request for clearing more than one range of values in a spreadsheet. 241 "ranges": [ # The ranges to clear, in A1 notation. 242 "A String", 243 ], 244 } 245 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251 Returns: 252 An object of the form: 253 254 { # The response when clearing a range of values in a spreadsheet. 255 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 256 "clearedRanges": [ # The ranges that were cleared, in A1 notation. 257 # (If the requests were for an unbounded range or a ranger larger 258 # than the bounds of the sheet, this will be the actual ranges 259 # that were cleared, bounded to the sheet's limits.) 260 "A String", 261 ], 262 }</pre> 263 </div> 264 265 <div class="method"> 266 <code class="details" id="batchGet">batchGet(spreadsheetId, majorDimension=None, ranges=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</code> 267 <pre>Returns one or more ranges of values from a spreadsheet. 268 The caller must specify the spreadsheet ID and one or more ranges. 269 270 Args: 271 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required) 272 majorDimension: string, The major dimension that results should use. 273 274 For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 275 then requesting `range=A1:B2,majorDimension=ROWS` will return 276 `[[1,2],[3,4]]`, 277 whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 278 `[[1,3],[2,4]]`. 279 ranges: string, The A1 notation of the values to retrieve. (repeated) 280 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output. 281 This is ignored if value_render_option is 282 FORMATTED_VALUE. 283 The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. 284 valueRenderOption: string, How values should be represented in the output. 285 The default render option is ValueRenderOption.FORMATTED_VALUE. 286 x__xgafv: string, V1 error format. 287 Allowed values 288 1 - v1 error format 289 2 - v2 error format 290 291 Returns: 292 An object of the form: 293 294 { # The response when retrieving more than one range of values in a spreadsheet. 295 "spreadsheetId": "A String", # The ID of the spreadsheet the data was retrieved from. 296 "valueRanges": [ # The requested values. The order of the ValueRanges is the same as the 297 # order of the requested ranges. 298 { # Data within a range of the spreadsheet. 299 "range": "A String", # The range the values cover, in A1 notation. 300 # For output, this range indicates the entire requested range, 301 # even though the values will exclude trailing rows and columns. 302 # When appending values, this field represents the range to search for a 303 # table, after which values will be appended. 304 "values": [ # The data that was read or to be written. This is an array of arrays, 305 # the outer array representing all the data and each inner array 306 # representing a major dimension. Each item in the inner array 307 # corresponds with one cell. 308 # 309 # For output, empty trailing rows and columns will not be included. 310 # 311 # For input, supported value types are: bool, string, and double. 312 # Null values will be skipped. 313 # To set a cell to an empty value, set the string value to an empty string. 314 [ 315 "", 316 ], 317 ], 318 "majorDimension": "A String", # The major dimension of the values. 319 # 320 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 321 # then requesting `range=A1:B2,majorDimension=ROWS` will return 322 # `[[1,2],[3,4]]`, 323 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 324 # `[[1,3],[2,4]]`. 325 # 326 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 327 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 328 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 329 # 330 # When writing, if this field is not set, it defaults to ROWS. 331 }, 332 ], 333 }</pre> 334 </div> 335 336 <div class="method"> 337 <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</code> 338 <pre>Sets values in one or more ranges of a spreadsheet. 339 The caller must specify the spreadsheet ID, 340 a valueInputOption, and one or more 341 ValueRanges. 342 343 Args: 344 spreadsheetId: string, The ID of the spreadsheet to update. (required) 345 body: object, The request body. (required) 346 The object takes the form of: 347 348 { # The request for updating more than one range of values in a spreadsheet. 349 "valueInputOption": "A String", # How the input data should be interpreted. 350 "data": [ # The new values to apply to the spreadsheet. 351 { # Data within a range of the spreadsheet. 352 "range": "A String", # The range the values cover, in A1 notation. 353 # For output, this range indicates the entire requested range, 354 # even though the values will exclude trailing rows and columns. 355 # When appending values, this field represents the range to search for a 356 # table, after which values will be appended. 357 "values": [ # The data that was read or to be written. This is an array of arrays, 358 # the outer array representing all the data and each inner array 359 # representing a major dimension. Each item in the inner array 360 # corresponds with one cell. 361 # 362 # For output, empty trailing rows and columns will not be included. 363 # 364 # For input, supported value types are: bool, string, and double. 365 # Null values will be skipped. 366 # To set a cell to an empty value, set the string value to an empty string. 367 [ 368 "", 369 ], 370 ], 371 "majorDimension": "A String", # The major dimension of the values. 372 # 373 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 374 # then requesting `range=A1:B2,majorDimension=ROWS` will return 375 # `[[1,2],[3,4]]`, 376 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 377 # `[[1,3],[2,4]]`. 378 # 379 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 380 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 381 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 382 # 383 # When writing, if this field is not set, it defaults to ROWS. 384 }, 385 ], 386 "responseDateTimeRenderOption": "A String", # Determines how dates, times, and durations in the response should be 387 # rendered. This is ignored if response_value_render_option is 388 # FORMATTED_VALUE. 389 # The default dateTime render option is 390 # DateTimeRenderOption.SERIAL_NUMBER. 391 "responseValueRenderOption": "A String", # Determines how values in the response should be rendered. 392 # The default render option is ValueRenderOption.FORMATTED_VALUE. 393 "includeValuesInResponse": True or False, # Determines if the update response should include the values 394 # of the cells that were updated. By default, responses 395 # do not include the updated values. The `updatedData` field within 396 # each of the BatchUpdateValuesResponse.responses will contain 397 # the updated values. If the range to write was larger than than the range 398 # actually written, the response will include all values in the requested 399 # range (excluding trailing empty rows and columns). 400 } 401 402 x__xgafv: string, V1 error format. 403 Allowed values 404 1 - v1 error format 405 2 - v2 error format 406 407 Returns: 408 An object of the form: 409 410 { # The response when updating a range of values in a spreadsheet. 411 "responses": [ # One UpdateValuesResponse per requested range, in the same order as 412 # the requests appeared. 413 { # The response when updating a range of values in a spreadsheet. 414 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to. 415 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated. 416 "updatedRows": 42, # The number of rows where at least one cell in the row was updated. 417 "updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. 418 # This is only included if the request's `includeValuesInResponse` field 419 # was `true`. 420 "range": "A String", # The range the values cover, in A1 notation. 421 # For output, this range indicates the entire requested range, 422 # even though the values will exclude trailing rows and columns. 423 # When appending values, this field represents the range to search for a 424 # table, after which values will be appended. 425 "values": [ # The data that was read or to be written. This is an array of arrays, 426 # the outer array representing all the data and each inner array 427 # representing a major dimension. Each item in the inner array 428 # corresponds with one cell. 429 # 430 # For output, empty trailing rows and columns will not be included. 431 # 432 # For input, supported value types are: bool, string, and double. 433 # Null values will be skipped. 434 # To set a cell to an empty value, set the string value to an empty string. 435 [ 436 "", 437 ], 438 ], 439 "majorDimension": "A String", # The major dimension of the values. 440 # 441 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 442 # then requesting `range=A1:B2,majorDimension=ROWS` will return 443 # `[[1,2],[3,4]]`, 444 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 445 # `[[1,3],[2,4]]`. 446 # 447 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 448 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 449 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 450 # 451 # When writing, if this field is not set, it defaults to ROWS. 452 }, 453 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 454 "updatedCells": 42, # The number of cells updated. 455 }, 456 ], 457 "totalUpdatedColumns": 42, # The total number of columns where at least one cell in the column was 458 # updated. 459 "totalUpdatedCells": 42, # The total number of cells updated. 460 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 461 "totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated. 462 "totalUpdatedSheets": 42, # The total number of sheets where at least one cell in the sheet was 463 # updated. 464 }</pre> 465 </div> 466 467 <div class="method"> 468 <code class="details" id="clear">clear(spreadsheetId, range, body, x__xgafv=None)</code> 469 <pre>Clears values from a spreadsheet. 470 The caller must specify the spreadsheet ID and range. 471 Only values are cleared -- all other properties of the cell (such as 472 formatting, data validation, etc..) are kept. 473 474 Args: 475 spreadsheetId: string, The ID of the spreadsheet to update. (required) 476 range: string, The A1 notation of the values to clear. (required) 477 body: object, The request body. (required) 478 The object takes the form of: 479 480 { # The request for clearing a range of values in a spreadsheet. 481 } 482 483 x__xgafv: string, V1 error format. 484 Allowed values 485 1 - v1 error format 486 2 - v2 error format 487 488 Returns: 489 An object of the form: 490 491 { # The response when clearing a range of values in a spreadsheet. 492 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 493 "clearedRange": "A String", # The range (in A1 notation) that was cleared. 494 # (If the request was for an unbounded range or a ranger larger 495 # than the bounds of the sheet, this will be the actual range 496 # that was cleared, bounded to the sheet's limits.) 497 }</pre> 498 </div> 499 500 <div class="method"> 501 <code class="details" id="get">get(spreadsheetId, range, majorDimension=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</code> 502 <pre>Returns a range of values from a spreadsheet. 503 The caller must specify the spreadsheet ID and a range. 504 505 Args: 506 spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required) 507 range: string, The A1 notation of the values to retrieve. (required) 508 majorDimension: string, The major dimension that results should use. 509 510 For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 511 then requesting `range=A1:B2,majorDimension=ROWS` will return 512 `[[1,2],[3,4]]`, 513 whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 514 `[[1,3],[2,4]]`. 515 dateTimeRenderOption: string, How dates, times, and durations should be represented in the output. 516 This is ignored if value_render_option is 517 FORMATTED_VALUE. 518 The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. 519 valueRenderOption: string, How values should be represented in the output. 520 The default render option is ValueRenderOption.FORMATTED_VALUE. 521 x__xgafv: string, V1 error format. 522 Allowed values 523 1 - v1 error format 524 2 - v2 error format 525 526 Returns: 527 An object of the form: 528 529 { # Data within a range of the spreadsheet. 530 "range": "A String", # The range the values cover, in A1 notation. 531 # For output, this range indicates the entire requested range, 532 # even though the values will exclude trailing rows and columns. 533 # When appending values, this field represents the range to search for a 534 # table, after which values will be appended. 535 "values": [ # The data that was read or to be written. This is an array of arrays, 536 # the outer array representing all the data and each inner array 537 # representing a major dimension. Each item in the inner array 538 # corresponds with one cell. 539 # 540 # For output, empty trailing rows and columns will not be included. 541 # 542 # For input, supported value types are: bool, string, and double. 543 # Null values will be skipped. 544 # To set a cell to an empty value, set the string value to an empty string. 545 [ 546 "", 547 ], 548 ], 549 "majorDimension": "A String", # The major dimension of the values. 550 # 551 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 552 # then requesting `range=A1:B2,majorDimension=ROWS` will return 553 # `[[1,2],[3,4]]`, 554 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 555 # `[[1,3],[2,4]]`. 556 # 557 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 558 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 559 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 560 # 561 # When writing, if this field is not set, it defaults to ROWS. 562 }</pre> 563 </div> 564 565 <div class="method"> 566 <code class="details" id="update">update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code> 567 <pre>Sets values in a range of a spreadsheet. 568 The caller must specify the spreadsheet ID, range, and 569 a valueInputOption. 570 571 Args: 572 spreadsheetId: string, The ID of the spreadsheet to update. (required) 573 range: string, The A1 notation of the values to update. (required) 574 body: object, The request body. (required) 575 The object takes the form of: 576 577 { # Data within a range of the spreadsheet. 578 "range": "A String", # The range the values cover, in A1 notation. 579 # For output, this range indicates the entire requested range, 580 # even though the values will exclude trailing rows and columns. 581 # When appending values, this field represents the range to search for a 582 # table, after which values will be appended. 583 "values": [ # The data that was read or to be written. This is an array of arrays, 584 # the outer array representing all the data and each inner array 585 # representing a major dimension. Each item in the inner array 586 # corresponds with one cell. 587 # 588 # For output, empty trailing rows and columns will not be included. 589 # 590 # For input, supported value types are: bool, string, and double. 591 # Null values will be skipped. 592 # To set a cell to an empty value, set the string value to an empty string. 593 [ 594 "", 595 ], 596 ], 597 "majorDimension": "A String", # The major dimension of the values. 598 # 599 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 600 # then requesting `range=A1:B2,majorDimension=ROWS` will return 601 # `[[1,2],[3,4]]`, 602 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 603 # `[[1,3],[2,4]]`. 604 # 605 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 606 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 607 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 608 # 609 # When writing, if this field is not set, it defaults to ROWS. 610 } 611 612 valueInputOption: string, How the input data should be interpreted. 613 x__xgafv: string, V1 error format. 614 Allowed values 615 1 - v1 error format 616 2 - v2 error format 617 responseValueRenderOption: string, Determines how values in the response should be rendered. 618 The default render option is ValueRenderOption.FORMATTED_VALUE. 619 includeValuesInResponse: boolean, Determines if the update response should include the values 620 of the cells that were updated. By default, responses 621 do not include the updated values. 622 If the range to write was larger than than the range actually written, 623 the response will include all values in the requested range (excluding 624 trailing empty rows and columns). 625 responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be 626 rendered. This is ignored if response_value_render_option is 627 FORMATTED_VALUE. 628 The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. 629 630 Returns: 631 An object of the form: 632 633 { # The response when updating a range of values in a spreadsheet. 634 "updatedRange": "A String", # The range (in A1 notation) that updates were applied to. 635 "updatedColumns": 42, # The number of columns where at least one cell in the column was updated. 636 "updatedRows": 42, # The number of rows where at least one cell in the row was updated. 637 "updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied. 638 # This is only included if the request's `includeValuesInResponse` field 639 # was `true`. 640 "range": "A String", # The range the values cover, in A1 notation. 641 # For output, this range indicates the entire requested range, 642 # even though the values will exclude trailing rows and columns. 643 # When appending values, this field represents the range to search for a 644 # table, after which values will be appended. 645 "values": [ # The data that was read or to be written. This is an array of arrays, 646 # the outer array representing all the data and each inner array 647 # representing a major dimension. Each item in the inner array 648 # corresponds with one cell. 649 # 650 # For output, empty trailing rows and columns will not be included. 651 # 652 # For input, supported value types are: bool, string, and double. 653 # Null values will be skipped. 654 # To set a cell to an empty value, set the string value to an empty string. 655 [ 656 "", 657 ], 658 ], 659 "majorDimension": "A String", # The major dimension of the values. 660 # 661 # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, 662 # then requesting `range=A1:B2,majorDimension=ROWS` will return 663 # `[[1,2],[3,4]]`, 664 # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return 665 # `[[1,3],[2,4]]`. 666 # 667 # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` 668 # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` 669 # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. 670 # 671 # When writing, if this field is not set, it defaults to ROWS. 672 }, 673 "spreadsheetId": "A String", # The spreadsheet the updates were applied to. 674 "updatedCells": 42, # The number of cells updated. 675 }</pre> 676 </div> 677 678 </body></html>
