OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/drive.readonly": { | 5 "https://www.googleapis.com/auth/drive.readonly": { |
6 "description": "View the files in your Google Drive" | 6 "description": "View the files in your Google Drive" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/spreadsheets.readonly": { | 8 "https://www.googleapis.com/auth/spreadsheets.readonly": { |
9 "description": "View your Google Spreadsheets" | 9 "description": "View your Google Spreadsheets" |
10 }, | 10 }, |
(...skipping 193 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
204 }, | 204 }, |
205 "scopes": [ | 205 "scopes": [ |
206 "https://www.googleapis.com/auth/drive", | 206 "https://www.googleapis.com/auth/drive", |
207 "https://www.googleapis.com/auth/spreadsheets" | 207 "https://www.googleapis.com/auth/spreadsheets" |
208 ] | 208 ] |
209 } | 209 } |
210 }, | 210 }, |
211 "resources": { | 211 "resources": { |
212 "values": { | 212 "values": { |
213 "methods": { | 213 "methods": { |
214 "append": { | 214 "clear": { |
215 "description": "Appends values to a spreadsheet. The
input range is used to search for\nexisting data and find a \"table\" within th
at range. Values will be\nappended to the next row of the table, starting with t
he first column of\nthe table. See the\n[guide](/sheets/guides/values#appending_
values)\nand\n[sample code](/sheets/samples/writing#append_values)\nfor specific
details of how tables are detected and data is appended.\n\nThe caller must spe
cify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption`
only\ncontrols how the input data will be added to the sheet (column-wise or\nr
ow-wise), it does not influence what cell the data starts being written\nto.", | 215 "description": "Clears values from a spreadsheet.\nT
he caller must specify the spreadsheet ID and range.\nOnly values are cleared --
all other properties of the cell (such as\nformatting, data validation, etc..)
are kept.", |
216 "httpMethod": "POST", | 216 "httpMethod": "POST", |
217 "id": "sheets.spreadsheets.values.append", | 217 "id": "sheets.spreadsheets.values.clear", |
218 "parameterOrder": [ | 218 "parameterOrder": [ |
219 "spreadsheetId", | 219 "spreadsheetId", |
220 "range" | 220 "range" |
221 ], | 221 ], |
222 "parameters": { | 222 "parameters": { |
223 "valueInputOption": { | |
224 "description": "How the input data should be
interpreted.", | |
225 "enum": [ | |
226 "INPUT_VALUE_OPTION_UNSPECIFIED", | |
227 "RAW", | |
228 "USER_ENTERED" | |
229 ], | |
230 "location": "query", | |
231 "type": "string" | |
232 }, | |
233 "spreadsheetId": { | |
234 "description": "The ID of the spreadsheet to
update.", | |
235 "location": "path", | |
236 "required": true, | |
237 "type": "string" | |
238 }, | |
239 "insertDataOption": { | |
240 "description": "How the input data should be
inserted.", | |
241 "enum": [ | |
242 "OVERWRITE", | |
243 "INSERT_ROWS" | |
244 ], | |
245 "location": "query", | |
246 "type": "string" | |
247 }, | |
248 "range": { | |
249 "description": "The A1 notation of a range t
o search for a logical table of data.\nValues will be appended after the last ro
w of the table.", | |
250 "location": "path", | |
251 "required": true, | |
252 "type": "string" | |
253 } | |
254 }, | |
255 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:append", | |
256 "request": { | |
257 "$ref": "ValueRange" | |
258 }, | |
259 "response": { | |
260 "$ref": "AppendValuesResponse" | |
261 }, | |
262 "scopes": [ | |
263 "https://www.googleapis.com/auth/drive", | |
264 "https://www.googleapis.com/auth/spreadsheets" | |
265 ] | |
266 }, | |
267 "update": { | |
268 "description": "Sets values in a range of a spreadsh
eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption
.", | |
269 "httpMethod": "PUT", | |
270 "id": "sheets.spreadsheets.values.update", | |
271 "parameterOrder": [ | |
272 "spreadsheetId", | |
273 "range" | |
274 ], | |
275 "parameters": { | |
276 "valueInputOption": { | |
277 "description": "How the input data should be
interpreted.", | |
278 "enum": [ | |
279 "INPUT_VALUE_OPTION_UNSPECIFIED", | |
280 "RAW", | |
281 "USER_ENTERED" | |
282 ], | |
283 "location": "query", | |
284 "type": "string" | |
285 }, | |
286 "spreadsheetId": { | 223 "spreadsheetId": { |
287 "description": "The ID of the spreadsheet to
update.", | 224 "description": "The ID of the spreadsheet to
update.", |
288 "location": "path", | 225 "location": "path", |
289 "required": true, | 226 "required": true, |
290 "type": "string" | 227 "type": "string" |
291 }, | 228 }, |
292 "range": { | 229 "range": { |
293 "description": "The A1 notation of the value
s to update.", | 230 "description": "The A1 notation of the value
s to clear.", |
294 "location": "path", | 231 "location": "path", |
295 "required": true, | 232 "required": true, |
296 "type": "string" | 233 "type": "string" |
297 } | 234 } |
298 }, | 235 }, |
299 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", | 236 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:clear", |
300 "request": { | 237 "request": { |
301 "$ref": "ValueRange" | 238 "$ref": "ClearValuesRequest" |
302 }, | 239 }, |
303 "response": { | 240 "response": { |
304 "$ref": "UpdateValuesResponse" | 241 "$ref": "ClearValuesResponse" |
305 }, | 242 }, |
306 "scopes": [ | 243 "scopes": [ |
307 "https://www.googleapis.com/auth/drive", | 244 "https://www.googleapis.com/auth/drive", |
| 245 "https://www.googleapis.com/auth/spreadsheets" |
| 246 ] |
| 247 }, |
| 248 "batchGet": { |
| 249 "description": "Returns one or more ranges of values
from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more
ranges.", |
| 250 "httpMethod": "GET", |
| 251 "id": "sheets.spreadsheets.values.batchGet", |
| 252 "parameterOrder": [ |
| 253 "spreadsheetId" |
| 254 ], |
| 255 "parameters": { |
| 256 "spreadsheetId": { |
| 257 "description": "The ID of the spreadsheet to
retrieve data from.", |
| 258 "location": "path", |
| 259 "required": true, |
| 260 "type": "string" |
| 261 }, |
| 262 "ranges": { |
| 263 "description": "The A1 notation of the value
s to retrieve.", |
| 264 "location": "query", |
| 265 "repeated": true, |
| 266 "type": "string" |
| 267 }, |
| 268 "valueRenderOption": { |
| 269 "description": "How values should be represe
nted in the output.", |
| 270 "enum": [ |
| 271 "FORMATTED_VALUE", |
| 272 "UNFORMATTED_VALUE", |
| 273 "FORMULA" |
| 274 ], |
| 275 "location": "query", |
| 276 "type": "string" |
| 277 }, |
| 278 "dateTimeRenderOption": { |
| 279 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.", |
| 280 "enum": [ |
| 281 "SERIAL_NUMBER", |
| 282 "FORMATTED_STRING" |
| 283 ], |
| 284 "location": "query", |
| 285 "type": "string" |
| 286 }, |
| 287 "majorDimension": { |
| 288 "description": "The major dimension that res
ults should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=
4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4
]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,
3],[2,4]]`.", |
| 289 "enum": [ |
| 290 "DIMENSION_UNSPECIFIED", |
| 291 "ROWS", |
| 292 "COLUMNS" |
| 293 ], |
| 294 "location": "query", |
| 295 "type": "string" |
| 296 } |
| 297 }, |
| 298 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hGet", |
| 299 "response": { |
| 300 "$ref": "BatchGetValuesResponse" |
| 301 }, |
| 302 "scopes": [ |
| 303 "https://www.googleapis.com/auth/drive", |
| 304 "https://www.googleapis.com/auth/drive.readonly"
, |
| 305 "https://www.googleapis.com/auth/spreadsheets", |
| 306 "https://www.googleapis.com/auth/spreadsheets.re
adonly" |
| 307 ] |
| 308 }, |
| 309 "batchUpdate": { |
| 310 "description": "Sets values in one or more ranges of
a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption
, and one or more\nValueRanges.", |
| 311 "httpMethod": "POST", |
| 312 "id": "sheets.spreadsheets.values.batchUpdate", |
| 313 "parameterOrder": [ |
| 314 "spreadsheetId" |
| 315 ], |
| 316 "parameters": { |
| 317 "spreadsheetId": { |
| 318 "description": "The ID of the spreadsheet to
update.", |
| 319 "location": "path", |
| 320 "required": true, |
| 321 "type": "string" |
| 322 } |
| 323 }, |
| 324 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hUpdate", |
| 325 "request": { |
| 326 "$ref": "BatchUpdateValuesRequest" |
| 327 }, |
| 328 "response": { |
| 329 "$ref": "BatchUpdateValuesResponse" |
| 330 }, |
| 331 "scopes": [ |
| 332 "https://www.googleapis.com/auth/drive", |
308 "https://www.googleapis.com/auth/spreadsheets" | 333 "https://www.googleapis.com/auth/spreadsheets" |
309 ] | 334 ] |
310 }, | 335 }, |
311 "get": { | 336 "get": { |
312 "description": "Returns a range of values from a spr
eadsheet.\nThe caller must specify the spreadsheet ID and a range.", | 337 "description": "Returns a range of values from a spr
eadsheet.\nThe caller must specify the spreadsheet ID and a range.", |
313 "httpMethod": "GET", | 338 "httpMethod": "GET", |
314 "id": "sheets.spreadsheets.values.get", | 339 "id": "sheets.spreadsheets.values.get", |
315 "parameterOrder": [ | 340 "parameterOrder": [ |
316 "spreadsheetId", | 341 "spreadsheetId", |
317 "range" | 342 "range" |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
363 "response": { | 388 "response": { |
364 "$ref": "ValueRange" | 389 "$ref": "ValueRange" |
365 }, | 390 }, |
366 "scopes": [ | 391 "scopes": [ |
367 "https://www.googleapis.com/auth/drive", | 392 "https://www.googleapis.com/auth/drive", |
368 "https://www.googleapis.com/auth/drive.readonly"
, | 393 "https://www.googleapis.com/auth/drive.readonly"
, |
369 "https://www.googleapis.com/auth/spreadsheets", | 394 "https://www.googleapis.com/auth/spreadsheets", |
370 "https://www.googleapis.com/auth/spreadsheets.re
adonly" | 395 "https://www.googleapis.com/auth/spreadsheets.re
adonly" |
371 ] | 396 ] |
372 }, | 397 }, |
373 "batchGet": { | 398 "append": { |
374 "description": "Returns one or more ranges of values
from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more
ranges.", | 399 "description": "Appends values to a spreadsheet. The
input range is used to search for\nexisting data and find a \"table\" within th
at range. Values will be\nappended to the next row of the table, starting with t
he first column of\nthe table. See the\n[guide](/sheets/guides/values#appending_
values)\nand\n[sample code](/sheets/samples/writing#append_values)\nfor specific
details of how tables are detected and data is appended.\n\nThe caller must spe
cify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption`
only\ncontrols how the input data will be added to the sheet (column-wise or\nr
ow-wise), it does not influence what cell the data starts being written\nto.", |
375 "httpMethod": "GET", | 400 "httpMethod": "POST", |
376 "id": "sheets.spreadsheets.values.batchGet", | 401 "id": "sheets.spreadsheets.values.append", |
377 "parameterOrder": [ | 402 "parameterOrder": [ |
378 "spreadsheetId" | 403 "spreadsheetId", |
| 404 "range" |
379 ], | 405 ], |
380 "parameters": { | 406 "parameters": { |
| 407 "valueInputOption": { |
| 408 "description": "How the input data should be
interpreted.", |
| 409 "enum": [ |
| 410 "INPUT_VALUE_OPTION_UNSPECIFIED", |
| 411 "RAW", |
| 412 "USER_ENTERED" |
| 413 ], |
| 414 "location": "query", |
| 415 "type": "string" |
| 416 }, |
381 "spreadsheetId": { | 417 "spreadsheetId": { |
382 "description": "The ID of the spreadsheet to
retrieve data from.", | 418 "description": "The ID of the spreadsheet to
update.", |
383 "location": "path", | 419 "location": "path", |
384 "required": true, | 420 "required": true, |
385 "type": "string" | 421 "type": "string" |
386 }, | 422 }, |
387 "ranges": { | 423 "insertDataOption": { |
388 "description": "The A1 notation of the value
s to retrieve.", | 424 "description": "How the input data should be
inserted.", |
389 "location": "query", | |
390 "repeated": true, | |
391 "type": "string" | |
392 }, | |
393 "valueRenderOption": { | |
394 "description": "How values should be represe
nted in the output.", | |
395 "enum": [ | 425 "enum": [ |
396 "FORMATTED_VALUE", | 426 "OVERWRITE", |
397 "UNFORMATTED_VALUE", | 427 "INSERT_ROWS" |
398 "FORMULA" | |
399 ], | 428 ], |
400 "location": "query", | 429 "location": "query", |
401 "type": "string" | 430 "type": "string" |
402 }, | 431 }, |
403 "dateTimeRenderOption": { | 432 "range": { |
404 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.", | 433 "description": "The A1 notation of a range t
o search for a logical table of data.\nValues will be appended after the last ro
w of the table.", |
| 434 "location": "path", |
| 435 "required": true, |
| 436 "type": "string" |
| 437 } |
| 438 }, |
| 439 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:append", |
| 440 "request": { |
| 441 "$ref": "ValueRange" |
| 442 }, |
| 443 "response": { |
| 444 "$ref": "AppendValuesResponse" |
| 445 }, |
| 446 "scopes": [ |
| 447 "https://www.googleapis.com/auth/drive", |
| 448 "https://www.googleapis.com/auth/spreadsheets" |
| 449 ] |
| 450 }, |
| 451 "update": { |
| 452 "description": "Sets values in a range of a spreadsh
eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption
.", |
| 453 "httpMethod": "PUT", |
| 454 "id": "sheets.spreadsheets.values.update", |
| 455 "parameterOrder": [ |
| 456 "spreadsheetId", |
| 457 "range" |
| 458 ], |
| 459 "parameters": { |
| 460 "valueInputOption": { |
| 461 "description": "How the input data should be
interpreted.", |
405 "enum": [ | 462 "enum": [ |
406 "SERIAL_NUMBER", | 463 "INPUT_VALUE_OPTION_UNSPECIFIED", |
407 "FORMATTED_STRING" | 464 "RAW", |
| 465 "USER_ENTERED" |
408 ], | 466 ], |
409 "location": "query", | 467 "location": "query", |
410 "type": "string" | 468 "type": "string" |
411 }, | 469 }, |
412 "majorDimension": { | 470 "spreadsheetId": { |
413 "description": "The major dimension that res
ults should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=
4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4
]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,
3],[2,4]]`.", | 471 "description": "The ID of the spreadsheet to
update.", |
414 "enum": [ | 472 "location": "path", |
415 "DIMENSION_UNSPECIFIED", | 473 "required": true, |
416 "ROWS", | 474 "type": "string" |
417 "COLUMNS" | 475 }, |
418 ], | 476 "range": { |
419 "location": "query", | 477 "description": "The A1 notation of the value
s to update.", |
| 478 "location": "path", |
| 479 "required": true, |
420 "type": "string" | 480 "type": "string" |
421 } | 481 } |
422 }, | 482 }, |
423 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hGet", | 483 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", |
| 484 "request": { |
| 485 "$ref": "ValueRange" |
| 486 }, |
424 "response": { | 487 "response": { |
425 "$ref": "BatchGetValuesResponse" | 488 "$ref": "UpdateValuesResponse" |
426 }, | 489 }, |
427 "scopes": [ | 490 "scopes": [ |
428 "https://www.googleapis.com/auth/drive", | 491 "https://www.googleapis.com/auth/drive", |
429 "https://www.googleapis.com/auth/drive.readonly"
, | 492 "https://www.googleapis.com/auth/spreadsheets" |
430 "https://www.googleapis.com/auth/spreadsheets", | |
431 "https://www.googleapis.com/auth/spreadsheets.re
adonly" | |
432 ] | 493 ] |
433 }, | 494 }, |
434 "batchUpdate": { | 495 "batchClear": { |
435 "description": "Sets values in one or more ranges of
a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption
, and one or more\nValueRanges.", | 496 "description": "Clears one or more ranges of values
from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more
ranges.\nOnly values are cleared -- all other properties of the cell (such as\nf
ormatting, data validation, etc..) are kept.", |
436 "httpMethod": "POST", | 497 "httpMethod": "POST", |
437 "id": "sheets.spreadsheets.values.batchUpdate", | 498 "id": "sheets.spreadsheets.values.batchClear", |
438 "parameterOrder": [ | 499 "parameterOrder": [ |
439 "spreadsheetId" | 500 "spreadsheetId" |
440 ], | 501 ], |
441 "parameters": { | 502 "parameters": { |
442 "spreadsheetId": { | 503 "spreadsheetId": { |
443 "description": "The ID of the spreadsheet to
update.", | 504 "description": "The ID of the spreadsheet to
update.", |
444 "location": "path", | 505 "location": "path", |
445 "required": true, | 506 "required": true, |
446 "type": "string" | 507 "type": "string" |
447 } | 508 } |
448 }, | 509 }, |
449 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hUpdate", | 510 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hClear", |
450 "request": { | 511 "request": { |
451 "$ref": "BatchUpdateValuesRequest" | 512 "$ref": "BatchClearValuesRequest" |
452 }, | 513 }, |
453 "response": { | 514 "response": { |
454 "$ref": "BatchUpdateValuesResponse" | 515 "$ref": "BatchClearValuesResponse" |
455 }, | 516 }, |
456 "scopes": [ | 517 "scopes": [ |
457 "https://www.googleapis.com/auth/drive", | 518 "https://www.googleapis.com/auth/drive", |
458 "https://www.googleapis.com/auth/spreadsheets" | 519 "https://www.googleapis.com/auth/spreadsheets" |
459 ] | 520 ] |
460 } | 521 } |
461 } | 522 } |
462 }, | 523 }, |
463 "sheets": { | 524 "sheets": { |
464 "methods": { | 525 "methods": { |
(...skipping 30 matching lines...) Expand all Loading... |
495 "scopes": [ | 556 "scopes": [ |
496 "https://www.googleapis.com/auth/drive", | 557 "https://www.googleapis.com/auth/drive", |
497 "https://www.googleapis.com/auth/spreadsheets" | 558 "https://www.googleapis.com/auth/spreadsheets" |
498 ] | 559 ] |
499 } | 560 } |
500 } | 561 } |
501 } | 562 } |
502 } | 563 } |
503 } | 564 } |
504 }, | 565 }, |
505 "revision": "20160822", | 566 "revision": "20161021", |
506 "rootUrl": "https://sheets.googleapis.com/", | 567 "rootUrl": "https://sheets.googleapis.com/", |
507 "schemas": { | 568 "schemas": { |
508 "AddNamedRangeResponse": { | 569 "AddNamedRangeResponse": { |
509 "description": "The result of adding a named range.", | 570 "description": "The result of adding a named range.", |
510 "id": "AddNamedRangeResponse", | 571 "id": "AddNamedRangeResponse", |
511 "properties": { | 572 "properties": { |
512 "namedRange": { | 573 "namedRange": { |
513 "$ref": "NamedRange", | 574 "$ref": "NamedRange", |
514 "description": "The named range to add." | 575 "description": "The named range to add." |
515 } | 576 } |
(...skipping 98 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
614 "description": "The result of updating an embedded object's position
.", | 675 "description": "The result of updating an embedded object's position
.", |
615 "id": "UpdateEmbeddedObjectPositionResponse", | 676 "id": "UpdateEmbeddedObjectPositionResponse", |
616 "properties": { | 677 "properties": { |
617 "position": { | 678 "position": { |
618 "$ref": "EmbeddedObjectPosition", | 679 "$ref": "EmbeddedObjectPosition", |
619 "description": "The new position of the embedded object." | 680 "description": "The new position of the embedded object." |
620 } | 681 } |
621 }, | 682 }, |
622 "type": "object" | 683 "type": "object" |
623 }, | 684 }, |
| 685 "ClearValuesResponse": { |
| 686 "description": "The response when clearing a range of values in a sp
readsheet.", |
| 687 "id": "ClearValuesResponse", |
| 688 "properties": { |
| 689 "spreadsheetId": { |
| 690 "description": "The spreadsheet the updates were applied to.
", |
| 691 "type": "string" |
| 692 }, |
| 693 "clearedRange": { |
| 694 "description": "The range (in A1 notation) that was cleared.
\n(If the request was for an unbounded range or a ranger larger\n than the bound
s of the sheet, this will be the actual range\n that was cleared, bounded to the
sheet's limits.)", |
| 695 "type": "string" |
| 696 } |
| 697 }, |
| 698 "type": "object" |
| 699 }, |
624 "UpdateConditionalFormatRuleRequest": { | 700 "UpdateConditionalFormatRuleRequest": { |
625 "description": "Updates a conditional format rule at the given index
,\nor moves a conditional format rule to another index.", | 701 "description": "Updates a conditional format rule at the given index
,\nor moves a conditional format rule to another index.", |
626 "id": "UpdateConditionalFormatRuleRequest", | 702 "id": "UpdateConditionalFormatRuleRequest", |
627 "properties": { | 703 "properties": { |
628 "sheetId": { | 704 "sheetId": { |
629 "description": "The sheet of the rule to move. Required if
new_index is set,\nunused otherwise.", | 705 "description": "The sheet of the rule to move. Required if
new_index is set,\nunused otherwise.", |
630 "format": "int32", | 706 "format": "int32", |
631 "type": "integer" | 707 "type": "integer" |
632 }, | 708 }, |
633 "rule": { | 709 "rule": { |
(...skipping 378 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1012 "The cell's value must be greater than the condition's v
alue.\nSupported by data validation, conditional formatting and filters.\nRequir
es a single ConditionValue.", | 1088 "The cell's value must be greater than the condition's v
alue.\nSupported by data validation, conditional formatting and filters.\nRequir
es a single ConditionValue.", |
1013 "The cell's value must be greater than or equal to the c
ondition's value.\nSupported by data validation, conditional formatting and filt
ers.\nRequires a single ConditionValue.", | 1089 "The cell's value must be greater than or equal to the c
ondition's value.\nSupported by data validation, conditional formatting and filt
ers.\nRequires a single ConditionValue.", |
1014 "The cell's value must be less than the condition's valu
e.\nSupported by data validation, conditional formatting and filters.\nRequires
a single ConditionValue.", | 1090 "The cell's value must be less than the condition's valu
e.\nSupported by data validation, conditional formatting and filters.\nRequires
a single ConditionValue.", |
1015 "The cell's value must be less than or equal to the cond
ition's value.\nSupported by data validation, conditional formatting and filters
.\nRequires a single ConditionValue.", | 1091 "The cell's value must be less than or equal to the cond
ition's value.\nSupported by data validation, conditional formatting and filters
.\nRequires a single ConditionValue.", |
1016 "The cell's value must be equal to the condition's value
.\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", | 1092 "The cell's value must be equal to the condition's value
.\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", |
1017 "The cell's value must be not equal to the condition's v
alue.\nSupported by data validation, conditional formatting and filters.\nRequir
es a single ConditionValue.", | 1093 "The cell's value must be not equal to the condition's v
alue.\nSupported by data validation, conditional formatting and filters.\nRequir
es a single ConditionValue.", |
1018 "The cell's value must be between the two condition valu
es.\nSupported by data validation, conditional formatting and filters.\nRequires
exactly two ConditionValues.", | 1094 "The cell's value must be between the two condition valu
es.\nSupported by data validation, conditional formatting and filters.\nRequires
exactly two ConditionValues.", |
1019 "The cell's value must not be between the two condition
values.\nSupported by data validation, conditional formatting and filters.\nRequ
ires exactly two ConditionValues.", | 1095 "The cell's value must not be between the two condition
values.\nSupported by data validation, conditional formatting and filters.\nRequ
ires exactly two ConditionValues.", |
1020 "The cell's value must contain the condition's value.\nS
upported by data validation, conditional formatting and filters.\nRequires a sin
gle ConditionValue.", | 1096 "The cell's value must contain the condition's value.\nS
upported by data validation, conditional formatting and filters.\nRequires a sin
gle ConditionValue.", |
1021 "The cell's value must not contain the condition's value
.\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", | 1097 "The cell's value must not contain the condition's value
.\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", |
1022 "The cell's value must start with the condition's value.
\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", | 1098 "The cell's value must start with the condition's value.
\nSupported by conditional formatting and filters.\nRequires a single ConditionV
alue.", |
1023 "The cell's value must end with the condition's value.\n
Supported by data validation, conditional formatting and filters.\nRequires a si
ngle ConditionValue.", | 1099 "The cell's value must end with the condition's value.\n
Supported by conditional formatting and filters.\nRequires a single ConditionVal
ue.", |
1024 "The cell's value must be exactly the condition's value.
\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", | 1100 "The cell's value must be exactly the condition's value.
\nSupported by data validation, conditional formatting and filters.\nRequires a
single ConditionValue.", |
1025 "The cell's value must be a valid email address.\nSuppor
ted by data validation.\nRequires no ConditionValues.", | 1101 "The cell's value must be a valid email address.\nSuppor
ted by data validation.\nRequires no ConditionValues.", |
1026 "The cell's value must be a valid URL.\nSupported by dat
a validation.\nRequires no ConditionValues.", | 1102 "The cell's value must be a valid URL.\nSupported by dat
a validation.\nRequires no ConditionValues.", |
1027 "The cell's value must be the same date as the condition
's value.\nSupported by data validation, conditional formatting and filters.\nRe
quires a single ConditionValue.", | 1103 "The cell's value must be the same date as the condition
's value.\nSupported by data validation, conditional formatting and filters.\nRe
quires a single ConditionValue.", |
1028 "The cell's value must be before the date of the conditi
on's value.\nSupported by data validation, conditional formatting and filters.\n
Requires a single ConditionValue\nthat may be a relative date.", | 1104 "The cell's value must be before the date of the conditi
on's value.\nSupported by data validation, conditional formatting and filters.\n
Requires a single ConditionValue\nthat may be a relative date.", |
1029 "The cell's value must be after the date of the conditio
n's value.\nSupported by data validation, conditional formatting and filters.\nR
equires a single ConditionValue\nthat may be a relative date.", | 1105 "The cell's value must be after the date of the conditio
n's value.\nSupported by data validation, conditional formatting and filters.\nR
equires a single ConditionValue\nthat may be a relative date.", |
1030 "The cell's value must be on or before the date of the c
ondition's value.\nSupported by data validation, conditional formatting and filt
ers.\nRequires a single ConditionValue\nthat may be a relative date.", | 1106 "The cell's value must be on or before the date of the c
ondition's value.\nSupported by data validation.\nRequires a single ConditionVal
ue\nthat may be a relative date.", |
1031 "The cell's value must be on or after the date of the co
ndition's value.\nSupported by data validation, conditional formatting and filte
rs.\nRequires a single ConditionValue\nthat may be a relative date.", | 1107 "The cell's value must be on or after the date of the co
ndition's value.\nSupported by data validation.\nRequires a single ConditionValu
e\nthat may be a relative date.", |
1032 "The cell's value must be between the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", | 1108 "The cell's value must be between the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", |
1033 "The cell's value must be outside the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", | 1109 "The cell's value must be outside the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", |
1034 "The cell's value must be a date.\nSupported by data val
idation.\nRequires no ConditionValues.", | 1110 "The cell's value must be a date.\nSupported by data val
idation.\nRequires no ConditionValues.", |
1035 "The cell's value must be listed in the grid in conditio
n value's range.\nSupported by data validation.\nRequires a single ConditionValu
e,\nand the value must be a valid range in A1 notation.", | 1111 "The cell's value must be listed in the grid in conditio
n value's range.\nSupported by data validation.\nRequires a single ConditionValu
e,\nand the value must be a valid range in A1 notation.", |
1036 "The cell's value must in the list of condition values.\
nSupported by data validation.\nSupports any number of condition values,\none pe
r item in the list.\nFormulas are not supported in the values.", | 1112 "The cell's value must in the list of condition values.\
nSupported by data validation.\nSupports any number of condition values,\none pe
r item in the list.\nFormulas are not supported in the values.", |
1037 "The cell's value must be empty.\nSupported by data vali
dation, conditional formatting and filters.\nRequires no ConditionValues.", | 1113 "The cell's value must be empty.\nSupported by condition
al formatting and filters.\nRequires no ConditionValues.", |
1038 "The cell's value must not be empty.\nSupported by data
validation, conditional formatting and filters.\nRequires no ConditionValues.", | 1114 "The cell's value must not be empty.\nSupported by condi
tional formatting and filters.\nRequires no ConditionValues.", |
1039 "The condition's formula must evaluate to true.\nSupport
ed by data validation, conditional formatting and filters.\nRequires a single Co
nditionValue." | 1115 "The condition's formula must evaluate to true.\nSupport
ed by data validation, conditional formatting and filters.\nRequires a single Co
nditionValue." |
1040 ], | 1116 ], |
1041 "type": "string" | 1117 "type": "string" |
1042 } | 1118 } |
1043 }, | 1119 }, |
1044 "type": "object" | 1120 "type": "object" |
1045 }, | 1121 }, |
1046 "DeleteProtectedRangeRequest": { | 1122 "DeleteProtectedRangeRequest": { |
1047 "description": "Deletes the protected range with the given ID.", | 1123 "description": "Deletes the protected range with the given ID.", |
1048 "id": "DeleteProtectedRangeRequest", | 1124 "id": "DeleteProtectedRangeRequest", |
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1131 "description": "A reply from updating a conditional format r
ule." | 1207 "description": "A reply from updating a conditional format r
ule." |
1132 }, | 1208 }, |
1133 "addChart": { | 1209 "addChart": { |
1134 "$ref": "AddChartResponse", | 1210 "$ref": "AddChartResponse", |
1135 "description": "A reply from adding a chart." | 1211 "description": "A reply from adding a chart." |
1136 }, | 1212 }, |
1137 "deleteConditionalFormatRule": { | 1213 "deleteConditionalFormatRule": { |
1138 "$ref": "DeleteConditionalFormatRuleResponse", | 1214 "$ref": "DeleteConditionalFormatRuleResponse", |
1139 "description": "A reply from deleting a conditional format r
ule." | 1215 "description": "A reply from deleting a conditional format r
ule." |
1140 }, | 1216 }, |
| 1217 "addBanding": { |
| 1218 "$ref": "AddBandingResponse", |
| 1219 "description": "A reply from adding a banded range." |
| 1220 }, |
1141 "duplicateSheet": { | 1221 "duplicateSheet": { |
1142 "$ref": "DuplicateSheetResponse", | 1222 "$ref": "DuplicateSheetResponse", |
1143 "description": "A reply from duplicating a sheet." | 1223 "description": "A reply from duplicating a sheet." |
1144 }, | 1224 }, |
1145 "duplicateFilterView": { | 1225 "duplicateFilterView": { |
1146 "$ref": "DuplicateFilterViewResponse", | 1226 "$ref": "DuplicateFilterViewResponse", |
1147 "description": "A reply from duplicating a filter view." | 1227 "description": "A reply from duplicating a filter view." |
1148 }, | 1228 }, |
1149 "addNamedRange": { | 1229 "addNamedRange": { |
1150 "$ref": "AddNamedRangeResponse", | 1230 "$ref": "AddNamedRangeResponse", |
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1218 "sortSpecs": { | 1298 "sortSpecs": { |
1219 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", | 1299 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", |
1220 "items": { | 1300 "items": { |
1221 "$ref": "SortSpec" | 1301 "$ref": "SortSpec" |
1222 }, | 1302 }, |
1223 "type": "array" | 1303 "type": "array" |
1224 } | 1304 } |
1225 }, | 1305 }, |
1226 "type": "object" | 1306 "type": "object" |
1227 }, | 1307 }, |
| 1308 "AddBandingResponse": { |
| 1309 "description": "The result of adding a banded range.", |
| 1310 "id": "AddBandingResponse", |
| 1311 "properties": { |
| 1312 "bandedRange": { |
| 1313 "$ref": "BandedRange", |
| 1314 "description": "The banded range that was added." |
| 1315 } |
| 1316 }, |
| 1317 "type": "object" |
| 1318 }, |
1228 "TextFormatRun": { | 1319 "TextFormatRun": { |
1229 "description": "A run of a text format. The format of this run conti
nues until the start\nindex of the next run.\nWhen updating, all fields must be
set.", | 1320 "description": "A run of a text format. The format of this run conti
nues until the start\nindex of the next run.\nWhen updating, all fields must be
set.", |
1230 "id": "TextFormatRun", | 1321 "id": "TextFormatRun", |
1231 "properties": { | 1322 "properties": { |
1232 "startIndex": { | 1323 "startIndex": { |
1233 "description": "The character index where this run starts.", | 1324 "description": "The character index where this run starts.", |
1234 "format": "int32", | 1325 "format": "int32", |
1235 "type": "integer" | 1326 "type": "integer" |
1236 }, | 1327 }, |
1237 "format": { | 1328 "format": { |
(...skipping 210 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1448 "id": "ClearBasicFilterRequest", | 1539 "id": "ClearBasicFilterRequest", |
1449 "properties": { | 1540 "properties": { |
1450 "sheetId": { | 1541 "sheetId": { |
1451 "description": "The sheet ID on which the basic filter shoul
d be cleared.", | 1542 "description": "The sheet ID on which the basic filter shoul
d be cleared.", |
1452 "format": "int32", | 1543 "format": "int32", |
1453 "type": "integer" | 1544 "type": "integer" |
1454 } | 1545 } |
1455 }, | 1546 }, |
1456 "type": "object" | 1547 "type": "object" |
1457 }, | 1548 }, |
| 1549 "BatchClearValuesResponse": { |
| 1550 "description": "The response when updating a range of values in a sp
readsheet.", |
| 1551 "id": "BatchClearValuesResponse", |
| 1552 "properties": { |
| 1553 "spreadsheetId": { |
| 1554 "description": "The spreadsheet the updates were applied to.
", |
| 1555 "type": "string" |
| 1556 }, |
| 1557 "clearedRanges": { |
| 1558 "description": "The ranges that were cleared, in A1 notation
.\n(If the requests were for an unbounded range or a ranger larger\n than the bo
unds of the sheet, this will be the actual ranges\n that were cleared, bounded t
o the sheet's limits.)", |
| 1559 "items": { |
| 1560 "type": "string" |
| 1561 }, |
| 1562 "type": "array" |
| 1563 } |
| 1564 }, |
| 1565 "type": "object" |
| 1566 }, |
1458 "ConditionalFormatRule": { | 1567 "ConditionalFormatRule": { |
1459 "description": "A rule describing a conditional format.", | 1568 "description": "A rule describing a conditional format.", |
1460 "id": "ConditionalFormatRule", | 1569 "id": "ConditionalFormatRule", |
1461 "properties": { | 1570 "properties": { |
1462 "gradientRule": { | 1571 "gradientRule": { |
1463 "$ref": "GradientRule", | 1572 "$ref": "GradientRule", |
1464 "description": "The formatting will vary based on the gradie
nts in the rule." | 1573 "description": "The formatting will vary based on the gradie
nts in the rule." |
1465 }, | 1574 }, |
1466 "booleanRule": { | 1575 "booleanRule": { |
1467 "$ref": "BooleanRule", | 1576 "$ref": "BooleanRule", |
(...skipping 591 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2059 "enumDescriptions": [ | 2168 "enumDescriptions": [ |
2060 "Default value, do not use.", | 2169 "Default value, do not use.", |
2061 "The sheet is a grid.", | 2170 "The sheet is a grid.", |
2062 "The sheet has no grid and instead has an object like a
chart or image." | 2171 "The sheet has no grid and instead has an object like a
chart or image." |
2063 ], | 2172 ], |
2064 "type": "string" | 2173 "type": "string" |
2065 } | 2174 } |
2066 }, | 2175 }, |
2067 "type": "object" | 2176 "type": "object" |
2068 }, | 2177 }, |
| 2178 "ClearValuesRequest": { |
| 2179 "description": "The request for clearing a range of values in a spre
adsheet.", |
| 2180 "id": "ClearValuesRequest", |
| 2181 "properties": {}, |
| 2182 "type": "object" |
| 2183 }, |
2069 "ProtectedRange": { | 2184 "ProtectedRange": { |
2070 "description": "A protected range.", | 2185 "description": "A protected range.", |
2071 "id": "ProtectedRange", | 2186 "id": "ProtectedRange", |
2072 "properties": { | 2187 "properties": { |
2073 "unprotectedRanges": { | 2188 "unprotectedRanges": { |
2074 "description": "The list of unprotected ranges within a prot
ected sheet.\nUnprotected ranges are only supported on protected sheets.", | 2189 "description": "The list of unprotected ranges within a prot
ected sheet.\nUnprotected ranges are only supported on protected sheets.", |
2075 "items": { | 2190 "items": { |
2076 "$ref": "GridRange" | 2191 "$ref": "GridRange" |
2077 }, | 2192 }, |
2078 "type": "array" | 2193 "type": "array" |
(...skipping 271 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2350 "type": "string" | 2465 "type": "string" |
2351 } | 2466 } |
2352 }, | 2467 }, |
2353 "type": "object" | 2468 "type": "object" |
2354 }, | 2469 }, |
2355 "NumberFormat": { | 2470 "NumberFormat": { |
2356 "description": "The number format of a cell.", | 2471 "description": "The number format of a cell.", |
2357 "id": "NumberFormat", | 2472 "id": "NumberFormat", |
2358 "properties": { | 2473 "properties": { |
2359 "pattern": { | 2474 "pattern": { |
2360 "description": "Pattern string used for formatting. If not
set, a default pattern based on\nthe user's locale will be used if necessary for
the given type.", | 2475 "description": "Pattern string used for formatting. If not
set, a default pattern based on\nthe user's locale will be used if necessary for
the given type.\nSee the [Date and Number Formats guide](/sheets/guides/formats
) for more\ninformation about the supported patterns.", |
2361 "type": "string" | 2476 "type": "string" |
2362 }, | 2477 }, |
2363 "type": { | 2478 "type": { |
2364 "description": "The type of the number format.\nWhen writing
, this field must be set.", | 2479 "description": "The type of the number format.\nWhen writing
, this field must be set.", |
2365 "enum": [ | 2480 "enum": [ |
2366 "NUMBER_FORMAT_TYPE_UNSPECIFIED", | 2481 "NUMBER_FORMAT_TYPE_UNSPECIFIED", |
2367 "TEXT", | 2482 "TEXT", |
2368 "NUMBER", | 2483 "NUMBER", |
2369 "PERCENT", | 2484 "PERCENT", |
2370 "CURRENCY", | 2485 "CURRENCY", |
(...skipping 11 matching lines...) Expand all Loading... |
2382 "Date formatting, e.g `9/26/2008`", | 2497 "Date formatting, e.g `9/26/2008`", |
2383 "Time formatting, e.g `3:59:00 PM`", | 2498 "Time formatting, e.g `3:59:00 PM`", |
2384 "Date+Time formatting, e.g `9/26/08 15:59:00`", | 2499 "Date+Time formatting, e.g `9/26/08 15:59:00`", |
2385 "Scientific number formatting, e.g `1.01E+03`" | 2500 "Scientific number formatting, e.g `1.01E+03`" |
2386 ], | 2501 ], |
2387 "type": "string" | 2502 "type": "string" |
2388 } | 2503 } |
2389 }, | 2504 }, |
2390 "type": "object" | 2505 "type": "object" |
2391 }, | 2506 }, |
| 2507 "BatchClearValuesRequest": { |
| 2508 "description": "The request for clearing more than one range of valu
es in a spreadsheet.", |
| 2509 "id": "BatchClearValuesRequest", |
| 2510 "properties": { |
| 2511 "ranges": { |
| 2512 "description": "The ranges to clear, in A1 notation.", |
| 2513 "items": { |
| 2514 "type": "string" |
| 2515 }, |
| 2516 "type": "array" |
| 2517 } |
| 2518 }, |
| 2519 "type": "object" |
| 2520 }, |
2392 "UpdateDimensionPropertiesRequest": { | 2521 "UpdateDimensionPropertiesRequest": { |
2393 "description": "Updates properties of dimensions within the specifie
d range.", | 2522 "description": "Updates properties of dimensions within the specifie
d range.", |
2394 "id": "UpdateDimensionPropertiesRequest", | 2523 "id": "UpdateDimensionPropertiesRequest", |
2395 "properties": { | 2524 "properties": { |
2396 "fields": { | 2525 "fields": { |
2397 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", | 2526 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", |
2398 "format": "google-fieldmask", | 2527 "format": "google-fieldmask", |
2399 "type": "string" | 2528 "type": "string" |
2400 }, | 2529 }, |
2401 "range": { | 2530 "range": { |
(...skipping 150 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2552 ], | 2681 ], |
2553 "type": "string" | 2682 "type": "string" |
2554 }, | 2683 }, |
2555 "name": { | 2684 "name": { |
2556 "description": "A name to use for the value. This is only us
ed if formula was set.\nOtherwise, the column name is used.", | 2685 "description": "A name to use for the value. This is only us
ed if formula was set.\nOtherwise, the column name is used.", |
2557 "type": "string" | 2686 "type": "string" |
2558 } | 2687 } |
2559 }, | 2688 }, |
2560 "type": "object" | 2689 "type": "object" |
2561 }, | 2690 }, |
| 2691 "DeleteBandingRequest": { |
| 2692 "description": "Removes the banded range with the given ID from the
spreadsheet.", |
| 2693 "id": "DeleteBandingRequest", |
| 2694 "properties": { |
| 2695 "bandedRangeId": { |
| 2696 "description": "The ID of the banded range to delete.", |
| 2697 "format": "int32", |
| 2698 "type": "integer" |
| 2699 } |
| 2700 }, |
| 2701 "type": "object" |
| 2702 }, |
2562 "BasicFilter": { | 2703 "BasicFilter": { |
2563 "description": "The default filter associated with a sheet.", | 2704 "description": "The default filter associated with a sheet.", |
2564 "id": "BasicFilter", | 2705 "id": "BasicFilter", |
2565 "properties": { | 2706 "properties": { |
2566 "criteria": { | 2707 "criteria": { |
2567 "additionalProperties": { | 2708 "additionalProperties": { |
2568 "$ref": "FilterCriteria" | 2709 "$ref": "FilterCriteria" |
2569 }, | 2710 }, |
2570 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", | 2711 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", |
2571 "type": "object" | 2712 "type": "object" |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2636 "description": "A border along a cell.", | 2777 "description": "A border along a cell.", |
2637 "id": "Border", | 2778 "id": "Border", |
2638 "properties": { | 2779 "properties": { |
2639 "style": { | 2780 "style": { |
2640 "description": "The style of the border.", | 2781 "description": "The style of the border.", |
2641 "enum": [ | 2782 "enum": [ |
2642 "STYLE_UNSPECIFIED", | 2783 "STYLE_UNSPECIFIED", |
2643 "DOTTED", | 2784 "DOTTED", |
2644 "DASHED", | 2785 "DASHED", |
2645 "SOLID", | 2786 "SOLID", |
| 2787 "SOLID_MEDIUM", |
| 2788 "SOLID_THICK", |
2646 "NONE", | 2789 "NONE", |
2647 "DOUBLE" | 2790 "DOUBLE" |
2648 ], | 2791 ], |
2649 "enumDescriptions": [ | 2792 "enumDescriptions": [ |
2650 "The style is not specified. Do not use this.", | 2793 "The style is not specified. Do not use this.", |
2651 "The border is dotted.", | 2794 "The border is dotted.", |
2652 "The border is dashed.", | 2795 "The border is dashed.", |
2653 "The border is a solid line.", | 2796 "The border is a thin solid line.", |
| 2797 "The border is a medium solid line.", |
| 2798 "The border is a thick solid line.", |
2654 "No border.\nUsed only when updating a border in order t
o erase it.", | 2799 "No border.\nUsed only when updating a border in order t
o erase it.", |
2655 "The border is two solid lines." | 2800 "The border is two solid lines." |
2656 ], | 2801 ], |
2657 "type": "string" | 2802 "type": "string" |
2658 }, | 2803 }, |
2659 "width": { | 2804 "width": { |
2660 "description": "The width of the border, in pixels.\nBorder
widths must be between 0 and 3 pixels, inclusive.", | 2805 "description": "The width of the border, in pixels.\nDepreca
ted; the width is determined by the \"style\" field.", |
2661 "format": "int32", | 2806 "format": "int32", |
2662 "type": "integer" | 2807 "type": "integer" |
2663 }, | 2808 }, |
2664 "color": { | 2809 "color": { |
2665 "$ref": "Color", | 2810 "$ref": "Color", |
2666 "description": "The color of the border." | 2811 "description": "The color of the border." |
2667 } | 2812 } |
2668 }, | 2813 }, |
2669 "type": "object" | 2814 "type": "object" |
2670 }, | 2815 }, |
(...skipping 12 matching lines...) Expand all Loading... |
2683 "description": "The result of adding a chart to a spreadsheet.", | 2828 "description": "The result of adding a chart to a spreadsheet.", |
2684 "id": "AddChartResponse", | 2829 "id": "AddChartResponse", |
2685 "properties": { | 2830 "properties": { |
2686 "chart": { | 2831 "chart": { |
2687 "$ref": "EmbeddedChart", | 2832 "$ref": "EmbeddedChart", |
2688 "description": "The newly added chart." | 2833 "description": "The newly added chart." |
2689 } | 2834 } |
2690 }, | 2835 }, |
2691 "type": "object" | 2836 "type": "object" |
2692 }, | 2837 }, |
| 2838 "AddBandingRequest": { |
| 2839 "description": "Adds a new banded range to the spreadsheet.", |
| 2840 "id": "AddBandingRequest", |
| 2841 "properties": { |
| 2842 "bandedRange": { |
| 2843 "$ref": "BandedRange", |
| 2844 "description": "The banded range to add. The bandedRangeId\n
field is optional; if one is not set, an id will be randomly generated. (It\nis
an error to specify the ID of a range that already exists.)" |
| 2845 } |
| 2846 }, |
| 2847 "type": "object" |
| 2848 }, |
2693 "AppendCellsRequest": { | 2849 "AppendCellsRequest": { |
2694 "description": "Adds new cells after the last row with data in a she
et,\ninserting new rows into the sheet if necessary.", | 2850 "description": "Adds new cells after the last row with data in a she
et,\ninserting new rows into the sheet if necessary.", |
2695 "id": "AppendCellsRequest", | 2851 "id": "AppendCellsRequest", |
2696 "properties": { | 2852 "properties": { |
2697 "sheetId": { | 2853 "sheetId": { |
2698 "description": "The sheet ID to append the data to.", | 2854 "description": "The sheet ID to append the data to.", |
2699 "format": "int32", | 2855 "format": "int32", |
2700 "type": "integer" | 2856 "type": "integer" |
2701 }, | 2857 }, |
2702 "rows": { | 2858 "rows": { |
(...skipping 181 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2884 "$ref": "GridRange", | 3040 "$ref": "GridRange", |
2885 "description": "The range this represents." | 3041 "description": "The range this represents." |
2886 }, | 3042 }, |
2887 "name": { | 3043 "name": { |
2888 "description": "The name of the named range.", | 3044 "description": "The name of the named range.", |
2889 "type": "string" | 3045 "type": "string" |
2890 } | 3046 } |
2891 }, | 3047 }, |
2892 "type": "object" | 3048 "type": "object" |
2893 }, | 3049 }, |
2894 "SetBasicFilterRequest": { | |
2895 "description": "Sets the basic filter associated with a sheet.", | |
2896 "id": "SetBasicFilterRequest", | |
2897 "properties": { | |
2898 "filter": { | |
2899 "$ref": "BasicFilter", | |
2900 "description": "The filter to set." | |
2901 } | |
2902 }, | |
2903 "type": "object" | |
2904 }, | |
2905 "UpdateEmbeddedObjectPositionRequest": { | 3050 "UpdateEmbeddedObjectPositionRequest": { |
2906 "description": "Update an embedded object's position (such as a movi
ng or resizing a\nchart or image).", | 3051 "description": "Update an embedded object's position (such as a movi
ng or resizing a\nchart or image).", |
2907 "id": "UpdateEmbeddedObjectPositionRequest", | 3052 "id": "UpdateEmbeddedObjectPositionRequest", |
2908 "properties": { | 3053 "properties": { |
2909 "newPosition": { | 3054 "newPosition": { |
2910 "$ref": "EmbeddedObjectPosition", | 3055 "$ref": "EmbeddedObjectPosition", |
2911 "description": "An explicit position to move the embedded ob
ject to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be creat
ed.\nIf newPosition.newSheet is set to true,\na new sheet will be created with a
n ID that will be chosen for you." | 3056 "description": "An explicit position to move the embedded ob
ject to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be creat
ed.\nIf newPosition.newSheet is set to true,\na new sheet will be created with a
n ID that will be chosen for you." |
2912 }, | 3057 }, |
2913 "objectId": { | 3058 "objectId": { |
2914 "description": "The ID of the object to moved.", | 3059 "description": "The ID of the object to moved.", |
2915 "format": "int32", | 3060 "format": "int32", |
2916 "type": "integer" | 3061 "type": "integer" |
2917 }, | 3062 }, |
2918 "fields": { | 3063 "fields": { |
2919 "description": "The fields of OverlayPosition\nthat should b
e updated when setting a new position. Used only if\nnewPosition.overlayPosition
\nis set, in which case at least one field must\nbe specified. The root `newPos
ition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"
` can be used as short-hand for listing every field.", | 3064 "description": "The fields of OverlayPosition\nthat should b
e updated when setting a new position. Used only if\nnewPosition.overlayPosition
\nis set, in which case at least one field must\nbe specified. The root `newPos
ition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"
` can be used as short-hand for listing every field.", |
2920 "format": "google-fieldmask", | 3065 "format": "google-fieldmask", |
2921 "type": "string" | 3066 "type": "string" |
2922 } | 3067 } |
2923 }, | 3068 }, |
2924 "type": "object" | 3069 "type": "object" |
2925 }, | 3070 }, |
| 3071 "SetBasicFilterRequest": { |
| 3072 "description": "Sets the basic filter associated with a sheet.", |
| 3073 "id": "SetBasicFilterRequest", |
| 3074 "properties": { |
| 3075 "filter": { |
| 3076 "$ref": "BasicFilter", |
| 3077 "description": "The filter to set." |
| 3078 } |
| 3079 }, |
| 3080 "type": "object" |
| 3081 }, |
2926 "AutoResizeDimensionsRequest": { | 3082 "AutoResizeDimensionsRequest": { |
2927 "description": "Automatically resizes one or more dimensions based o
n the contents\nof the cells in that dimension.", | 3083 "description": "Automatically resizes one or more dimensions based o
n the contents\nof the cells in that dimension.", |
2928 "id": "AutoResizeDimensionsRequest", | 3084 "id": "AutoResizeDimensionsRequest", |
2929 "properties": { | 3085 "properties": { |
2930 "dimensions": { | 3086 "dimensions": { |
2931 "$ref": "DimensionRange", | 3087 "$ref": "DimensionRange", |
2932 "description": "The dimensions to automatically resize.\nOnl
y COLUMNS are supported." | 3088 "description": "The dimensions to automatically resize.\nOnl
y COLUMNS are supported." |
2933 } | 3089 } |
2934 }, | 3090 }, |
2935 "type": "object" | 3091 "type": "object" |
2936 }, | 3092 }, |
2937 "DuplicateFilterViewResponse": { | 3093 "DuplicateFilterViewResponse": { |
2938 "description": "The result of a filter view being duplicated.", | 3094 "description": "The result of a filter view being duplicated.", |
2939 "id": "DuplicateFilterViewResponse", | 3095 "id": "DuplicateFilterViewResponse", |
2940 "properties": { | 3096 "properties": { |
2941 "filter": { | 3097 "filter": { |
2942 "$ref": "FilterView", | 3098 "$ref": "FilterView", |
2943 "description": "The newly created filter." | 3099 "description": "The newly created filter." |
2944 } | 3100 } |
2945 }, | 3101 }, |
2946 "type": "object" | 3102 "type": "object" |
2947 }, | 3103 }, |
| 3104 "BandingProperties": { |
| 3105 "description": "Properties referring a single dimension (either row
or column). If both\nBandedRange.row_properties and BandedRange.column_propertie
s are\nset, the fill colors are applied to cells according to the following rule
s:\n\n* header_color and footer_color take priority over band colors.\n* first_b
and_color takes priority over second_band_color.\n* row_properties takes priorit
y over column_properties.\n\nFor example, the first row color takes priority ove
r the first column\ncolor, but the first column color takes priority over the se
cond row color.\nSimilarly, the row header takes priority over the column header
in the\ntop left cell, but the column header takes priority over the first row\
ncolor if the row header is not set.", |
| 3106 "id": "BandingProperties", |
| 3107 "properties": { |
| 3108 "footerColor": { |
| 3109 "$ref": "Color", |
| 3110 "description": "The color of the last row or column. If this
field is not set, the last\nrow or column will be filled with either first_row_
color or\nsecond_row_color, depending on the color of the previous row or\ncolum
n." |
| 3111 }, |
| 3112 "headerColor": { |
| 3113 "$ref": "Color", |
| 3114 "description": "The color of the first row or column. If thi
s field is set, the first\nrow or column will be filled with this color and the
colors will\nalternate between first_band_color and [second_band_color[] startin
g\nfrom the second row or column. Otherwise, the first row or column will be\nfi
lled with first_band_color and the colors will proceed to alternate\nas they nor
mally would." |
| 3115 }, |
| 3116 "secondBandColor": { |
| 3117 "$ref": "Color", |
| 3118 "description": "The second color that is alternating. (Requi
red)" |
| 3119 }, |
| 3120 "firstBandColor": { |
| 3121 "$ref": "Color", |
| 3122 "description": "The first color that is alternating. (Requir
ed)" |
| 3123 } |
| 3124 }, |
| 3125 "type": "object" |
| 3126 }, |
2948 "PivotGroup": { | 3127 "PivotGroup": { |
2949 "description": "A single grouping (either row or column) in a pivot
table.", | 3128 "description": "A single grouping (either row or column) in a pivot
table.", |
2950 "id": "PivotGroup", | 3129 "id": "PivotGroup", |
2951 "properties": { | 3130 "properties": { |
2952 "sortOrder": { | 3131 "sortOrder": { |
2953 "description": "The order the values in this group should be
sorted.", | 3132 "description": "The order the values in this group should be
sorted.", |
2954 "enum": [ | 3133 "enum": [ |
2955 "SORT_ORDER_UNSPECIFIED", | 3134 "SORT_ORDER_UNSPECIFIED", |
2956 "ASCENDING", | 3135 "ASCENDING", |
2957 "DESCENDING" | 3136 "DESCENDING" |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3023 "id": "DeleteSheetRequest", | 3202 "id": "DeleteSheetRequest", |
3024 "properties": { | 3203 "properties": { |
3025 "sheetId": { | 3204 "sheetId": { |
3026 "description": "The ID of the sheet to delete.", | 3205 "description": "The ID of the sheet to delete.", |
3027 "format": "int32", | 3206 "format": "int32", |
3028 "type": "integer" | 3207 "type": "integer" |
3029 } | 3208 } |
3030 }, | 3209 }, |
3031 "type": "object" | 3210 "type": "object" |
3032 }, | 3211 }, |
| 3212 "UpdateBandingRequest": { |
| 3213 "description": "Updates properties of the supplied banded range.", |
| 3214 "id": "UpdateBandingRequest", |
| 3215 "properties": { |
| 3216 "bandedRange": { |
| 3217 "$ref": "BandedRange", |
| 3218 "description": "The banded range to update with the new prop
erties." |
| 3219 }, |
| 3220 "fields": { |
| 3221 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `bandedRange` is implied and should not
be specified.\nA single `\"*\"` can be used as short-hand for listing every fiel
d.", |
| 3222 "format": "google-fieldmask", |
| 3223 "type": "string" |
| 3224 } |
| 3225 }, |
| 3226 "type": "object" |
| 3227 }, |
3033 "ChartData": { | 3228 "ChartData": { |
3034 "description": "The data included in a domain or series.", | 3229 "description": "The data included in a domain or series.", |
3035 "id": "ChartData", | 3230 "id": "ChartData", |
3036 "properties": { | 3231 "properties": { |
3037 "sourceRange": { | 3232 "sourceRange": { |
3038 "$ref": "ChartSourceRange", | 3233 "$ref": "ChartSourceRange", |
3039 "description": "The source ranges of the data." | 3234 "description": "The source ranges of the data." |
3040 } | 3235 } |
3041 }, | 3236 }, |
3042 "type": "object" | 3237 "type": "object" |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3087 "$ref": "GridRange" | 3282 "$ref": "GridRange" |
3088 }, | 3283 }, |
3089 "type": "array" | 3284 "type": "array" |
3090 }, | 3285 }, |
3091 "data": { | 3286 "data": { |
3092 "description": "Data in the grid, if this is a grid sheet.\n
The number of GridData objects returned is dependent on the number of\nranges re
quested on this sheet. For example, if this is representing\n`Sheet1`, and the s
preadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then
the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second
one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-base
d column D).", | 3287 "description": "Data in the grid, if this is a grid sheet.\n
The number of GridData objects returned is dependent on the number of\nranges re
quested on this sheet. For example, if this is representing\n`Sheet1`, and the s
preadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then
the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second
one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-base
d column D).", |
3093 "items": { | 3288 "items": { |
3094 "$ref": "GridData" | 3289 "$ref": "GridData" |
3095 }, | 3290 }, |
3096 "type": "array" | 3291 "type": "array" |
| 3292 }, |
| 3293 "bandedRanges": { |
| 3294 "description": "The banded (i.e. alternating colors) ranges
on this sheet.", |
| 3295 "items": { |
| 3296 "$ref": "BandedRange" |
| 3297 }, |
| 3298 "type": "array" |
3097 } | 3299 } |
3098 }, | 3300 }, |
3099 "type": "object" | 3301 "type": "object" |
3100 }, | 3302 }, |
3101 "CopyPasteRequest": { | 3303 "CopyPasteRequest": { |
3102 "description": "Copies data from the source to the destination.", | 3304 "description": "Copies data from the source to the destination.", |
3103 "id": "CopyPasteRequest", | 3305 "id": "CopyPasteRequest", |
3104 "properties": { | 3306 "properties": { |
3105 "pasteType": { | 3307 "pasteType": { |
3106 "description": "What kind of data to paste.", | 3308 "description": "What kind of data to paste.", |
(...skipping 503 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3610 "description": "Updates an existing conditional format rule.
" | 3812 "description": "Updates an existing conditional format rule.
" |
3611 }, | 3813 }, |
3612 "setBasicFilter": { | 3814 "setBasicFilter": { |
3613 "$ref": "SetBasicFilterRequest", | 3815 "$ref": "SetBasicFilterRequest", |
3614 "description": "Sets the basic filter on a sheet." | 3816 "description": "Sets the basic filter on a sheet." |
3615 }, | 3817 }, |
3616 "mergeCells": { | 3818 "mergeCells": { |
3617 "$ref": "MergeCellsRequest", | 3819 "$ref": "MergeCellsRequest", |
3618 "description": "Merges cells together." | 3820 "description": "Merges cells together." |
3619 }, | 3821 }, |
| 3822 "updateBanding": { |
| 3823 "$ref": "UpdateBandingRequest", |
| 3824 "description": "Updates a banded range" |
| 3825 }, |
3620 "addChart": { | 3826 "addChart": { |
3621 "$ref": "AddChartRequest", | 3827 "$ref": "AddChartRequest", |
3622 "description": "Adds a chart." | 3828 "description": "Adds a chart." |
3623 }, | 3829 }, |
3624 "deleteConditionalFormatRule": { | 3830 "deleteConditionalFormatRule": { |
3625 "$ref": "DeleteConditionalFormatRuleRequest", | 3831 "$ref": "DeleteConditionalFormatRuleRequest", |
3626 "description": "Deletes an existing conditional format rule.
" | 3832 "description": "Deletes an existing conditional format rule.
" |
3627 }, | 3833 }, |
| 3834 "addBanding": { |
| 3835 "$ref": "AddBandingRequest", |
| 3836 "description": "Adds a new banded range" |
| 3837 }, |
| 3838 "deleteBanding": { |
| 3839 "$ref": "DeleteBandingRequest", |
| 3840 "description": "Removes a banded range" |
| 3841 }, |
3628 "updateChartSpec": { | 3842 "updateChartSpec": { |
3629 "$ref": "UpdateChartSpecRequest", | 3843 "$ref": "UpdateChartSpecRequest", |
3630 "description": "Updates a chart's specifications." | 3844 "description": "Updates a chart's specifications." |
3631 }, | 3845 }, |
3632 "deleteDimension": { | 3846 "deleteDimension": { |
3633 "$ref": "DeleteDimensionRequest", | 3847 "$ref": "DeleteDimensionRequest", |
3634 "description": "Deletes rows or columns in a sheet." | 3848 "description": "Deletes rows or columns in a sheet." |
3635 }, | 3849 }, |
3636 "deleteEmbeddedObject": { | 3850 "deleteEmbeddedObject": { |
3637 "$ref": "DeleteEmbeddedObjectRequest", | 3851 "$ref": "DeleteEmbeddedObjectRequest", |
(...skipping 96 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3734 "id": "DeleteEmbeddedObjectRequest", | 3948 "id": "DeleteEmbeddedObjectRequest", |
3735 "properties": { | 3949 "properties": { |
3736 "objectId": { | 3950 "objectId": { |
3737 "description": "The ID of the embedded object to delete.", | 3951 "description": "The ID of the embedded object to delete.", |
3738 "format": "int32", | 3952 "format": "int32", |
3739 "type": "integer" | 3953 "type": "integer" |
3740 } | 3954 } |
3741 }, | 3955 }, |
3742 "type": "object" | 3956 "type": "object" |
3743 }, | 3957 }, |
| 3958 "BandedRange": { |
| 3959 "description": "A banded (alternating colors) range in a sheet.", |
| 3960 "id": "BandedRange", |
| 3961 "properties": { |
| 3962 "bandedRangeId": { |
| 3963 "description": "The id of the banded range.", |
| 3964 "format": "int32", |
| 3965 "type": "integer" |
| 3966 }, |
| 3967 "rowProperties": { |
| 3968 "$ref": "BandingProperties", |
| 3969 "description": "Properties for row bands. These properties w
ill be applied on a row-by-row\nbasis throughout all the rows in the range. At l
east one of\nrow_properties or column_properties must be specified." |
| 3970 }, |
| 3971 "columnProperties": { |
| 3972 "$ref": "BandingProperties", |
| 3973 "description": "Properties for column bands. These propertie
s will be applied on a column-\nby-column basis throughout all the columns in th
e range. At least one of\nrow_properties or column_properties must be specified.
" |
| 3974 }, |
| 3975 "range": { |
| 3976 "$ref": "GridRange", |
| 3977 "description": "The range over which these properties are ap
plied." |
| 3978 } |
| 3979 }, |
| 3980 "type": "object" |
| 3981 }, |
3744 "DeleteConditionalFormatRuleResponse": { | 3982 "DeleteConditionalFormatRuleResponse": { |
3745 "description": "The result of deleting a conditional format rule.", | 3983 "description": "The result of deleting a conditional format rule.", |
3746 "id": "DeleteConditionalFormatRuleResponse", | 3984 "id": "DeleteConditionalFormatRuleResponse", |
3747 "properties": { | 3985 "properties": { |
3748 "rule": { | 3986 "rule": { |
3749 "$ref": "ConditionalFormatRule", | 3987 "$ref": "ConditionalFormatRule", |
3750 "description": "The rule that was deleted." | 3988 "description": "The rule that was deleted." |
3751 } | 3989 } |
3752 }, | 3990 }, |
3753 "type": "object" | 3991 "type": "object" |
3754 } | 3992 } |
3755 }, | 3993 }, |
3756 "servicePath": "", | 3994 "servicePath": "", |
3757 "title": "Google Sheets API", | 3995 "title": "Google Sheets API", |
3758 "version": "v4" | 3996 "version": "v4" |
3759 } | 3997 } |
OLD | NEW |