Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(162)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/sheets__v4.json

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/siteVerification__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/drive": { 5 "https://www.googleapis.com/auth/drive": {
6 "description": "View and manage the files in your Google Dri ve" 6 "description": "View and manage the files in your Google Dri ve"
7 }, 7 },
8 "https://www.googleapis.com/auth/drive.readonly": { 8 "https://www.googleapis.com/auth/drive.readonly": {
9 "description": "View the files in your Google Drive" 9 "description": "View the files in your Google Drive"
10 }, 10 },
(...skipping 27 matching lines...) Expand all
38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
39 "location": "query", 39 "location": "query",
40 "type": "string" 40 "type": "string"
41 }, 41 },
42 "prettyPrint": { 42 "prettyPrint": {
43 "default": "true", 43 "default": "true",
44 "description": "Returns response with indentations and line breaks." , 44 "description": "Returns response with indentations and line breaks." ,
45 "location": "query", 45 "location": "query",
46 "type": "boolean" 46 "type": "boolean"
47 }, 47 },
48 "uploadType": {
49 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
50 "location": "query",
51 "type": "string"
52 },
48 "fields": { 53 "fields": {
49 "description": "Selector specifying which fields to include in a par tial response.", 54 "description": "Selector specifying which fields to include in a par tial response.",
50 "location": "query", 55 "location": "query",
51 "type": "string" 56 "type": "string"
52 }, 57 },
53 "uploadType": {
54 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
55 "location": "query",
56 "type": "string"
57 },
58 "callback": {
59 "description": "JSONP",
60 "location": "query",
61 "type": "string"
62 },
63 "$.xgafv": { 58 "$.xgafv": {
64 "description": "V1 error format.", 59 "description": "V1 error format.",
65 "enum": [ 60 "enum": [
66 "1", 61 "1",
67 "2" 62 "2"
68 ], 63 ],
69 "enumDescriptions": [ 64 "enumDescriptions": [
70 "v1 error format", 65 "v1 error format",
71 "v2 error format" 66 "v2 error format"
72 ], 67 ],
73 "location": "query", 68 "location": "query",
74 "type": "string" 69 "type": "string"
75 }, 70 },
71 "callback": {
72 "description": "JSONP",
73 "location": "query",
74 "type": "string"
75 },
76 "alt": { 76 "alt": {
77 "default": "json", 77 "default": "json",
78 "description": "Data format for response.", 78 "description": "Data format for response.",
79 "enum": [ 79 "enum": [
80 "json", 80 "json",
81 "media", 81 "media",
82 "proto" 82 "proto"
83 ], 83 ],
84 "enumDescriptions": [ 84 "enumDescriptions": [
85 "Responses with Content-Type of application/json", 85 "Responses with Content-Type of application/json",
(...skipping 17 matching lines...) Expand all
103 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 103 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
104 "location": "query", 104 "location": "query",
105 "type": "string" 105 "type": "string"
106 }, 106 },
107 "pp": { 107 "pp": {
108 "default": "true", 108 "default": "true",
109 "description": "Pretty-print response.", 109 "description": "Pretty-print response.",
110 "location": "query", 110 "location": "query",
111 "type": "boolean" 111 "type": "boolean"
112 }, 112 },
113 "oauth_token": {
114 "description": "OAuth 2.0 token for the current user.",
115 "location": "query",
116 "type": "string"
117 },
113 "bearer_token": { 118 "bearer_token": {
114 "description": "OAuth bearer token.", 119 "description": "OAuth bearer token.",
115 "location": "query", 120 "location": "query",
116 "type": "string" 121 "type": "string"
117 },
118 "oauth_token": {
119 "description": "OAuth 2.0 token for the current user.",
120 "location": "query",
121 "type": "string"
122 } 122 }
123 }, 123 },
124 "protocol": "rest", 124 "protocol": "rest",
125 "resources": { 125 "resources": {
126 "spreadsheets": { 126 "spreadsheets": {
127 "methods": { 127 "methods": {
128 "get": { 128 "get": {
129 "description": "Returns the spreadsheet at the given ID.\nTh e caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a fiel d mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n * Set the includeGridData\nURL parameter to true. If a field mask is set, the ` includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommen ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult iple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified u sing A1 notation.", 129 "description": "Returns the spreadsheet at the given ID.\nTh e caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a fiel d mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n * Set the includeGridData\nURL parameter to true. If a field mask is set, the ` includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommen ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult iple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified u sing A1 notation.",
130 "httpMethod": "GET", 130 "httpMethod": "GET",
131 "id": "sheets.spreadsheets.get", 131 "id": "sheets.spreadsheets.get",
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after
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": {
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/api/guides/values#append ing_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInpu tOption` only\ncontrols how the input data will be added to the sheet (column-wi se or\nrow-wise), it does not influence what cell the data starts being written\ nto.",
216 "httpMethod": "POST",
217 "id": "sheets.spreadsheets.values.append",
218 "parameterOrder": [
219 "spreadsheetId",
220 "range"
221 ],
222 "parameters": {
223 "responseDateTimeRenderOption": {
224 "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_ value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
225 "enum": [
226 "SERIAL_NUMBER",
227 "FORMATTED_STRING"
228 ],
229 "location": "query",
230 "type": "string"
231 },
232 "range": {
233 "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.",
234 "location": "path",
235 "required": true,
236 "type": "string"
237 },
238 "includeValuesInResponse": {
239 "description": "Determines if the update res ponse should include the values\nof the cells that were appended. By default, re sponses\ndo not include the updated values.",
240 "location": "query",
241 "type": "boolean"
242 },
243 "spreadsheetId": {
244 "description": "The ID of the spreadsheet to update.",
245 "location": "path",
246 "required": true,
247 "type": "string"
248 },
249 "responseValueRenderOption": {
250 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
251 "enum": [
252 "FORMATTED_VALUE",
253 "UNFORMATTED_VALUE",
254 "FORMULA"
255 ],
256 "location": "query",
257 "type": "string"
258 },
259 "insertDataOption": {
260 "description": "How the input data should be inserted.",
261 "enum": [
262 "OVERWRITE",
263 "INSERT_ROWS"
264 ],
265 "location": "query",
266 "type": "string"
267 },
268 "valueInputOption": {
269 "description": "How the input data should be interpreted.",
270 "enum": [
271 "INPUT_VALUE_OPTION_UNSPECIFIED",
272 "RAW",
273 "USER_ENTERED"
274 ],
275 "location": "query",
276 "type": "string"
277 }
278 },
279 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append",
280 "request": {
281 "$ref": "ValueRange"
282 },
283 "response": {
284 "$ref": "AppendValuesResponse"
285 },
286 "scopes": [
287 "https://www.googleapis.com/auth/drive",
288 "https://www.googleapis.com/auth/spreadsheets"
289 ]
290 },
291 "batchClear": {
292 "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.",
293 "httpMethod": "POST",
294 "id": "sheets.spreadsheets.values.batchClear",
295 "parameterOrder": [
296 "spreadsheetId"
297 ],
298 "parameters": {
299 "spreadsheetId": {
300 "description": "The ID of the spreadsheet to update.",
301 "location": "path",
302 "required": true,
303 "type": "string"
304 }
305 },
306 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hClear",
307 "request": {
308 "$ref": "BatchClearValuesRequest"
309 },
310 "response": {
311 "$ref": "BatchClearValuesResponse"
312 },
313 "scopes": [
314 "https://www.googleapis.com/auth/drive",
315 "https://www.googleapis.com/auth/spreadsheets"
316 ]
317 },
214 "get": { 318 "get": {
215 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.", 319 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.",
216 "httpMethod": "GET", 320 "httpMethod": "GET",
217 "id": "sheets.spreadsheets.values.get", 321 "id": "sheets.spreadsheets.values.get",
218 "parameterOrder": [ 322 "parameterOrder": [
219 "spreadsheetId", 323 "spreadsheetId",
220 "range" 324 "range"
221 ], 325 ],
222 "parameters": { 326 "parameters": {
223 "range": {
224 "description": "The A1 notation of the value s to retrieve.",
225 "location": "path",
226 "required": true,
227 "type": "string"
228 },
229 "valueRenderOption": { 327 "valueRenderOption": {
230 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.", 328 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.",
231 "enum": [ 329 "enum": [
232 "FORMATTED_VALUE", 330 "FORMATTED_VALUE",
233 "UNFORMATTED_VALUE", 331 "UNFORMATTED_VALUE",
234 "FORMULA" 332 "FORMULA"
235 ], 333 ],
236 "location": "query", 334 "location": "query",
237 "type": "string" 335 "type": "string"
238 }, 336 },
(...skipping 14 matching lines...) Expand all
253 "COLUMNS" 351 "COLUMNS"
254 ], 352 ],
255 "location": "query", 353 "location": "query",
256 "type": "string" 354 "type": "string"
257 }, 355 },
258 "spreadsheetId": { 356 "spreadsheetId": {
259 "description": "The ID of the spreadsheet to retrieve data from.", 357 "description": "The ID of the spreadsheet to retrieve data from.",
260 "location": "path", 358 "location": "path",
261 "required": true, 359 "required": true,
262 "type": "string" 360 "type": "string"
361 },
362 "range": {
363 "description": "The A1 notation of the value s to retrieve.",
364 "location": "path",
365 "required": true,
366 "type": "string"
263 } 367 }
264 }, 368 },
265 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}", 369 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}",
266 "response": { 370 "response": {
267 "$ref": "ValueRange" 371 "$ref": "ValueRange"
268 }, 372 },
269 "scopes": [ 373 "scopes": [
270 "https://www.googleapis.com/auth/drive", 374 "https://www.googleapis.com/auth/drive",
271 "https://www.googleapis.com/auth/drive.readonly" , 375 "https://www.googleapis.com/auth/drive.readonly" ,
272 "https://www.googleapis.com/auth/spreadsheets", 376 "https://www.googleapis.com/auth/spreadsheets",
(...skipping 88 matching lines...) Expand 10 before | Expand all | Expand 10 after
361 "$ref": "BatchUpdateValuesRequest" 465 "$ref": "BatchUpdateValuesRequest"
362 }, 466 },
363 "response": { 467 "response": {
364 "$ref": "BatchUpdateValuesResponse" 468 "$ref": "BatchUpdateValuesResponse"
365 }, 469 },
366 "scopes": [ 470 "scopes": [
367 "https://www.googleapis.com/auth/drive", 471 "https://www.googleapis.com/auth/drive",
368 "https://www.googleapis.com/auth/spreadsheets" 472 "https://www.googleapis.com/auth/spreadsheets"
369 ] 473 ]
370 }, 474 },
475 "clear": {
476 "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.",
477 "httpMethod": "POST",
478 "id": "sheets.spreadsheets.values.clear",
479 "parameterOrder": [
480 "spreadsheetId",
481 "range"
482 ],
483 "parameters": {
484 "spreadsheetId": {
485 "description": "The ID of the spreadsheet to update.",
486 "location": "path",
487 "required": true,
488 "type": "string"
489 },
490 "range": {
491 "description": "The A1 notation of the value s to clear.",
492 "location": "path",
493 "required": true,
494 "type": "string"
495 }
496 },
497 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:clear",
498 "request": {
499 "$ref": "ClearValuesRequest"
500 },
501 "response": {
502 "$ref": "ClearValuesResponse"
503 },
504 "scopes": [
505 "https://www.googleapis.com/auth/drive",
506 "https://www.googleapis.com/auth/spreadsheets"
507 ]
508 },
371 "batchGet": { 509 "batchGet": {
372 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.", 510 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
373 "httpMethod": "GET", 511 "httpMethod": "GET",
374 "id": "sheets.spreadsheets.values.batchGet", 512 "id": "sheets.spreadsheets.values.batchGet",
375 "parameterOrder": [ 513 "parameterOrder": [
376 "spreadsheetId" 514 "spreadsheetId"
377 ], 515 ],
378 "parameters": { 516 "parameters": {
379 "spreadsheetId": { 517 "spreadsheetId": {
380 "description": "The ID of the spreadsheet to retrieve data from.", 518 "description": "The ID of the spreadsheet to retrieve data from.",
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
421 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hGet", 559 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hGet",
422 "response": { 560 "response": {
423 "$ref": "BatchGetValuesResponse" 561 "$ref": "BatchGetValuesResponse"
424 }, 562 },
425 "scopes": [ 563 "scopes": [
426 "https://www.googleapis.com/auth/drive", 564 "https://www.googleapis.com/auth/drive",
427 "https://www.googleapis.com/auth/drive.readonly" , 565 "https://www.googleapis.com/auth/drive.readonly" ,
428 "https://www.googleapis.com/auth/spreadsheets", 566 "https://www.googleapis.com/auth/spreadsheets",
429 "https://www.googleapis.com/auth/spreadsheets.re adonly" 567 "https://www.googleapis.com/auth/spreadsheets.re adonly"
430 ] 568 ]
431 },
432 "clear": {
433 "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.",
434 "httpMethod": "POST",
435 "id": "sheets.spreadsheets.values.clear",
436 "parameterOrder": [
437 "spreadsheetId",
438 "range"
439 ],
440 "parameters": {
441 "spreadsheetId": {
442 "description": "The ID of the spreadsheet to update.",
443 "location": "path",
444 "required": true,
445 "type": "string"
446 },
447 "range": {
448 "description": "The A1 notation of the value s to clear.",
449 "location": "path",
450 "required": true,
451 "type": "string"
452 }
453 },
454 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:clear",
455 "request": {
456 "$ref": "ClearValuesRequest"
457 },
458 "response": {
459 "$ref": "ClearValuesResponse"
460 },
461 "scopes": [
462 "https://www.googleapis.com/auth/drive",
463 "https://www.googleapis.com/auth/spreadsheets"
464 ]
465 },
466 "append": {
467 "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/api/guides/values#append ing_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInpu tOption` only\ncontrols how the input data will be added to the sheet (column-wi se or\nrow-wise), it does not influence what cell the data starts being written\ nto.",
468 "httpMethod": "POST",
469 "id": "sheets.spreadsheets.values.append",
470 "parameterOrder": [
471 "spreadsheetId",
472 "range"
473 ],
474 "parameters": {
475 "responseValueRenderOption": {
476 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
477 "enum": [
478 "FORMATTED_VALUE",
479 "UNFORMATTED_VALUE",
480 "FORMULA"
481 ],
482 "location": "query",
483 "type": "string"
484 },
485 "insertDataOption": {
486 "description": "How the input data should be inserted.",
487 "enum": [
488 "OVERWRITE",
489 "INSERT_ROWS"
490 ],
491 "location": "query",
492 "type": "string"
493 },
494 "valueInputOption": {
495 "description": "How the input data should be interpreted.",
496 "enum": [
497 "INPUT_VALUE_OPTION_UNSPECIFIED",
498 "RAW",
499 "USER_ENTERED"
500 ],
501 "location": "query",
502 "type": "string"
503 },
504 "responseDateTimeRenderOption": {
505 "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_ value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
506 "enum": [
507 "SERIAL_NUMBER",
508 "FORMATTED_STRING"
509 ],
510 "location": "query",
511 "type": "string"
512 },
513 "range": {
514 "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.",
515 "location": "path",
516 "required": true,
517 "type": "string"
518 },
519 "includeValuesInResponse": {
520 "description": "Determines if the update res ponse should include the values\nof the cells that were appended. By default, re sponses\ndo not include the updated values.",
521 "location": "query",
522 "type": "boolean"
523 },
524 "spreadsheetId": {
525 "description": "The ID of the spreadsheet to update.",
526 "location": "path",
527 "required": true,
528 "type": "string"
529 }
530 },
531 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append",
532 "request": {
533 "$ref": "ValueRange"
534 },
535 "response": {
536 "$ref": "AppendValuesResponse"
537 },
538 "scopes": [
539 "https://www.googleapis.com/auth/drive",
540 "https://www.googleapis.com/auth/spreadsheets"
541 ]
542 },
543 "batchClear": {
544 "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.",
545 "httpMethod": "POST",
546 "id": "sheets.spreadsheets.values.batchClear",
547 "parameterOrder": [
548 "spreadsheetId"
549 ],
550 "parameters": {
551 "spreadsheetId": {
552 "description": "The ID of the spreadsheet to update.",
553 "location": "path",
554 "required": true,
555 "type": "string"
556 }
557 },
558 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hClear",
559 "request": {
560 "$ref": "BatchClearValuesRequest"
561 },
562 "response": {
563 "$ref": "BatchClearValuesResponse"
564 },
565 "scopes": [
566 "https://www.googleapis.com/auth/drive",
567 "https://www.googleapis.com/auth/spreadsheets"
568 ]
569 } 569 }
570 } 570 }
571 }, 571 },
572 "sheets": { 572 "sheets": {
573 "methods": { 573 "methods": {
574 "copyTo": { 574 "copyTo": {
575 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ", 575 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ",
576 "httpMethod": "POST", 576 "httpMethod": "POST",
577 "id": "sheets.spreadsheets.sheets.copyTo", 577 "id": "sheets.spreadsheets.sheets.copyTo",
578 "parameterOrder": [ 578 "parameterOrder": [
579 "spreadsheetId", 579 "spreadsheetId",
580 "sheetId" 580 "sheetId"
581 ], 581 ],
582 "parameters": { 582 "parameters": {
583 "spreadsheetId": {
584 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
585 "location": "path",
586 "required": true,
587 "type": "string"
588 },
589 "sheetId": { 583 "sheetId": {
590 "description": "The ID of the sheet to copy. ", 584 "description": "The ID of the sheet to copy. ",
591 "format": "int32", 585 "format": "int32",
592 "location": "path", 586 "location": "path",
593 "required": true, 587 "required": true,
594 "type": "integer" 588 "type": "integer"
589 },
590 "spreadsheetId": {
591 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
592 "location": "path",
593 "required": true,
594 "type": "string"
595 } 595 }
596 }, 596 },
597 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo", 597 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo",
598 "request": { 598 "request": {
599 "$ref": "CopySheetToAnotherSpreadsheetRequest" 599 "$ref": "CopySheetToAnotherSpreadsheetRequest"
600 }, 600 },
601 "response": { 601 "response": {
602 "$ref": "SheetProperties" 602 "$ref": "SheetProperties"
603 }, 603 },
604 "scopes": [ 604 "scopes": [
605 "https://www.googleapis.com/auth/drive", 605 "https://www.googleapis.com/auth/drive",
606 "https://www.googleapis.com/auth/spreadsheets" 606 "https://www.googleapis.com/auth/spreadsheets"
607 ] 607 ]
608 } 608 }
609 } 609 }
610 } 610 }
611 } 611 }
612 } 612 }
613 }, 613 },
614 "revision": "20170317", 614 "revision": "20170414",
615 "rootUrl": "https://sheets.googleapis.com/", 615 "rootUrl": "https://sheets.googleapis.com/",
616 "schemas": { 616 "schemas": {
617 "UpdateChartSpecRequest": { 617 "FilterView": {
618 "description": "Updates a chart's specifications.\n(This does not mo ve or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPosit ionRequest.)", 618 "description": "A filter view.",
619 "id": "UpdateChartSpecRequest", 619 "id": "FilterView",
620 "properties": { 620 "properties": {
621 "spec": { 621 "filterViewId": {
622 "$ref": "ChartSpec", 622 "description": "The ID of the filter view.",
623 "description": "The specification to apply to the chart."
624 },
625 "chartId": {
626 "description": "The ID of the chart to update.",
627 "format": "int32",
628 "type": "integer"
629 }
630 },
631 "type": "object"
632 },
633 "DeleteFilterViewRequest": {
634 "description": "Deletes a particular filter view.",
635 "id": "DeleteFilterViewRequest",
636 "properties": {
637 "filterId": {
638 "description": "The ID of the filter to delete.",
639 "format": "int32",
640 "type": "integer"
641 }
642 },
643 "type": "object"
644 },
645 "BatchUpdateValuesResponse": {
646 "description": "The response when updating a range of values in a sp readsheet.",
647 "id": "BatchUpdateValuesResponse",
648 "properties": {
649 "spreadsheetId": {
650 "description": "The spreadsheet the updates were applied to. ",
651 "type": "string"
652 },
653 "totalUpdatedRows": {
654 "description": "The total number of rows where at least one cell in the row was updated.",
655 "format": "int32", 623 "format": "int32",
656 "type": "integer" 624 "type": "integer"
657 }, 625 },
658 "responses": { 626 "criteria": {
659 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.", 627 "additionalProperties": {
660 "items": { 628 "$ref": "FilterCriteria"
661 "$ref": "UpdateValuesResponse"
662 }, 629 },
663 "type": "array" 630 "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.",
631 "type": "object"
664 }, 632 },
665 "totalUpdatedSheets": { 633 "title": {
666 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.", 634 "description": "The name of the filter view.",
667 "format": "int32", 635 "type": "string"
668 "type": "integer"
669 }, 636 },
670 "totalUpdatedCells": {
671 "description": "The total number of cells updated.",
672 "format": "int32",
673 "type": "integer"
674 },
675 "totalUpdatedColumns": {
676 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
677 "format": "int32",
678 "type": "integer"
679 }
680 },
681 "type": "object"
682 },
683 "SortRangeRequest": {
684 "description": "Sorts data in rows based on a sort order per column. ",
685 "id": "SortRangeRequest",
686 "properties": {
687 "range": { 637 "range": {
688 "$ref": "GridRange", 638 "$ref": "GridRange",
689 "description": "The range to sort." 639 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or named_range_id\nmay be set."
690 }, 640 },
691 "sortSpecs": { 641 "sortSpecs": {
692 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 642 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
693 "items": { 643 "items": {
694 "$ref": "SortSpec" 644 "$ref": "SortSpec"
695 }, 645 },
696 "type": "array" 646 "type": "array"
697 } 647 },
698 }, 648 "namedRangeId": {
699 "type": "object" 649 "description": "The named range this filter view is backed b y, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
700 }, 650 "type": "string"
701 "MergeCellsRequest": { 651 }
702 "description": "Merges all cells in the range.", 652 },
703 "id": "MergeCellsRequest", 653 "type": "object"
704 "properties": { 654 },
705 "mergeType": { 655 "BandingProperties": {
706 "description": "How the cells should be merged.", 656 "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.",
707 "enum": [ 657 "id": "BandingProperties",
708 "MERGE_ALL", 658 "properties": {
709 "MERGE_COLUMNS", 659 "footerColor": {
710 "MERGE_ROWS" 660 "$ref": "Color",
711 ], 661 "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_band _color or\nsecond_band_color, depending on the color of the previous row or\ncol umn."
712 "enumDescriptions": [ 662 },
713 "Create a single merge from the range", 663 "headerColor": {
714 "Create a merge for each column in the range", 664 "$ref": "Color",
715 "Create a merge for each row in the range" 665 "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 starting\n from the second row or column. Otherwise, the first row or column will be\nfille d with first_band_color and the colors will proceed to alternate\nas they normal ly would."
716 ], 666 },
717 "type": "string" 667 "firstBandColor": {
718 }, 668 "$ref": "Color",
669 "description": "The first color that is alternating. (Requir ed)"
670 },
671 "secondBandColor": {
672 "$ref": "Color",
673 "description": "The second color that is alternating. (Requi red)"
674 }
675 },
676 "type": "object"
677 },
678 "AddProtectedRangeResponse": {
679 "description": "The result of adding a new protected range.",
680 "id": "AddProtectedRangeResponse",
681 "properties": {
682 "protectedRange": {
683 "$ref": "ProtectedRange",
684 "description": "The newly added protected range."
685 }
686 },
687 "type": "object"
688 },
689 "BasicFilter": {
690 "description": "The default filter associated with a sheet.",
691 "id": "BasicFilter",
692 "properties": {
719 "range": { 693 "range": {
720 "$ref": "GridRange", 694 "$ref": "GridRange",
721 "description": "The range of cells to merge." 695 "description": "The range the filter covers."
722 }
723 },
724 "type": "object"
725 },
726 "AddProtectedRangeRequest": {
727 "description": "Adds a new protected range.",
728 "id": "AddProtectedRangeRequest",
729 "properties": {
730 "protectedRange": {
731 "$ref": "ProtectedRange",
732 "description": "The protected range to be added. The\nprotec tedRangeId field is optional; if\none is not set, an id will be randomly generat ed. (It is an error to\nspecify the ID of a range that already exists.)"
733 }
734 },
735 "type": "object"
736 },
737 "BatchClearValuesRequest": {
738 "description": "The request for clearing more than one range of valu es in a spreadsheet.",
739 "id": "BatchClearValuesRequest",
740 "properties": {
741 "ranges": {
742 "description": "The ranges to clear, in A1 notation.",
743 "items": {
744 "type": "string"
745 },
746 "type": "array"
747 }
748 },
749 "type": "object"
750 },
751 "DuplicateFilterViewResponse": {
752 "description": "The result of a filter view being duplicated.",
753 "id": "DuplicateFilterViewResponse",
754 "properties": {
755 "filter": {
756 "$ref": "FilterView",
757 "description": "The newly created filter."
758 }
759 },
760 "type": "object"
761 },
762 "DuplicateSheetResponse": {
763 "description": "The result of duplicating a sheet.",
764 "id": "DuplicateSheetResponse",
765 "properties": {
766 "properties": {
767 "$ref": "SheetProperties",
768 "description": "The properties of the duplicate sheet."
769 }
770 },
771 "type": "object"
772 },
773 "TextToColumnsRequest": {
774 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.",
775 "id": "TextToColumnsRequest",
776 "properties": {
777 "source": {
778 "$ref": "GridRange",
779 "description": "The source data range. This must span exact ly one column."
780 },
781 "delimiterType": {
782 "description": "The delimiter type to use.",
783 "enum": [
784 "DELIMITER_TYPE_UNSPECIFIED",
785 "COMMA",
786 "SEMICOLON",
787 "PERIOD",
788 "SPACE",
789 "CUSTOM"
790 ],
791 "enumDescriptions": [
792 "Default value. This value must not be used.",
793 "\",\"",
794 "\";\"",
795 "\".\"",
796 "\" \"",
797 "A custom value as defined in delimiter."
798 ],
799 "type": "string"
800 },
801 "delimiter": {
802 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.",
803 "type": "string"
804 }
805 },
806 "type": "object"
807 },
808 "ClearBasicFilterRequest": {
809 "description": "Clears the basic filter, if any exists on the sheet. ",
810 "id": "ClearBasicFilterRequest",
811 "properties": {
812 "sheetId": {
813 "description": "The sheet ID on which the basic filter shoul d be cleared.",
814 "format": "int32",
815 "type": "integer"
816 }
817 },
818 "type": "object"
819 },
820 "BatchUpdateSpreadsheetResponse": {
821 "description": "The reply for batch updating a spreadsheet.",
822 "id": "BatchUpdateSpreadsheetResponse",
823 "properties": {
824 "replies": {
825 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.",
826 "items": {
827 "$ref": "Response"
828 },
829 "type": "array"
830 },
831 "updatedSpreadsheet": {
832 "$ref": "Spreadsheet",
833 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`."
834 },
835 "spreadsheetId": {
836 "description": "The spreadsheet the updates were applied to. ",
837 "type": "string"
838 }
839 },
840 "type": "object"
841 },
842 "DeleteBandingRequest": {
843 "description": "Removes the banded range with the given ID from the spreadsheet.",
844 "id": "DeleteBandingRequest",
845 "properties": {
846 "bandedRangeId": {
847 "description": "The ID of the banded range to delete.",
848 "format": "int32",
849 "type": "integer"
850 }
851 },
852 "type": "object"
853 },
854 "AppendValuesResponse": {
855 "description": "The response when updating a range of values in a sp readsheet.",
856 "id": "AppendValuesResponse",
857 "properties": {
858 "spreadsheetId": {
859 "description": "The spreadsheet the updates were applied to. ",
860 "type": "string"
861 },
862 "updates": {
863 "$ref": "UpdateValuesResponse",
864 "description": "Information about the updates that were appl ied."
865 },
866 "tableRange": {
867 "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no t able was found.",
868 "type": "string"
869 }
870 },
871 "type": "object"
872 },
873 "MoveDimensionRequest": {
874 "description": "Moves one or more rows or columns.",
875 "id": "MoveDimensionRequest",
876 "properties": {
877 "destinationIndex": {
878 "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is remove d\nfrom the grid. Existing data will be shifted down or right\n(depending on th e dimension) to make room for the moved dimensions.\nThe source dimensions are r emoved from the grid, so the\nthe data may end up in a different index than spec ified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\ "1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1. .3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5) .\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
879 "format": "int32",
880 "type": "integer"
881 },
882 "source": {
883 "$ref": "DimensionRange",
884 "description": "The source dimensions to move."
885 }
886 },
887 "type": "object"
888 },
889 "PivotFilterCriteria": {
890 "description": "Criteria for showing/hiding rows in a pivot table.",
891 "id": "PivotFilterCriteria",
892 "properties": {
893 "visibleValues": {
894 "description": "Values that should be included. Values not listed here are excluded.",
895 "items": {
896 "type": "string"
897 },
898 "type": "array"
899 }
900 },
901 "type": "object"
902 },
903 "AddFilterViewRequest": {
904 "description": "Adds a filter view.",
905 "id": "AddFilterViewRequest",
906 "properties": {
907 "filter": {
908 "$ref": "FilterView",
909 "description": "The filter to add. The filterViewId\nfield i s optional; if one is not set, an id will be randomly generated. (It\nis an erro r to specify the ID of a filter that already exists.)"
910 }
911 },
912 "type": "object"
913 },
914 "AddConditionalFormatRuleRequest": {
915 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.",
916 "id": "AddConditionalFormatRuleRequest",
917 "properties": {
918 "rule": {
919 "$ref": "ConditionalFormatRule",
920 "description": "The rule to add."
921 },
922 "index": {
923 "description": "The zero-based index where the rule should b e inserted.",
924 "format": "int32",
925 "type": "integer"
926 }
927 },
928 "type": "object"
929 },
930 "ChartSpec": {
931 "description": "The specifications of a chart.",
932 "id": "ChartSpec",
933 "properties": {
934 "title": {
935 "description": "The title of the chart.",
936 "type": "string"
937 },
938 "pieChart": {
939 "$ref": "PieChartSpec",
940 "description": "A pie chart specification."
941 },
942 "basicChart": {
943 "$ref": "BasicChartSpec",
944 "description": "A basic chart specification, can be one of m any kinds of charts.\nSee BasicChartType for the list of all\ncharts this suppor ts."
945 },
946 "hiddenDimensionStrategy": {
947 "description": "Determines how the charts will use hidden ro ws or columns.",
948 "enum": [
949 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
950 "SKIP_HIDDEN_ROWS_AND_COLUMNS",
951 "SKIP_HIDDEN_ROWS",
952 "SKIP_HIDDEN_COLUMNS",
953 "SHOW_ALL"
954 ],
955 "enumDescriptions": [
956 "Default value, do not use.",
957 "Charts will skip hidden rows and columns.",
958 "Charts will skip hidden rows only.",
959 "Charts will skip hidden columns only.",
960 "Charts will not skip any hidden rows or columns."
961 ],
962 "type": "string"
963 }
964 },
965 "type": "object"
966 },
967 "NumberFormat": {
968 "description": "The number format of a cell.",
969 "id": "NumberFormat",
970 "properties": {
971 "type": {
972 "description": "The type of the number format.\nWhen writing , this field must be set.",
973 "enum": [
974 "NUMBER_FORMAT_TYPE_UNSPECIFIED",
975 "TEXT",
976 "NUMBER",
977 "PERCENT",
978 "CURRENCY",
979 "DATE",
980 "TIME",
981 "DATE_TIME",
982 "SCIENTIFIC"
983 ],
984 "enumDescriptions": [
985 "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
986 "Text formatting, e.g `1000.12`",
987 "Number formatting, e.g, `1,000.12`",
988 "Percent formatting, e.g `10.12%`",
989 "Currency formatting, e.g `$1,000.12`",
990 "Date formatting, e.g `9/26/2008`",
991 "Time formatting, e.g `3:59:00 PM`",
992 "Date+Time formatting, e.g `9/26/08 15:59:00`",
993 "Scientific number formatting, e.g `1.01E+03`"
994 ],
995 "type": "string"
996 },
997 "pattern": {
998 "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/api/guides/for mats) for more\ninformation about the supported patterns.",
999 "type": "string"
1000 }
1001 },
1002 "type": "object"
1003 },
1004 "SheetProperties": {
1005 "description": "Properties of a sheet.",
1006 "id": "SheetProperties",
1007 "properties": {
1008 "title": {
1009 "description": "The name of the sheet.",
1010 "type": "string"
1011 },
1012 "tabColor": {
1013 "$ref": "Color",
1014 "description": "The color of the tab in the UI."
1015 },
1016 "index": {
1017 "description": "The index of the sheet within the spreadshee t.\nWhen adding or updating sheet properties, if this field\nis excluded then th e sheet will be added or moved to the end\nof the sheet list. When updating shee t indices or inserting\nsheets, movement is considered in \"before the move\" in dexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ah ead of S2 the index would have to be set to 2. A sheet\nindex update request wil l be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
1018 "format": "int32",
1019 "type": "integer"
1020 },
1021 "sheetId": {
1022 "description": "The ID of the sheet. Must be non-negative.\n This field cannot be changed once set.",
1023 "format": "int32",
1024 "type": "integer"
1025 },
1026 "rightToLeft": {
1027 "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
1028 "type": "boolean"
1029 },
1030 "hidden": {
1031 "description": "True if the sheet is hidden in the UI, false if it's visible.",
1032 "type": "boolean"
1033 },
1034 "gridProperties": {
1035 "$ref": "GridProperties",
1036 "description": "Additional properties of the sheet if this s heet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid p roperties on non-grid sheets."
1037 },
1038 "sheetType": {
1039 "description": "The type of sheet. Defaults to GRID.\nThis f ield cannot be changed once set.",
1040 "enum": [
1041 "SHEET_TYPE_UNSPECIFIED",
1042 "GRID",
1043 "OBJECT"
1044 ],
1045 "enumDescriptions": [
1046 "Default value, do not use.",
1047 "The sheet is a grid.",
1048 "The sheet has no grid and instead has an object like a chart or image."
1049 ],
1050 "type": "string"
1051 }
1052 },
1053 "type": "object"
1054 },
1055 "UpdateDimensionPropertiesRequest": {
1056 "description": "Updates properties of dimensions within the specifie d range.",
1057 "id": "UpdateDimensionPropertiesRequest",
1058 "properties": {
1059 "fields": {
1060 "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 .",
1061 "format": "google-fieldmask",
1062 "type": "string"
1063 },
1064 "properties": {
1065 "$ref": "DimensionProperties",
1066 "description": "Properties to update."
1067 },
1068 "range": {
1069 "$ref": "DimensionRange",
1070 "description": "The rows or columns to update."
1071 }
1072 },
1073 "type": "object"
1074 },
1075 "SourceAndDestination": {
1076 "description": "A combination of a source range and how to extend th at source.",
1077 "id": "SourceAndDestination",
1078 "properties": {
1079 "source": {
1080 "$ref": "GridRange",
1081 "description": "The location of the data to use as the sourc e of the autofill."
1082 },
1083 "dimension": {
1084 "description": "The dimension that data should be filled int o.",
1085 "enum": [
1086 "DIMENSION_UNSPECIFIED",
1087 "ROWS",
1088 "COLUMNS"
1089 ],
1090 "enumDescriptions": [
1091 "The default value, do not use.",
1092 "Operates on the rows of a sheet.",
1093 "Operates on the columns of a sheet."
1094 ],
1095 "type": "string"
1096 },
1097 "fillLength": {
1098 "description": "The number of rows or columns that data shou ld be filled into.\nPositive numbers expand beyond the last row or last column\n of the source. Negative numbers expand before the first row\nor first column of the source.",
1099 "format": "int32",
1100 "type": "integer"
1101 }
1102 },
1103 "type": "object"
1104 },
1105 "FilterView": {
1106 "description": "A filter view.",
1107 "id": "FilterView",
1108 "properties": {
1109 "namedRangeId": {
1110 "description": "The named range this filter view is backed b y, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
1111 "type": "string"
1112 },
1113 "filterViewId": {
1114 "description": "The ID of the filter view.",
1115 "format": "int32",
1116 "type": "integer"
1117 },
1118 "range": {
1119 "$ref": "GridRange",
1120 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or named_range_id\nmay be set."
1121 }, 696 },
1122 "criteria": { 697 "criteria": {
1123 "additionalProperties": { 698 "additionalProperties": {
1124 "$ref": "FilterCriteria" 699 "$ref": "FilterCriteria"
1125 }, 700 },
1126 "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.", 701 "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.",
1127 "type": "object" 702 "type": "object"
1128 }, 703 },
1129 "title": {
1130 "description": "The name of the filter view.",
1131 "type": "string"
1132 },
1133 "sortSpecs": { 704 "sortSpecs": {
1134 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 705 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
1135 "items": { 706 "items": {
1136 "$ref": "SortSpec" 707 "$ref": "SortSpec"
1137 }, 708 },
1138 "type": "array" 709 "type": "array"
1139 } 710 }
1140 }, 711 },
1141 "type": "object" 712 "type": "object"
1142 }, 713 },
1143 "BandingProperties": {
1144 "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.",
1145 "id": "BandingProperties",
1146 "properties": {
1147 "secondBandColor": {
1148 "$ref": "Color",
1149 "description": "The second color that is alternating. (Requi red)"
1150 },
1151 "footerColor": {
1152 "$ref": "Color",
1153 "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_band _color or\nsecond_band_color, depending on the color of the previous row or\ncol umn."
1154 },
1155 "headerColor": {
1156 "$ref": "Color",
1157 "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 starting\n from the second row or column. Otherwise, the first row or column will be\nfille d with first_band_color and the colors will proceed to alternate\nas they normal ly would."
1158 },
1159 "firstBandColor": {
1160 "$ref": "Color",
1161 "description": "The first color that is alternating. (Requir ed)"
1162 }
1163 },
1164 "type": "object"
1165 },
1166 "AddProtectedRangeResponse": {
1167 "description": "The result of adding a new protected range.",
1168 "id": "AddProtectedRangeResponse",
1169 "properties": {
1170 "protectedRange": {
1171 "$ref": "ProtectedRange",
1172 "description": "The newly added protected range."
1173 }
1174 },
1175 "type": "object"
1176 },
1177 "BasicFilter": {
1178 "description": "The default filter associated with a sheet.",
1179 "id": "BasicFilter",
1180 "properties": {
1181 "range": {
1182 "$ref": "GridRange",
1183 "description": "The range the filter covers."
1184 },
1185 "criteria": {
1186 "additionalProperties": {
1187 "$ref": "FilterCriteria"
1188 },
1189 "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.",
1190 "type": "object"
1191 },
1192 "sortSpecs": {
1193 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
1194 "items": {
1195 "$ref": "SortSpec"
1196 },
1197 "type": "array"
1198 }
1199 },
1200 "type": "object"
1201 },
1202 "UpdateValuesResponse": { 714 "UpdateValuesResponse": {
1203 "description": "The response when updating a range of values in a sp readsheet.", 715 "description": "The response when updating a range of values in a sp readsheet.",
1204 "id": "UpdateValuesResponse", 716 "id": "UpdateValuesResponse",
1205 "properties": { 717 "properties": {
718 "spreadsheetId": {
719 "description": "The spreadsheet the updates were applied to. ",
720 "type": "string"
721 },
722 "updatedRange": {
723 "description": "The range (in A1 notation) that updates were applied to.",
724 "type": "string"
725 },
1206 "updatedCells": { 726 "updatedCells": {
1207 "description": "The number of cells updated.", 727 "description": "The number of cells updated.",
1208 "format": "int32", 728 "format": "int32",
1209 "type": "integer" 729 "type": "integer"
1210 }, 730 },
731 "updatedRows": {
732 "description": "The number of rows where at least one cell i n the row was updated.",
733 "format": "int32",
734 "type": "integer"
735 },
1211 "updatedData": { 736 "updatedData": {
1212 "$ref": "ValueRange", 737 "$ref": "ValueRange",
1213 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`." 738 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`."
1214 }, 739 },
1215 "updatedRows": {
1216 "description": "The number of rows where at least one cell i n the row was updated.",
1217 "format": "int32",
1218 "type": "integer"
1219 },
1220 "updatedColumns": { 740 "updatedColumns": {
1221 "description": "The number of columns where at least one cel l in the column was updated.", 741 "description": "The number of columns where at least one cel l in the column was updated.",
1222 "format": "int32", 742 "format": "int32",
1223 "type": "integer" 743 "type": "integer"
1224 },
1225 "spreadsheetId": {
1226 "description": "The spreadsheet the updates were applied to. ",
1227 "type": "string"
1228 },
1229 "updatedRange": {
1230 "description": "The range (in A1 notation) that updates were applied to.",
1231 "type": "string"
1232 }
1233 },
1234 "type": "object"
1235 },
1236 "ErrorValue": {
1237 "description": "An error in a cell.",
1238 "id": "ErrorValue",
1239 "properties": {
1240 "type": {
1241 "description": "The type of error.",
1242 "enum": [
1243 "ERROR_TYPE_UNSPECIFIED",
1244 "ERROR",
1245 "NULL_VALUE",
1246 "DIVIDE_BY_ZERO",
1247 "VALUE",
1248 "REF",
1249 "NAME",
1250 "NUM",
1251 "N_A",
1252 "LOADING"
1253 ],
1254 "enumDescriptions": [
1255 "The default error type, do not use this.",
1256 "Corresponds to the `#ERROR!` error.",
1257 "Corresponds to the `#NULL!` error.",
1258 "Corresponds to the `#DIV/0` error.",
1259 "Corresponds to the `#VALUE!` error.",
1260 "Corresponds to the `#REF!` error.",
1261 "Corresponds to the `#NAME?` error.",
1262 "Corresponds to the `#NUM`! error.",
1263 "Corresponds to the `#N/A` error.",
1264 "Corresponds to the `Loading...` state."
1265 ],
1266 "type": "string"
1267 },
1268 "message": {
1269 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
1270 "type": "string"
1271 } 744 }
1272 }, 745 },
1273 "type": "object" 746 "type": "object"
1274 }, 747 },
1275 "PivotValue": { 748 "PivotValue": {
1276 "description": "The definition of how a value in a pivot table shoul d be calculated.", 749 "description": "The definition of how a value in a pivot table shoul d be calculated.",
1277 "id": "PivotValue", 750 "id": "PivotValue",
1278 "properties": { 751 "properties": {
1279 "name": {
1280 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.",
1281 "type": "string"
1282 },
1283 "formula": { 752 "formula": {
1284 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.", 753 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.",
1285 "type": "string" 754 "type": "string"
1286 }, 755 },
1287 "summarizeFunction": { 756 "summarizeFunction": {
1288 "description": "A function to summarize the value.\nIf formu la is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffse t is set, then `CUSTOM`\nis not supported.", 757 "description": "A function to summarize the value.\nIf formu la is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffse t is set, then `CUSTOM`\nis not supported.",
1289 "enum": [ 758 "enum": [
1290 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED", 759 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
1291 "SUM", 760 "SUM",
1292 "COUNTA", 761 "COUNTA",
(...skipping 26 matching lines...) Expand all
1319 "Corresponds to the `VAR` function.", 788 "Corresponds to the `VAR` function.",
1320 "Corresponds to the `VARP` function.", 789 "Corresponds to the `VARP` function.",
1321 "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set." 790 "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
1322 ], 791 ],
1323 "type": "string" 792 "type": "string"
1324 }, 793 },
1325 "sourceColumnOffset": { 794 "sourceColumnOffset": {
1326 "description": "The column offset of the source range that t his value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColu mnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.", 795 "description": "The column offset of the source range that t his value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColu mnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
1327 "format": "int32", 796 "format": "int32",
1328 "type": "integer" 797 "type": "integer"
798 },
799 "name": {
800 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.",
801 "type": "string"
802 }
803 },
804 "type": "object"
805 },
806 "ErrorValue": {
807 "description": "An error in a cell.",
808 "id": "ErrorValue",
809 "properties": {
810 "type": {
811 "description": "The type of error.",
812 "enum": [
813 "ERROR_TYPE_UNSPECIFIED",
814 "ERROR",
815 "NULL_VALUE",
816 "DIVIDE_BY_ZERO",
817 "VALUE",
818 "REF",
819 "NAME",
820 "NUM",
821 "N_A",
822 "LOADING"
823 ],
824 "enumDescriptions": [
825 "The default error type, do not use this.",
826 "Corresponds to the `#ERROR!` error.",
827 "Corresponds to the `#NULL!` error.",
828 "Corresponds to the `#DIV/0` error.",
829 "Corresponds to the `#VALUE!` error.",
830 "Corresponds to the `#REF!` error.",
831 "Corresponds to the `#NAME?` error.",
832 "Corresponds to the `#NUM`! error.",
833 "Corresponds to the `#N/A` error.",
834 "Corresponds to the `Loading...` state."
835 ],
836 "type": "string"
837 },
838 "message": {
839 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
840 "type": "string"
1329 } 841 }
1330 }, 842 },
1331 "type": "object" 843 "type": "object"
1332 }, 844 },
1333 "CopySheetToAnotherSpreadsheetRequest": { 845 "CopySheetToAnotherSpreadsheetRequest": {
1334 "description": "The request to copy a sheet across spreadsheets.", 846 "description": "The request to copy a sheet across spreadsheets.",
1335 "id": "CopySheetToAnotherSpreadsheetRequest", 847 "id": "CopySheetToAnotherSpreadsheetRequest",
1336 "properties": { 848 "properties": {
1337 "destinationSpreadsheetId": { 849 "destinationSpreadsheetId": {
1338 "description": "The ID of the spreadsheet to copy the sheet to.", 850 "description": "The ID of the spreadsheet to copy the sheet to.",
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after
1389 "format": "int32", 901 "format": "int32",
1390 "type": "integer" 902 "type": "integer"
1391 } 903 }
1392 }, 904 },
1393 "type": "object" 905 "type": "object"
1394 }, 906 },
1395 "AutoFillRequest": { 907 "AutoFillRequest": {
1396 "description": "Fills in more data based on existing data.", 908 "description": "Fills in more data based on existing data.",
1397 "id": "AutoFillRequest", 909 "id": "AutoFillRequest",
1398 "properties": { 910 "properties": {
911 "useAlternateSeries": {
912 "description": "True if we should generate data with the \"a lternate\" series.\nThis differs based on the type and amount of source data.",
913 "type": "boolean"
914 },
915 "sourceAndDestination": {
916 "$ref": "SourceAndDestination",
917 "description": "The source and destination areas to autofill .\nThis explicitly lists the source of the autofill and where to\nextend that da ta."
918 },
1399 "range": { 919 "range": {
1400 "$ref": "GridRange", 920 "$ref": "GridRange",
1401 "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\n in to the rest of the range." 921 "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\n in to the rest of the range."
1402 },
1403 "useAlternateSeries": {
1404 "description": "True if we should generate data with the \"a lternate\" series.\nThis differs based on the type and amount of source data.",
1405 "type": "boolean"
1406 },
1407 "sourceAndDestination": {
1408 "$ref": "SourceAndDestination",
1409 "description": "The source and destination areas to autofill .\nThis explicitly lists the source of the autofill and where to\nextend that da ta."
1410 } 922 }
1411 }, 923 },
1412 "type": "object" 924 "type": "object"
1413 }, 925 },
1414 "GradientRule": { 926 "GradientRule": {
1415 "description": "A rule that applies a gradient color scale format, b ased on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.", 927 "description": "A rule that applies a gradient color scale format, b ased on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
1416 "id": "GradientRule", 928 "id": "GradientRule",
1417 "properties": { 929 "properties": {
930 "midpoint": {
931 "$ref": "InterpolationPoint",
932 "description": "An optional midway interpolation point."
933 },
1418 "minpoint": { 934 "minpoint": {
1419 "$ref": "InterpolationPoint", 935 "$ref": "InterpolationPoint",
1420 "description": "The starting interpolation point." 936 "description": "The starting interpolation point."
1421 }, 937 },
1422 "maxpoint": { 938 "maxpoint": {
1423 "$ref": "InterpolationPoint", 939 "$ref": "InterpolationPoint",
1424 "description": "The final interpolation point." 940 "description": "The final interpolation point."
1425 },
1426 "midpoint": {
1427 "$ref": "InterpolationPoint",
1428 "description": "An optional midway interpolation point."
1429 } 941 }
1430 }, 942 },
1431 "type": "object" 943 "type": "object"
1432 }, 944 },
1433 "ClearValuesRequest": { 945 "ClearValuesRequest": {
1434 "description": "The request for clearing a range of values in a spre adsheet.", 946 "description": "The request for clearing a range of values in a spre adsheet.",
1435 "id": "ClearValuesRequest", 947 "id": "ClearValuesRequest",
1436 "properties": {}, 948 "properties": {},
1437 "type": "object" 949 "type": "object"
1438 }, 950 },
1439 "SetBasicFilterRequest": { 951 "SetBasicFilterRequest": {
1440 "description": "Sets the basic filter associated with a sheet.", 952 "description": "Sets the basic filter associated with a sheet.",
1441 "id": "SetBasicFilterRequest", 953 "id": "SetBasicFilterRequest",
1442 "properties": { 954 "properties": {
1443 "filter": { 955 "filter": {
1444 "$ref": "BasicFilter", 956 "$ref": "BasicFilter",
1445 "description": "The filter to set." 957 "description": "The filter to set."
1446 } 958 }
1447 }, 959 },
1448 "type": "object" 960 "type": "object"
1449 }, 961 },
1450 "InterpolationPoint": { 962 "InterpolationPoint": {
1451 "description": "A single interpolation point on a gradient condition al format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.", 963 "description": "A single interpolation point on a gradient condition al format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
1452 "id": "InterpolationPoint", 964 "id": "InterpolationPoint",
1453 "properties": { 965 "properties": {
1454 "color": {
1455 "$ref": "Color",
1456 "description": "The color this interpolation point should us e."
1457 },
1458 "type": { 966 "type": {
1459 "description": "How the value should be interpreted.", 967 "description": "How the value should be interpreted.",
1460 "enum": [ 968 "enum": [
1461 "INTERPOLATION_POINT_TYPE_UNSPECIFIED", 969 "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
1462 "MIN", 970 "MIN",
1463 "MAX", 971 "MAX",
1464 "NUMBER", 972 "NUMBER",
1465 "PERCENT", 973 "PERCENT",
1466 "PERCENTILE" 974 "PERCENTILE"
1467 ], 975 ],
1468 "enumDescriptions": [ 976 "enumDescriptions": [
1469 "The default value, do not use.", 977 "The default value, do not use.",
1470 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.", 978 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.",
1471 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.", 979 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.",
1472 "The interpolation point will use exactly the value in\n InterpolationPoint.value.", 980 "The interpolation point will use exactly the value in\n InterpolationPoint.value.",
1473 "The interpolation point will be the given percentage ov er\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLA TTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored whe n flattening).", 981 "The interpolation point will be the given percentage ov er\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLA TTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored whe n flattening).",
1474 "The interpolation point will be the given percentile\no ver all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where er rors in the range are ignored when flattening)." 982 "The interpolation point will be the given percentile\no ver all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where er rors in the range are ignored when flattening)."
1475 ], 983 ],
1476 "type": "string" 984 "type": "string"
1477 }, 985 },
1478 "value": { 986 "value": {
1479 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.", 987 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
1480 "type": "string" 988 "type": "string"
989 },
990 "color": {
991 "$ref": "Color",
992 "description": "The color this interpolation point should us e."
993 }
994 },
995 "type": "object"
996 },
997 "FindReplaceResponse": {
998 "description": "The result of the find/replace.",
999 "id": "FindReplaceResponse",
1000 "properties": {
1001 "sheetsChanged": {
1002 "description": "The number of sheets changed.",
1003 "format": "int32",
1004 "type": "integer"
1005 },
1006 "formulasChanged": {
1007 "description": "The number of formula cells changed.",
1008 "format": "int32",
1009 "type": "integer"
1010 },
1011 "valuesChanged": {
1012 "description": "The number of non-formula cells changed.",
1013 "format": "int32",
1014 "type": "integer"
1015 },
1016 "occurrencesChanged": {
1017 "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"G oogle Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.",
1018 "format": "int32",
1019 "type": "integer"
1020 },
1021 "rowsChanged": {
1022 "description": "The number of rows changed.",
1023 "format": "int32",
1024 "type": "integer"
1481 } 1025 }
1482 }, 1026 },
1483 "type": "object" 1027 "type": "object"
1484 }, 1028 },
1485 "DeleteEmbeddedObjectRequest": { 1029 "DeleteEmbeddedObjectRequest": {
1486 "description": "Deletes the embedded object with the given ID.", 1030 "description": "Deletes the embedded object with the given ID.",
1487 "id": "DeleteEmbeddedObjectRequest", 1031 "id": "DeleteEmbeddedObjectRequest",
1488 "properties": { 1032 "properties": {
1489 "objectId": { 1033 "objectId": {
1490 "description": "The ID of the embedded object to delete.", 1034 "description": "The ID of the embedded object to delete.",
1491 "format": "int32", 1035 "format": "int32",
1492 "type": "integer" 1036 "type": "integer"
1493 } 1037 }
1494 }, 1038 },
1495 "type": "object" 1039 "type": "object"
1496 }, 1040 },
1497 "FindReplaceResponse": { 1041 "DeleteSheetRequest": {
1498 "description": "The result of the find/replace.", 1042 "description": "Deletes the requested sheet.",
1499 "id": "FindReplaceResponse", 1043 "id": "DeleteSheetRequest",
1500 "properties": { 1044 "properties": {
1501 "valuesChanged": { 1045 "sheetId": {
1502 "description": "The number of non-formula cells changed.", 1046 "description": "The ID of the sheet to delete.",
1503 "format": "int32",
1504 "type": "integer"
1505 },
1506 "occurrencesChanged": {
1507 "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"G oogle Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.",
1508 "format": "int32",
1509 "type": "integer"
1510 },
1511 "rowsChanged": {
1512 "description": "The number of rows changed.",
1513 "format": "int32",
1514 "type": "integer"
1515 },
1516 "sheetsChanged": {
1517 "description": "The number of sheets changed.",
1518 "format": "int32",
1519 "type": "integer"
1520 },
1521 "formulasChanged": {
1522 "description": "The number of formula cells changed.",
1523 "format": "int32", 1047 "format": "int32",
1524 "type": "integer" 1048 "type": "integer"
1525 } 1049 }
1526 }, 1050 },
1527 "type": "object" 1051 "type": "object"
1528 }, 1052 },
1529 "DuplicateFilterViewRequest": { 1053 "DuplicateFilterViewRequest": {
1530 "description": "Duplicates a particular filter view.", 1054 "description": "Duplicates a particular filter view.",
1531 "id": "DuplicateFilterViewRequest", 1055 "id": "DuplicateFilterViewRequest",
1532 "properties": { 1056 "properties": {
1533 "filterId": { 1057 "filterId": {
1534 "description": "The ID of the filter being duplicated.", 1058 "description": "The ID of the filter being duplicated.",
1535 "format": "int32", 1059 "format": "int32",
1536 "type": "integer" 1060 "type": "integer"
1537 } 1061 }
1538 }, 1062 },
1539 "type": "object" 1063 "type": "object"
1540 }, 1064 },
1541 "DeleteSheetRequest": {
1542 "description": "Deletes the requested sheet.",
1543 "id": "DeleteSheetRequest",
1544 "properties": {
1545 "sheetId": {
1546 "description": "The ID of the sheet to delete.",
1547 "format": "int32",
1548 "type": "integer"
1549 }
1550 },
1551 "type": "object"
1552 },
1553 "UpdateConditionalFormatRuleResponse": { 1065 "UpdateConditionalFormatRuleResponse": {
1554 "description": "The result of updating a conditional format rule.", 1066 "description": "The result of updating a conditional format rule.",
1555 "id": "UpdateConditionalFormatRuleResponse", 1067 "id": "UpdateConditionalFormatRuleResponse",
1556 "properties": { 1068 "properties": {
1557 "newIndex": { 1069 "newIndex": {
1558 "description": "The index of the new rule.", 1070 "description": "The index of the new rule.",
1559 "format": "int32", 1071 "format": "int32",
1560 "type": "integer" 1072 "type": "integer"
1561 }, 1073 },
1562 "oldIndex": { 1074 "oldIndex": {
1563 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).", 1075 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
1564 "format": "int32", 1076 "format": "int32",
1565 "type": "integer" 1077 "type": "integer"
1566 }, 1078 },
1567 "newRule": { 1079 "newRule": {
1568 "$ref": "ConditionalFormatRule", 1080 "$ref": "ConditionalFormatRule",
1569 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)" 1081 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
1570 }, 1082 },
1571 "oldRule": { 1083 "oldRule": {
1572 "$ref": "ConditionalFormatRule", 1084 "$ref": "ConditionalFormatRule",
1573 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)." 1085 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)."
1574 } 1086 }
1575 }, 1087 },
1576 "type": "object" 1088 "type": "object"
1577 }, 1089 },
1578 "DuplicateSheetRequest": {
1579 "description": "Duplicates the contents of a sheet.",
1580 "id": "DuplicateSheetRequest",
1581 "properties": {
1582 "insertSheetIndex": {
1583 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
1584 "format": "int32",
1585 "type": "integer"
1586 },
1587 "newSheetName": {
1588 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
1589 "type": "string"
1590 },
1591 "sourceSheetId": {
1592 "description": "The sheet to duplicate.",
1593 "format": "int32",
1594 "type": "integer"
1595 },
1596 "newSheetId": {
1597 "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\ nIf set, it must be non-negative.",
1598 "format": "int32",
1599 "type": "integer"
1600 }
1601 },
1602 "type": "object"
1603 },
1604 "ConditionValue": { 1090 "ConditionValue": {
1605 "description": "The value of the condition.", 1091 "description": "The value of the condition.",
1606 "id": "ConditionValue", 1092 "id": "ConditionValue",
1607 "properties": { 1093 "properties": {
1608 "relativeDate": { 1094 "relativeDate": {
1609 "description": "A relative date (based on the current date). \nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDA TE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey ar e supported only in conditional formatting and\nconditional filters.", 1095 "description": "A relative date (based on the current date). \nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDA TE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey ar e supported only in conditional formatting and\nconditional filters.",
1610 "enum": [ 1096 "enum": [
1611 "RELATIVE_DATE_UNSPECIFIED", 1097 "RELATIVE_DATE_UNSPECIFIED",
1612 "PAST_YEAR", 1098 "PAST_YEAR",
1613 "PAST_MONTH", 1099 "PAST_MONTH",
(...skipping 13 matching lines...) Expand all
1627 ], 1113 ],
1628 "type": "string" 1114 "type": "string"
1629 }, 1115 },
1630 "userEnteredValue": { 1116 "userEnteredValue": {
1631 "description": "A value the condition is based on.\nThe valu e will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).", 1117 "description": "A value the condition is based on.\nThe valu e will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
1632 "type": "string" 1118 "type": "string"
1633 } 1119 }
1634 }, 1120 },
1635 "type": "object" 1121 "type": "object"
1636 }, 1122 },
1123 "DuplicateSheetRequest": {
1124 "description": "Duplicates the contents of a sheet.",
1125 "id": "DuplicateSheetRequest",
1126 "properties": {
1127 "newSheetName": {
1128 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
1129 "type": "string"
1130 },
1131 "sourceSheetId": {
1132 "description": "The sheet to duplicate.",
1133 "format": "int32",
1134 "type": "integer"
1135 },
1136 "newSheetId": {
1137 "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\ nIf set, it must be non-negative.",
1138 "format": "int32",
1139 "type": "integer"
1140 },
1141 "insertSheetIndex": {
1142 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
1143 "format": "int32",
1144 "type": "integer"
1145 }
1146 },
1147 "type": "object"
1148 },
1637 "ExtendedValue": { 1149 "ExtendedValue": {
1638 "description": "The kinds of value that a cell in a spreadsheet can have.", 1150 "description": "The kinds of value that a cell in a spreadsheet can have.",
1639 "id": "ExtendedValue", 1151 "id": "ExtendedValue",
1640 "properties": { 1152 "properties": {
1153 "errorValue": {
1154 "$ref": "ErrorValue",
1155 "description": "Represents an error.\nThis field is read-onl y."
1156 },
1157 "stringValue": {
1158 "description": "Represents a string value.\nLeading single q uotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
1159 "type": "string"
1160 },
1161 "boolValue": {
1162 "description": "Represents a boolean value.",
1163 "type": "boolean"
1164 },
1165 "formulaValue": {
1166 "description": "Represents a formula.",
1167 "type": "string"
1168 },
1641 "numberValue": { 1169 "numberValue": {
1642 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.", 1170 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.",
1643 "format": "double", 1171 "format": "double",
1644 "type": "number" 1172 "type": "number"
1645 },
1646 "errorValue": {
1647 "$ref": "ErrorValue",
1648 "description": "Represents an error.\nThis field is read-onl y."
1649 },
1650 "stringValue": {
1651 "description": "Represents a string value.\nLeading single q uotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
1652 "type": "string"
1653 },
1654 "boolValue": {
1655 "description": "Represents a boolean value.",
1656 "type": "boolean"
1657 },
1658 "formulaValue": {
1659 "description": "Represents a formula.",
1660 "type": "string"
1661 } 1173 }
1662 }, 1174 },
1663 "type": "object" 1175 "type": "object"
1664 }, 1176 },
1665 "AddChartRequest": { 1177 "AddChartRequest": {
1666 "description": "Adds a chart to a sheet in the spreadsheet.", 1178 "description": "Adds a chart to a sheet in the spreadsheet.",
1667 "id": "AddChartRequest", 1179 "id": "AddChartRequest",
1668 "properties": { 1180 "properties": {
1669 "chart": { 1181 "chart": {
1670 "$ref": "EmbeddedChart", 1182 "$ref": "EmbeddedChart",
(...skipping 29 matching lines...) Expand all
1700 "type": "array" 1212 "type": "array"
1701 }, 1213 },
1702 "spreadsheetUrl": { 1214 "spreadsheetUrl": {
1703 "description": "The url of the spreadsheet.\nThis field is r ead-only.", 1215 "description": "The url of the spreadsheet.\nThis field is r ead-only.",
1704 "type": "string" 1216 "type": "string"
1705 } 1217 }
1706 }, 1218 },
1707 "type": "object" 1219 "type": "object"
1708 }, 1220 },
1709 "BatchClearValuesResponse": { 1221 "BatchClearValuesResponse": {
1710 "description": "The response when updating a range of values in a sp readsheet.", 1222 "description": "The response when clearing a range of values in a sp readsheet.",
1711 "id": "BatchClearValuesResponse", 1223 "id": "BatchClearValuesResponse",
1712 "properties": { 1224 "properties": {
1713 "spreadsheetId": { 1225 "spreadsheetId": {
1714 "description": "The spreadsheet the updates were applied to. ", 1226 "description": "The spreadsheet the updates were applied to. ",
1715 "type": "string" 1227 "type": "string"
1716 }, 1228 },
1717 "clearedRanges": { 1229 "clearedRanges": {
1718 "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.)", 1230 "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.)",
1719 "items": { 1231 "items": {
1720 "type": "string" 1232 "type": "string"
1721 }, 1233 },
1722 "type": "array" 1234 "type": "array"
1723 } 1235 }
1724 }, 1236 },
1725 "type": "object" 1237 "type": "object"
1726 }, 1238 },
1727 "BandedRange": { 1239 "BandedRange": {
1728 "description": "A banded (alternating colors) range in a sheet.", 1240 "description": "A banded (alternating colors) range in a sheet.",
1729 "id": "BandedRange", 1241 "id": "BandedRange",
1730 "properties": { 1242 "properties": {
1243 "bandedRangeId": {
1244 "description": "The id of the banded range.",
1245 "format": "int32",
1246 "type": "integer"
1247 },
1248 "rowProperties": {
1249 "$ref": "BandingProperties",
1250 "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."
1251 },
1252 "columnProperties": {
1253 "$ref": "BandingProperties",
1254 "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. "
1255 },
1731 "range": { 1256 "range": {
1732 "$ref": "GridRange", 1257 "$ref": "GridRange",
1733 "description": "The range over which these properties are ap plied." 1258 "description": "The range over which these properties are ap plied."
1734 },
1735 "bandedRangeId": {
1736 "description": "The id of the banded range.",
1737 "format": "int32",
1738 "type": "integer"
1739 },
1740 "rowProperties": {
1741 "$ref": "BandingProperties",
1742 "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."
1743 },
1744 "columnProperties": {
1745 "$ref": "BandingProperties",
1746 "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. "
1747 } 1259 }
1748 }, 1260 },
1749 "type": "object" 1261 "type": "object"
1750 }, 1262 },
1751 "UpdateProtectedRangeRequest": { 1263 "UpdateProtectedRangeRequest": {
1752 "description": "Updates an existing protected range with the specifi ed\nprotectedRangeId.", 1264 "description": "Updates an existing protected range with the specifi ed\nprotectedRangeId.",
1753 "id": "UpdateProtectedRangeRequest", 1265 "id": "UpdateProtectedRangeRequest",
1754 "properties": { 1266 "properties": {
1755 "protectedRange": { 1267 "protectedRange": {
1756 "$ref": "ProtectedRange", 1268 "$ref": "ProtectedRange",
1757 "description": "The protected range to update with the new p roperties." 1269 "description": "The protected range to update with the new p roperties."
1758 }, 1270 },
1759 "fields": { 1271 "fields": {
1760 "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should n ot be specified.\nA single `\"*\"` can be used as short-hand for listing every f ield.", 1272 "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should n ot be specified.\nA single `\"*\"` can be used as short-hand for listing every f ield.",
1761 "format": "google-fieldmask", 1273 "format": "google-fieldmask",
1762 "type": "string" 1274 "type": "string"
1763 } 1275 }
1764 }, 1276 },
1765 "type": "object" 1277 "type": "object"
1766 }, 1278 },
1767 "TextFormat": { 1279 "TextFormat": {
1768 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.", 1280 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.",
1769 "id": "TextFormat", 1281 "id": "TextFormat",
1770 "properties": { 1282 "properties": {
1283 "foregroundColor": {
1284 "$ref": "Color",
1285 "description": "The foreground color of the text."
1286 },
1287 "bold": {
1288 "description": "True if the text is bold.",
1289 "type": "boolean"
1290 },
1291 "fontFamily": {
1292 "description": "The font family.",
1293 "type": "string"
1294 },
1295 "strikethrough": {
1296 "description": "True if the text has a strikethrough.",
1297 "type": "boolean"
1298 },
1299 "italic": {
1300 "description": "True if the text is italicized.",
1301 "type": "boolean"
1302 },
1303 "fontSize": {
1304 "description": "The size of the font.",
1305 "format": "int32",
1306 "type": "integer"
1307 },
1771 "underline": { 1308 "underline": {
1772 "description": "True if the text is underlined.", 1309 "description": "True if the text is underlined.",
1773 "type": "boolean" 1310 "type": "boolean"
1774 },
1775 "foregroundColor": {
1776 "$ref": "Color",
1777 "description": "The foreground color of the text."
1778 },
1779 "bold": {
1780 "description": "True if the text is bold.",
1781 "type": "boolean"
1782 },
1783 "fontFamily": {
1784 "description": "The font family.",
1785 "type": "string"
1786 },
1787 "strikethrough": {
1788 "description": "True if the text has a strikethrough.",
1789 "type": "boolean"
1790 },
1791 "italic": {
1792 "description": "True if the text is italicized.",
1793 "type": "boolean"
1794 },
1795 "fontSize": {
1796 "description": "The size of the font.",
1797 "format": "int32",
1798 "type": "integer"
1799 } 1311 }
1800 }, 1312 },
1801 "type": "object" 1313 "type": "object"
1802 }, 1314 },
1803 "AddSheetResponse": { 1315 "AddSheetResponse": {
1804 "description": "The result of adding a sheet.", 1316 "description": "The result of adding a sheet.",
1805 "id": "AddSheetResponse", 1317 "id": "AddSheetResponse",
1806 "properties": { 1318 "properties": {
1807 "properties": { 1319 "properties": {
1808 "$ref": "SheetProperties", 1320 "$ref": "SheetProperties",
(...skipping 23 matching lines...) Expand all
1832 "type": "integer" 1344 "type": "integer"
1833 }, 1345 },
1834 "convergenceThreshold": { 1346 "convergenceThreshold": {
1835 "description": "When iterative calculation is enabled and su ccessive results differ by\nless than this threshold value, the calculation roun ds stop.", 1347 "description": "When iterative calculation is enabled and su ccessive results differ by\nless than this threshold value, the calculation roun ds stop.",
1836 "format": "double", 1348 "format": "double",
1837 "type": "number" 1349 "type": "number"
1838 } 1350 }
1839 }, 1351 },
1840 "type": "object" 1352 "type": "object"
1841 }, 1353 },
1842 "OverlayPosition": {
1843 "description": "The location an object is overlaid on top of a grid. ",
1844 "id": "OverlayPosition",
1845 "properties": {
1846 "offsetXPixels": {
1847 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.",
1848 "format": "int32",
1849 "type": "integer"
1850 },
1851 "anchorCell": {
1852 "$ref": "GridCoordinate",
1853 "description": "The cell the object is anchored to."
1854 },
1855 "offsetYPixels": {
1856 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
1857 "format": "int32",
1858 "type": "integer"
1859 },
1860 "heightPixels": {
1861 "description": "The height of the object, in pixels. Default s to 371.",
1862 "format": "int32",
1863 "type": "integer"
1864 },
1865 "widthPixels": {
1866 "description": "The width of the object, in pixels. Defaults to 600.",
1867 "format": "int32",
1868 "type": "integer"
1869 }
1870 },
1871 "type": "object"
1872 },
1873 "SpreadsheetProperties": { 1354 "SpreadsheetProperties": {
1874 "description": "Properties of a spreadsheet.", 1355 "description": "Properties of a spreadsheet.",
1875 "id": "SpreadsheetProperties", 1356 "id": "SpreadsheetProperties",
1876 "properties": { 1357 "properties": {
1877 "locale": { 1358 "locale": {
1878 "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639- 2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.", 1359 "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639- 2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
1879 "type": "string" 1360 "type": "string"
1880 }, 1361 },
1881 "iterativeCalculationSettings": { 1362 "iterativeCalculationSettings": {
1882 "$ref": "IterativeCalculationSettings", 1363 "$ref": "IterativeCalculationSettings",
(...skipping 23 matching lines...) Expand all
1906 "description": "The title of the spreadsheet.", 1387 "description": "The title of the spreadsheet.",
1907 "type": "string" 1388 "type": "string"
1908 }, 1389 },
1909 "timeZone": { 1390 "timeZone": {
1910 "description": "The time zone of the spreadsheet, in CLDR fo rmat such as\n`America/New_York`. If the time zone isn't recognized, this may\nb e a custom time zone such as `GMT-07:00`.", 1391 "description": "The time zone of the spreadsheet, in CLDR fo rmat such as\n`America/New_York`. If the time zone isn't recognized, this may\nb e a custom time zone such as `GMT-07:00`.",
1911 "type": "string" 1392 "type": "string"
1912 } 1393 }
1913 }, 1394 },
1914 "type": "object" 1395 "type": "object"
1915 }, 1396 },
1397 "OverlayPosition": {
1398 "description": "The location an object is overlaid on top of a grid. ",
1399 "id": "OverlayPosition",
1400 "properties": {
1401 "widthPixels": {
1402 "description": "The width of the object, in pixels. Defaults to 600.",
1403 "format": "int32",
1404 "type": "integer"
1405 },
1406 "offsetXPixels": {
1407 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.",
1408 "format": "int32",
1409 "type": "integer"
1410 },
1411 "anchorCell": {
1412 "$ref": "GridCoordinate",
1413 "description": "The cell the object is anchored to."
1414 },
1415 "offsetYPixels": {
1416 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
1417 "format": "int32",
1418 "type": "integer"
1419 },
1420 "heightPixels": {
1421 "description": "The height of the object, in pixels. Default s to 371.",
1422 "format": "int32",
1423 "type": "integer"
1424 }
1425 },
1426 "type": "object"
1427 },
1916 "RepeatCellRequest": { 1428 "RepeatCellRequest": {
1917 "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; othe rs are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges wil l automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A 2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. \n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, us e the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing. ", 1429 "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; othe rs are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges wil l automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A 2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. \n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, us e the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing. ",
1918 "id": "RepeatCellRequest", 1430 "id": "RepeatCellRequest",
1919 "properties": { 1431 "properties": {
1432 "fields": {
1433 "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be spec ified.\nA single `\"*\"` can be used as short-hand for listing every field.",
1434 "format": "google-fieldmask",
1435 "type": "string"
1436 },
1437 "cell": {
1438 "$ref": "CellData",
1439 "description": "The data to write."
1440 },
1920 "range": { 1441 "range": {
1921 "$ref": "GridRange", 1442 "$ref": "GridRange",
1922 "description": "The range to repeat the cell in." 1443 "description": "The range to repeat the cell in."
1923 },
1924 "fields": {
1925 "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be spec ified.\nA single `\"*\"` can be used as short-hand for listing every field.",
1926 "format": "google-fieldmask",
1927 "type": "string"
1928 },
1929 "cell": {
1930 "$ref": "CellData",
1931 "description": "The data to write."
1932 } 1444 }
1933 }, 1445 },
1934 "type": "object" 1446 "type": "object"
1935 }, 1447 },
1936 "AddChartResponse": { 1448 "AddChartResponse": {
1937 "description": "The result of adding a chart to a spreadsheet.", 1449 "description": "The result of adding a chart to a spreadsheet.",
1938 "id": "AddChartResponse", 1450 "id": "AddChartResponse",
1939 "properties": { 1451 "properties": {
1940 "chart": { 1452 "chart": {
1941 "$ref": "EmbeddedChart", 1453 "$ref": "EmbeddedChart",
1942 "description": "The newly added chart." 1454 "description": "The newly added chart."
1943 } 1455 }
1944 }, 1456 },
1945 "type": "object" 1457 "type": "object"
1946 }, 1458 },
1947 "InsertDimensionRequest": { 1459 "InsertDimensionRequest": {
1948 "description": "Inserts rows or columns in a sheet at a particular i ndex.", 1460 "description": "Inserts rows or columns in a sheet at a particular i ndex.",
1949 "id": "InsertDimensionRequest", 1461 "id": "InsertDimensionRequest",
1950 "properties": { 1462 "properties": {
1463 "range": {
1464 "$ref": "DimensionRange",
1465 "description": "The dimensions to insert. Both the start an d end indexes must be bounded."
1466 },
1951 "inheritFromBefore": { 1467 "inheritFromBefore": {
1952 "description": "Whether dimension properties should be exten ded from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be grea ter than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then in serting 2 rows at index 1 can inherit\neither the green or red background. If ` inheritFromBefore` is true,\nthe two new rows will be red (because the row befor e the insertion point\nwas red), whereas if `inheritFromBefore` is false, the tw o new rows will\nbe green (because the row after the insertion point was green). ", 1468 "description": "Whether dimension properties should be exten ded from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be grea ter than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then in serting 2 rows at index 1 can inherit\neither the green or red background. If ` inheritFromBefore` is true,\nthe two new rows will be red (because the row befor e the insertion point\nwas red), whereas if `inheritFromBefore` is false, the tw o new rows will\nbe green (because the row after the insertion point was green). ",
1953 "type": "boolean" 1469 "type": "boolean"
1954 },
1955 "range": {
1956 "$ref": "DimensionRange",
1957 "description": "The dimensions to insert. Both the start an d end indexes must be bounded."
1958 } 1470 }
1959 }, 1471 },
1960 "type": "object" 1472 "type": "object"
1961 }, 1473 },
1962 "UpdateSpreadsheetPropertiesRequest": { 1474 "UpdateSpreadsheetPropertiesRequest": {
1963 "description": "Updates properties of a spreadsheet.", 1475 "description": "Updates properties of a spreadsheet.",
1964 "id": "UpdateSpreadsheetPropertiesRequest", 1476 "id": "UpdateSpreadsheetPropertiesRequest",
1965 "properties": { 1477 "properties": {
1966 "properties": { 1478 "properties": {
1967 "$ref": "SpreadsheetProperties", 1479 "$ref": "SpreadsheetProperties",
1968 "description": "The properties to update." 1480 "description": "The properties to update."
1969 }, 1481 },
1970 "fields": { 1482 "fields": {
1971 "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 .", 1483 "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 .",
1972 "format": "google-fieldmask", 1484 "format": "google-fieldmask",
1973 "type": "string" 1485 "type": "string"
1974 } 1486 }
1975 }, 1487 },
1976 "type": "object" 1488 "type": "object"
1977 }, 1489 },
1490 "BatchUpdateValuesRequest": {
1491 "description": "The request for updating more than one range of valu es in a spreadsheet.",
1492 "id": "BatchUpdateValuesRequest",
1493 "properties": {
1494 "responseValueRenderOption": {
1495 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
1496 "enum": [
1497 "FORMATTED_VALUE",
1498 "UNFORMATTED_VALUE",
1499 "FORMULA"
1500 ],
1501 "enumDescriptions": [
1502 "Values will be calculated & formatted in the reply acco rding to the\ncell's formatting. Formatting is based on the spreadsheet's local e,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` i s `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
1503 "Values will be calculated, but not formatted in the rep ly.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, \nthen `A2` would return the number `1.23`.",
1504 "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
1505 ],
1506 "type": "string"
1507 },
1508 "includeValuesInResponse": {
1509 "description": "Determines if the update response should inc lude the values\nof the cells that were updated. By default, responses\ndo not i nclude the updated values. The `updatedData` field within\neach of the BatchUpda teValuesResponse.responses will contain\nthe updated values. If the range to wri te was larger than than the range\nactually written, the response will include a ll values in the requested\nrange (excluding trailing empty rows and columns).",
1510 "type": "boolean"
1511 },
1512 "valueInputOption": {
1513 "description": "How the input data should be interpreted.",
1514 "enum": [
1515 "INPUT_VALUE_OPTION_UNSPECIFIED",
1516 "RAW",
1517 "USER_ENTERED"
1518 ],
1519 "enumDescriptions": [
1520 "Default input value. This value must not be used.",
1521 "The values the user has entered will not be parsed and will be stored\nas-is.",
1522 "The values will be parsed as if the user typed them int o the UI.\nNumbers will stay as numbers, but strings may be converted to numbers ,\ndates, etc. following the same rules that are applied when entering\ntext int o a cell via the Google Sheets UI."
1523 ],
1524 "type": "string"
1525 },
1526 "data": {
1527 "description": "The new values to apply to the spreadsheet." ,
1528 "items": {
1529 "$ref": "ValueRange"
1530 },
1531 "type": "array"
1532 },
1533 "responseDateTimeRenderOption": {
1534 "description": "Determines how dates, times, and durations i n the response should be\nrendered. This is ignored if response_value_render_opt ion is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderO ption.SERIAL_NUMBER].",
1535 "enum": [
1536 "SERIAL_NUMBER",
1537 "FORMATTED_STRING"
1538 ],
1539 "enumDescriptions": [
1540 "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3 .\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats th e year 1900 as\nnot a leap year.",
1541 "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the s preadsheet locale)."
1542 ],
1543 "type": "string"
1544 }
1545 },
1546 "type": "object"
1547 },
1978 "ProtectedRange": { 1548 "ProtectedRange": {
1979 "description": "A protected range.", 1549 "description": "A protected range.",
1980 "id": "ProtectedRange", 1550 "id": "ProtectedRange",
1981 "properties": { 1551 "properties": {
1982 "requestingUserCanEdit": {
1983 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
1984 "type": "boolean"
1985 },
1986 "range": {
1987 "$ref": "GridRange",
1988 "description": "The range that is being protected.\nThe rang e may be fully unbounded, in which case this is considered\na protected sheet.\n \nWhen writing, only one of range or named_range_id\nmay be set."
1989 },
1990 "editors": {
1991 "$ref": "Editors",
1992 "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the p rotected\nrange and the document.\nEditors are not supported with warning_only p rotection."
1993 },
1994 "description": { 1552 "description": {
1995 "description": "The description of this protected range.", 1553 "description": "The description of this protected range.",
1996 "type": "string" 1554 "type": "string"
1997 }, 1555 },
1998 "unprotectedRanges": { 1556 "unprotectedRanges": {
1999 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.", 1557 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.",
2000 "items": { 1558 "items": {
2001 "$ref": "GridRange" 1559 "$ref": "GridRange"
2002 }, 1560 },
2003 "type": "array" 1561 "type": "array"
2004 }, 1562 },
2005 "namedRangeId": { 1563 "namedRangeId": {
2006 "description": "The named range this protected range is back ed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set. ", 1564 "description": "The named range this protected range is back ed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set. ",
2007 "type": "string" 1565 "type": "string"
2008 }, 1566 },
2009 "protectedRangeId": { 1567 "protectedRangeId": {
2010 "description": "The ID of the protected range.\nThis field i s read-only.", 1568 "description": "The ID of the protected range.\nThis field i s read-only.",
2011 "format": "int32", 1569 "format": "int32",
2012 "type": "integer" 1570 "type": "integer"
2013 }, 1571 },
2014 "warningOnly": { 1572 "warningOnly": {
2015 "description": "True if this protected range will show a war ning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\n to confirm the edit.\n\nWhen writing: if this field is true, then editors is ign ored.\nAdditionally, if this field is changed from true to false and the\n`edito rs` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.", 1573 "description": "True if this protected range will show a war ning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\n to confirm the edit.\n\nWhen writing: if this field is true, then editors is ign ored.\nAdditionally, if this field is changed from true to false and the\n`edito rs` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
2016 "type": "boolean" 1574 "type": "boolean"
2017 } 1575 },
2018 }, 1576 "requestingUserCanEdit": {
2019 "type": "object" 1577 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
2020 },
2021 "BatchUpdateValuesRequest": {
2022 "description": "The request for updating more than one range of valu es in a spreadsheet.",
2023 "id": "BatchUpdateValuesRequest",
2024 "properties": {
2025 "responseValueRenderOption": {
2026 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
2027 "enum": [
2028 "FORMATTED_VALUE",
2029 "UNFORMATTED_VALUE",
2030 "FORMULA"
2031 ],
2032 "enumDescriptions": [
2033 "Values will be calculated & formatted in the reply acco rding to the\ncell's formatting. Formatting is based on the spreadsheet's local e,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` i s `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
2034 "Values will be calculated, but not formatted in the rep ly.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, \nthen `A2` would return the number `1.23`.",
2035 "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
2036 ],
2037 "type": "string"
2038 },
2039 "includeValuesInResponse": {
2040 "description": "Determines if the update response should inc lude the values\nof the cells that were updated. By default, responses\ndo not i nclude the updated values. The `updatedData` field within\neach of the BatchUpda teValuesResponse.responses will contain\nthe updated values. If the range to wri te was larger than than the range\nactually written, the response will include a ll values in the requested\nrange (excluding trailing empty rows and columns).",
2041 "type": "boolean" 1578 "type": "boolean"
2042 }, 1579 },
2043 "valueInputOption": { 1580 "range": {
2044 "description": "How the input data should be interpreted.", 1581 "$ref": "GridRange",
2045 "enum": [ 1582 "description": "The range that is being protected.\nThe rang e may be fully unbounded, in which case this is considered\na protected sheet.\n \nWhen writing, only one of range or named_range_id\nmay be set."
2046 "INPUT_VALUE_OPTION_UNSPECIFIED", 1583 },
2047 "RAW", 1584 "editors": {
2048 "USER_ENTERED" 1585 "$ref": "Editors",
2049 ], 1586 "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the p rotected\nrange and the document.\nEditors are not supported with warning_only p rotection."
2050 "enumDescriptions": [ 1587 }
2051 "Default input value. This value must not be used.", 1588 },
2052 "The values the user has entered will not be parsed and will be stored\nas-is.", 1589 "type": "object"
2053 "The values will be parsed as if the user typed them int o the UI.\nNumbers will stay as numbers, but strings may be converted to numbers ,\ndates, etc. following the same rules that are applied when entering\ntext int o a cell via the Google Sheets UI." 1590 },
2054 ], 1591 "DimensionProperties": {
2055 "type": "string" 1592 "description": "Properties about a dimension.",
2056 }, 1593 "id": "DimensionProperties",
2057 "data": { 1594 "properties": {
2058 "description": "The new values to apply to the spreadsheet." , 1595 "pixelSize": {
1596 "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
1597 "format": "int32",
1598 "type": "integer"
1599 },
1600 "hiddenByFilter": {
1601 "description": "True if this dimension is being filtered.\nT his field is read-only.",
1602 "type": "boolean"
1603 },
1604 "hiddenByUser": {
1605 "description": "True if this dimension is explicitly hidden. ",
1606 "type": "boolean"
1607 }
1608 },
1609 "type": "object"
1610 },
1611 "DimensionRange": {
1612 "description": "A range along a single dimension on a sheet.\nAll in dexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
1613 "id": "DimensionRange",
1614 "properties": {
1615 "dimension": {
1616 "description": "The dimension of the span.",
1617 "enum": [
1618 "DIMENSION_UNSPECIFIED",
1619 "ROWS",
1620 "COLUMNS"
1621 ],
1622 "enumDescriptions": [
1623 "The default value, do not use.",
1624 "Operates on the rows of a sheet.",
1625 "Operates on the columns of a sheet."
1626 ],
1627 "type": "string"
1628 },
1629 "startIndex": {
1630 "description": "The start (inclusive) of the span, or not se t if unbounded.",
1631 "format": "int32",
1632 "type": "integer"
1633 },
1634 "endIndex": {
1635 "description": "The end (exclusive) of the span, or not set if unbounded.",
1636 "format": "int32",
1637 "type": "integer"
1638 },
1639 "sheetId": {
1640 "description": "The sheet this span is on.",
1641 "format": "int32",
1642 "type": "integer"
1643 }
1644 },
1645 "type": "object"
1646 },
1647 "NamedRange": {
1648 "description": "A named range.",
1649 "id": "NamedRange",
1650 "properties": {
1651 "name": {
1652 "description": "The name of the named range.",
1653 "type": "string"
1654 },
1655 "namedRangeId": {
1656 "description": "The ID of the named range.",
1657 "type": "string"
1658 },
1659 "range": {
1660 "$ref": "GridRange",
1661 "description": "The range this represents."
1662 }
1663 },
1664 "type": "object"
1665 },
1666 "CutPasteRequest": {
1667 "description": "Moves data from the source to the destination.",
1668 "id": "CutPasteRequest",
1669 "properties": {
1670 "destination": {
1671 "$ref": "GridCoordinate",
1672 "description": "The top-left coordinate where the data shoul d be pasted."
1673 },
1674 "source": {
1675 "$ref": "GridRange",
1676 "description": "The source data to cut."
1677 },
1678 "pasteType": {
1679 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
1680 "enum": [
1681 "PASTE_NORMAL",
1682 "PASTE_VALUES",
1683 "PASTE_FORMAT",
1684 "PASTE_NO_BORDERS",
1685 "PASTE_FORMULA",
1686 "PASTE_DATA_VALIDATION",
1687 "PASTE_CONDITIONAL_FORMATTING"
1688 ],
1689 "enumDescriptions": [
1690 "Paste values, formulas, formats, and merges.",
1691 "Paste the values ONLY without formats, formulas, or mer ges.",
1692 "Paste the format and data validation only.",
1693 "Like PASTE_NORMAL but without borders.",
1694 "Paste the formulas only.",
1695 "Paste the data validation only.",
1696 "Paste the conditional formatting rules only."
1697 ],
1698 "type": "string"
1699 }
1700 },
1701 "type": "object"
1702 },
1703 "BasicChartSeries": {
1704 "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
1705 "id": "BasicChartSeries",
1706 "properties": {
1707 "series": {
1708 "$ref": "ChartData",
1709 "description": "The data being visualized in this chart seri es."
1710 },
1711 "type": {
1712 "description": "The type of this series. Valid only if the\n chartType is\nCOMBO.\nDifferent types will change the way the series is visualiz ed.\nOnly LINE, AREA,\nand COLUMN are supported.",
1713 "enum": [
1714 "BASIC_CHART_TYPE_UNSPECIFIED",
1715 "BAR",
1716 "LINE",
1717 "AREA",
1718 "COLUMN",
1719 "SCATTER",
1720 "COMBO"
1721 ],
1722 "enumDescriptions": [
1723 "Default value, do not use.",
1724 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
1725 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
1726 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
1727 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
1728 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
1729 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
1730 ],
1731 "type": "string"
1732 },
1733 "targetAxis": {
1734 "description": "The minor axis that will specify the range o f values for this series.\nFor example, if charting stocks over time, the \"Volu me\" series\nmay want to be pinned to the right with the prices pinned to the le ft,\nbecause the scale of trading volume is different than the scale of\nprices. \nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart 's type.",
1735 "enum": [
1736 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
1737 "BOTTOM_AXIS",
1738 "LEFT_AXIS",
1739 "RIGHT_AXIS"
1740 ],
1741 "enumDescriptions": [
1742 "Default value, do not use.",
1743 "The axis rendered at the bottom of a chart.\nFor most c harts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
1744 "The axis rendered at the left of a chart.\nFor most cha rts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
1745 "The axis rendered at the right of a chart.\nFor most ch arts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
1746 ],
1747 "type": "string"
1748 }
1749 },
1750 "type": "object"
1751 },
1752 "Borders": {
1753 "description": "The borders of the cell.",
1754 "id": "Borders",
1755 "properties": {
1756 "right": {
1757 "$ref": "Border",
1758 "description": "The right border of the cell."
1759 },
1760 "bottom": {
1761 "$ref": "Border",
1762 "description": "The bottom border of the cell."
1763 },
1764 "top": {
1765 "$ref": "Border",
1766 "description": "The top border of the cell."
1767 },
1768 "left": {
1769 "$ref": "Border",
1770 "description": "The left border of the cell."
1771 }
1772 },
1773 "type": "object"
1774 },
1775 "AutoResizeDimensionsRequest": {
1776 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
1777 "id": "AutoResizeDimensionsRequest",
1778 "properties": {
1779 "dimensions": {
1780 "$ref": "DimensionRange",
1781 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
1782 }
1783 },
1784 "type": "object"
1785 },
1786 "UpdateBordersRequest": {
1787 "description": "Updates the borders of a range.\nIf a field is not s et in the request, that means the border remains as-is.\nFor example, with two s ubsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE } `\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a bord ers of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a borde r, explicitly set the style to\nNONE.",
1788 "id": "UpdateBordersRequest",
1789 "properties": {
1790 "bottom": {
1791 "$ref": "Border",
1792 "description": "The border to put at the bottom of the range ."
1793 },
1794 "innerVertical": {
1795 "$ref": "Border",
1796 "description": "The vertical border to put within the range. "
1797 },
1798 "right": {
1799 "$ref": "Border",
1800 "description": "The border to put at the right of the range. "
1801 },
1802 "range": {
1803 "$ref": "GridRange",
1804 "description": "The range whose borders should be updated."
1805 },
1806 "innerHorizontal": {
1807 "$ref": "Border",
1808 "description": "The horizontal border to put within the rang e."
1809 },
1810 "top": {
1811 "$ref": "Border",
1812 "description": "The border to put at the top of the range."
1813 },
1814 "left": {
1815 "$ref": "Border",
1816 "description": "The border to put at the left of the range."
1817 }
1818 },
1819 "type": "object"
1820 },
1821 "CellFormat": {
1822 "description": "The format of a cell.",
1823 "id": "CellFormat",
1824 "properties": {
1825 "numberFormat": {
1826 "$ref": "NumberFormat",
1827 "description": "A format describing how number values should be represented to the user."
1828 },
1829 "hyperlinkDisplayType": {
1830 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
1831 "enum": [
1832 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
1833 "LINKED",
1834 "PLAIN_TEXT"
1835 ],
1836 "enumDescriptions": [
1837 "The default value: the hyperlink is rendered. Do not us e this.",
1838 "A hyperlink should be explicitly rendered.",
1839 "A hyperlink should not be rendered."
1840 ],
1841 "type": "string"
1842 },
1843 "horizontalAlignment": {
1844 "description": "The horizontal alignment of the value in the cell.",
1845 "enum": [
1846 "HORIZONTAL_ALIGN_UNSPECIFIED",
1847 "LEFT",
1848 "CENTER",
1849 "RIGHT"
1850 ],
1851 "enumDescriptions": [
1852 "The horizontal alignment is not specified. Do not use t his.",
1853 "The text is explicitly aligned to the left of the cell. ",
1854 "The text is explicitly aligned to the center of the cel l.",
1855 "The text is explicitly aligned to the right of the cell ."
1856 ],
1857 "type": "string"
1858 },
1859 "textFormat": {
1860 "$ref": "TextFormat",
1861 "description": "The format of the text in the cell (unless o verridden by a format run)."
1862 },
1863 "backgroundColor": {
1864 "$ref": "Color",
1865 "description": "The background color of the cell."
1866 },
1867 "verticalAlignment": {
1868 "description": "The vertical alignment of the value in the c ell.",
1869 "enum": [
1870 "VERTICAL_ALIGN_UNSPECIFIED",
1871 "TOP",
1872 "MIDDLE",
1873 "BOTTOM"
1874 ],
1875 "enumDescriptions": [
1876 "The vertical alignment is not specified. Do not use th is.",
1877 "The text is explicitly aligned to the top of the cell." ,
1878 "The text is explicitly aligned to the middle of the cel l.",
1879 "The text is explicitly aligned to the bottom of the cel l."
1880 ],
1881 "type": "string"
1882 },
1883 "padding": {
1884 "$ref": "Padding",
1885 "description": "The padding of the cell."
1886 },
1887 "textDirection": {
1888 "description": "The direction of the text in the cell.",
1889 "enum": [
1890 "TEXT_DIRECTION_UNSPECIFIED",
1891 "LEFT_TO_RIGHT",
1892 "RIGHT_TO_LEFT"
1893 ],
1894 "enumDescriptions": [
1895 "The text direction is not specified. Do not use this.",
1896 "The text direction of left-to-right was set by the user .",
1897 "The text direction of right-to-left was set by the user ."
1898 ],
1899 "type": "string"
1900 },
1901 "borders": {
1902 "$ref": "Borders",
1903 "description": "The borders of the cell."
1904 },
1905 "textRotation": {
1906 "$ref": "TextRotation",
1907 "description": "The rotation applied to text in a cell"
1908 },
1909 "wrapStrategy": {
1910 "description": "The wrap strategy for the value in the cell. ",
1911 "enum": [
1912 "WRAP_STRATEGY_UNSPECIFIED",
1913 "OVERFLOW_CELL",
1914 "LEGACY_WRAP",
1915 "CLIP",
1916 "WRAP"
1917 ],
1918 "enumDescriptions": [
1919 "The default value, do not use.",
1920 "Lines that are longer than the cell width will be writt en in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the n ext line unless the user manually inserts a new line.\nExample:\n\n | First s entence. |\n | Manual newline that is very long. <- Text continues into next cell\n | Next newline. |",
1921 "This wrap strategy represents the old Google Sheets wra p strategy where\nwords that are longer than a line are clipped rather than brok en. This\nstrategy is not supported on all platforms and is being phased out.\nE xample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | wor d. |",
1922 "Lines that are longer than the cell width will be clipp ed.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| <- Te xt is clipped\n | Next newline. |",
1923 "Words that are longer than a line are wrapped at the ch aracter level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooo oooooo| <- Word is broken.\n | ong word. |"
1924 ],
1925 "type": "string"
1926 }
1927 },
1928 "type": "object"
1929 },
1930 "ClearValuesResponse": {
1931 "description": "The response when clearing a range of values in a sp readsheet.",
1932 "id": "ClearValuesResponse",
1933 "properties": {
1934 "clearedRange": {
1935 "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.)",
1936 "type": "string"
1937 },
1938 "spreadsheetId": {
1939 "description": "The spreadsheet the updates were applied to. ",
1940 "type": "string"
1941 }
1942 },
1943 "type": "object"
1944 },
1945 "DeleteConditionalFormatRuleRequest": {
1946 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
1947 "id": "DeleteConditionalFormatRuleRequest",
1948 "properties": {
1949 "sheetId": {
1950 "description": "The sheet the rule is being deleted from.",
1951 "format": "int32",
1952 "type": "integer"
1953 },
1954 "index": {
1955 "description": "The zero-based index of the rule to be delet ed.",
1956 "format": "int32",
1957 "type": "integer"
1958 }
1959 },
1960 "type": "object"
1961 },
1962 "AddBandingResponse": {
1963 "description": "The result of adding a banded range.",
1964 "id": "AddBandingResponse",
1965 "properties": {
1966 "bandedRange": {
1967 "$ref": "BandedRange",
1968 "description": "The banded range that was added."
1969 }
1970 },
1971 "type": "object"
1972 },
1973 "DeleteNamedRangeRequest": {
1974 "description": "Removes the named range with the given ID from the s preadsheet.",
1975 "id": "DeleteNamedRangeRequest",
1976 "properties": {
1977 "namedRangeId": {
1978 "description": "The ID of the named range to delete.",
1979 "type": "string"
1980 }
1981 },
1982 "type": "object"
1983 },
1984 "ChartData": {
1985 "description": "The data included in a domain or series.",
1986 "id": "ChartData",
1987 "properties": {
1988 "sourceRange": {
1989 "$ref": "ChartSourceRange",
1990 "description": "The source ranges of the data."
1991 }
1992 },
1993 "type": "object"
1994 },
1995 "BatchGetValuesResponse": {
1996 "description": "The response when retrieving more than one range of values in a spreadsheet.",
1997 "id": "BatchGetValuesResponse",
1998 "properties": {
1999 "valueRanges": {
2000 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
2059 "items": { 2001 "items": {
2060 "$ref": "ValueRange" 2002 "$ref": "ValueRange"
2061 }, 2003 },
2062 "type": "array" 2004 "type": "array"
2063 }, 2005 },
2064 "responseDateTimeRenderOption": { 2006 "spreadsheetId": {
2065 "description": "Determines how dates, times, and durations i n the response should be\nrendered. This is ignored if response_value_render_opt ion is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderO ption.SERIAL_NUMBER].", 2007 "description": "The ID of the spreadsheet the data was retri eved from.",
2066 "enum": [ 2008 "type": "string"
2067 "SERIAL_NUMBER", 2009 }
2068 "FORMATTED_STRING" 2010 },
2069 ], 2011 "type": "object"
2070 "enumDescriptions": [ 2012 },
2071 "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3 .\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats th e year 1900 as\nnot a leap year.", 2013 "UpdateBandingRequest": {
2072 "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the s preadsheet locale)." 2014 "description": "Updates properties of the supplied banded range.",
2073 ], 2015 "id": "UpdateBandingRequest",
2074 "type": "string" 2016 "properties": {
2075 } 2017 "bandedRange": {
2076 }, 2018 "$ref": "BandedRange",
2077 "type": "object" 2019 "description": "The banded range to update with the new prop erties."
2078 }, 2020 },
2079 "DimensionProperties": { 2021 "fields": {
2080 "description": "Properties about a dimension.", 2022 "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.",
2081 "id": "DimensionProperties", 2023 "format": "google-fieldmask",
2082 "properties": { 2024 "type": "string"
2083 "pixelSize": { 2025 }
2084 "description": "The height (if a row) or width (if a column) of the dimension in pixels.", 2026 },
2085 "format": "int32", 2027 "type": "object"
2086 "type": "integer" 2028 },
2087 }, 2029 "Color": {
2088 "hiddenByFilter": { 2030 "description": "Represents a color in the RGBA color space. This rep resentation is designed\nfor simplicity of conversion to/from color representati ons in various\nlanguages over compactness; for example, the fields of this repr esentation\ncan be trivially provided to the constructor of \"java.awt.Color\" i n Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:bl ue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily format ted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples :\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getG reen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGr een(green / denominator)\n .setBlue(blue / denominator);\n i nt alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlp ha(\n FloatValue\n .newBuilder()\n . setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj- C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protoco lor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor color WithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* to Proto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [resu lt setRed:red];\n [result setGreen:green];\n [result setBlue:blu e];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWi thValue(alpha)];\n }\n [result autorelease];\n return re sult;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var prot oToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\ n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color .blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = M ath.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbPara ms, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function( red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0 ; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n re sultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
2089 "description": "True if this dimension is being filtered.\nT his field is read-only.", 2031 "id": "Color",
2032 "properties": {
2033 "red": {
2034 "description": "The amount of red in the color as a value in the interval [0, 1].",
2035 "format": "float",
2036 "type": "number"
2037 },
2038 "green": {
2039 "description": "The amount of green in the color as a value in the interval [0, 1].",
2040 "format": "float",
2041 "type": "number"
2042 },
2043 "blue": {
2044 "description": "The amount of blue in the color as a value i n the interval [0, 1].",
2045 "format": "float",
2046 "type": "number"
2047 },
2048 "alpha": {
2049 "description": "The fraction of this color that should be ap plied to the pixel. That is,\nthe final pixel color is defined by the equation:\ n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\n This means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish betwee n a default value and the value being unset.\nIf omitted, this color object is t o be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
2050 "format": "float",
2051 "type": "number"
2052 }
2053 },
2054 "type": "object"
2055 },
2056 "PivotGroup": {
2057 "description": "A single grouping (either row or column) in a pivot table.",
2058 "id": "PivotGroup",
2059 "properties": {
2060 "sortOrder": {
2061 "description": "The order the values in this group should be sorted.",
2062 "enum": [
2063 "SORT_ORDER_UNSPECIFIED",
2064 "ASCENDING",
2065 "DESCENDING"
2066 ],
2067 "enumDescriptions": [
2068 "Default value, do not use this.",
2069 "Sort ascending.",
2070 "Sort descending."
2071 ],
2072 "type": "string"
2073 },
2074 "valueBucket": {
2075 "$ref": "PivotGroupSortValueBucket",
2076 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
2077 },
2078 "sourceColumnOffset": {
2079 "description": "The column offset of the source range that t his grouping is based on.\n\nFor example, if the source was `C10:E15`, a `source ColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
2080 "format": "int32",
2081 "type": "integer"
2082 },
2083 "showTotals": {
2084 "description": "True if the pivot table should include the t otals for this grouping.",
2090 "type": "boolean" 2085 "type": "boolean"
2091 }, 2086 },
2092 "hiddenByUser": { 2087 "valueMetadata": {
2093 "description": "True if this dimension is explicitly hidden. ", 2088 "description": "Metadata about values in the grouping.",
2094 "type": "boolean" 2089 "items": {
2095 } 2090 "$ref": "PivotGroupValueMetadata"
2096 }, 2091 },
2097 "type": "object" 2092 "type": "array"
2098 }, 2093 }
2099 "DimensionRange": { 2094 },
2100 "description": "A range along a single dimension on a sheet.\nAll in dexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.", 2095 "type": "object"
2101 "id": "DimensionRange", 2096 },
2102 "properties": { 2097 "PivotTable": {
2103 "sheetId": { 2098 "description": "A pivot table.",
2104 "description": "The sheet this span is on.", 2099 "id": "PivotTable",
2105 "format": "int32", 2100 "properties": {
2106 "type": "integer" 2101 "criteria": {
2107 }, 2102 "additionalProperties": {
2108 "dimension": { 2103 "$ref": "PivotFilterCriteria"
2109 "description": "The dimension of the span.", 2104 },
2105 "description": "An optional mapping of filters per source co lumn offset.\n\nThe filters will be applied before aggregating data into the piv ot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if th e source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, where as the key `1` is for column `D`.",
2106 "type": "object"
2107 },
2108 "rows": {
2109 "description": "Each row grouping in the pivot table.",
2110 "items": {
2111 "$ref": "PivotGroup"
2112 },
2113 "type": "array"
2114 },
2115 "valueLayout": {
2116 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
2117 "enum": [
2118 "HORIZONTAL",
2119 "VERTICAL"
2120 ],
2121 "enumDescriptions": [
2122 "Values are laid out horizontally (as columns).",
2123 "Values are laid out vertically (as rows)."
2124 ],
2125 "type": "string"
2126 },
2127 "source": {
2128 "$ref": "GridRange",
2129 "description": "The range the pivot table is reading data fr om."
2130 },
2131 "columns": {
2132 "description": "Each column grouping in the pivot table.",
2133 "items": {
2134 "$ref": "PivotGroup"
2135 },
2136 "type": "array"
2137 },
2138 "values": {
2139 "description": "A list of values to include in the pivot tab le.",
2140 "items": {
2141 "$ref": "PivotValue"
2142 },
2143 "type": "array"
2144 }
2145 },
2146 "type": "object"
2147 },
2148 "ChartSourceRange": {
2149 "description": "Source ranges for a chart.",
2150 "id": "ChartSourceRange",
2151 "properties": {
2152 "sources": {
2153 "description": "The ranges of data for a series or domain.\n Exactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source rang e, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sourc es: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sourc es: C1:C5, E10:E12",
2154 "items": {
2155 "$ref": "GridRange"
2156 },
2157 "type": "array"
2158 }
2159 },
2160 "type": "object"
2161 },
2162 "ValueRange": {
2163 "description": "Data within a range of the spreadsheet.",
2164 "id": "ValueRange",
2165 "properties": {
2166 "majorDimension": {
2167 "description": "The major dimension of the values.\n\nFor ou tput, 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 `r ange=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, w ith `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2, A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaul ts to ROWS.",
2110 "enum": [ 2168 "enum": [
2111 "DIMENSION_UNSPECIFIED", 2169 "DIMENSION_UNSPECIFIED",
2112 "ROWS", 2170 "ROWS",
2113 "COLUMNS" 2171 "COLUMNS"
2114 ], 2172 ],
2115 "enumDescriptions": [ 2173 "enumDescriptions": [
2116 "The default value, do not use.", 2174 "The default value, do not use.",
2117 "Operates on the rows of a sheet.", 2175 "Operates on the rows of a sheet.",
2118 "Operates on the columns of a sheet." 2176 "Operates on the columns of a sheet."
2119 ], 2177 ],
2120 "type": "string" 2178 "type": "string"
2121 }, 2179 },
2122 "startIndex": { 2180 "values": {
2123 "description": "The start (inclusive) of the span, or not se t if unbounded.", 2181 "description": "The data that was read or to be written. Th is is an array of arrays,\nthe outer array representing all the data and each in ner array\nrepresenting a major dimension. Each item in the inner array\ncorresp onds with one cell.\n\nFor output, empty trailing rows and columns will not be i ncluded.\n\nFor input, supported value types are: bool, string, and double.\nNul l values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
2124 "format": "int32", 2182 "items": {
2125 "type": "integer" 2183 "items": {
2126 }, 2184 "type": "any"
2127 "endIndex": { 2185 },
2128 "description": "The end (exclusive) of the span, or not set if unbounded.", 2186 "type": "array"
2129 "format": "int32", 2187 },
2130 "type": "integer" 2188 "type": "array"
2131 } 2189 },
2132 }, 2190 "range": {
2133 "type": "object" 2191 "description": "The range the values cover, in A1 notation.\ nFor output, this range indicates the entire requested range,\neven though the v alues will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appende d.",
2134 }, 2192 "type": "string"
2135 "NamedRange": { 2193 }
2136 "description": "A named range.", 2194 },
2137 "id": "NamedRange", 2195 "type": "object"
2138 "properties": { 2196 },
2139 "name": { 2197 "AppendCellsRequest": {
2140 "description": "The name of the named range.", 2198 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
2141 "type": "string" 2199 "id": "AppendCellsRequest",
2142 }, 2200 "properties": {
2143 "namedRangeId": { 2201 "rows": {
2144 "description": "The ID of the named range.", 2202 "description": "The data to append.",
2203 "items": {
2204 "$ref": "RowData"
2205 },
2206 "type": "array"
2207 },
2208 "fields": {
2209 "description": "The fields of CellData that should be update d.\nAt least one field must be specified.\nThe root is the CellData; 'row.values .' should not be specified.\nA single `\"*\"` can be used as short-hand for list ing every field.",
2210 "format": "google-fieldmask",
2211 "type": "string"
2212 },
2213 "sheetId": {
2214 "description": "The sheet ID to append the data to.",
2215 "format": "int32",
2216 "type": "integer"
2217 }
2218 },
2219 "type": "object"
2220 },
2221 "AddBandingRequest": {
2222 "description": "Adds a new banded range to the spreadsheet.",
2223 "id": "AddBandingRequest",
2224 "properties": {
2225 "bandedRange": {
2226 "$ref": "BandedRange",
2227 "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.)"
2228 }
2229 },
2230 "type": "object"
2231 },
2232 "Response": {
2233 "description": "A single response from an update.",
2234 "id": "Response",
2235 "properties": {
2236 "addProtectedRange": {
2237 "$ref": "AddProtectedRangeResponse",
2238 "description": "A reply from adding a protected range."
2239 },
2240 "duplicateSheet": {
2241 "$ref": "DuplicateSheetResponse",
2242 "description": "A reply from duplicating a sheet."
2243 },
2244 "updateEmbeddedObjectPosition": {
2245 "$ref": "UpdateEmbeddedObjectPositionResponse",
2246 "description": "A reply from updating an embedded object's p osition."
2247 },
2248 "deleteConditionalFormatRule": {
2249 "$ref": "DeleteConditionalFormatRuleResponse",
2250 "description": "A reply from deleting a conditional format r ule."
2251 },
2252 "duplicateFilterView": {
2253 "$ref": "DuplicateFilterViewResponse",
2254 "description": "A reply from duplicating a filter view."
2255 },
2256 "addChart": {
2257 "$ref": "AddChartResponse",
2258 "description": "A reply from adding a chart."
2259 },
2260 "findReplace": {
2261 "$ref": "FindReplaceResponse",
2262 "description": "A reply from doing a find/replace."
2263 },
2264 "addSheet": {
2265 "$ref": "AddSheetResponse",
2266 "description": "A reply from adding a sheet."
2267 },
2268 "updateConditionalFormatRule": {
2269 "$ref": "UpdateConditionalFormatRuleResponse",
2270 "description": "A reply from updating a conditional format r ule."
2271 },
2272 "addNamedRange": {
2273 "$ref": "AddNamedRangeResponse",
2274 "description": "A reply from adding a named range."
2275 },
2276 "addFilterView": {
2277 "$ref": "AddFilterViewResponse",
2278 "description": "A reply from adding a filter view."
2279 },
2280 "addBanding": {
2281 "$ref": "AddBandingResponse",
2282 "description": "A reply from adding a banded range."
2283 }
2284 },
2285 "type": "object"
2286 },
2287 "InsertRangeRequest": {
2288 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
2289 "id": "InsertRangeRequest",
2290 "properties": {
2291 "shiftDimension": {
2292 "description": "The dimension which will be shifted when ins erting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existi ng cells will be shifted right.",
2293 "enum": [
2294 "DIMENSION_UNSPECIFIED",
2295 "ROWS",
2296 "COLUMNS"
2297 ],
2298 "enumDescriptions": [
2299 "The default value, do not use.",
2300 "Operates on the rows of a sheet.",
2301 "Operates on the columns of a sheet."
2302 ],
2145 "type": "string" 2303 "type": "string"
2146 }, 2304 },
2147 "range": { 2305 "range": {
2148 "$ref": "GridRange", 2306 "$ref": "GridRange",
2149 "description": "The range this represents." 2307 "description": "The range to insert new cells into."
2150 } 2308 }
2151 }, 2309 },
2152 "type": "object" 2310 "type": "object"
2153 }, 2311 },
2154 "CutPasteRequest": { 2312 "TextFormatRun": {
2155 "description": "Moves data from the source to the destination.", 2313 "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.",
2156 "id": "CutPasteRequest", 2314 "id": "TextFormatRun",
2157 "properties": { 2315 "properties": {
2158 "source": { 2316 "startIndex": {
2317 "description": "The character index where this run starts.",
2318 "format": "int32",
2319 "type": "integer"
2320 },
2321 "format": {
2322 "$ref": "TextFormat",
2323 "description": "The format of this run. Absent values inher it the cell's format."
2324 }
2325 },
2326 "type": "object"
2327 },
2328 "EmbeddedChart": {
2329 "description": "A chart embedded in a sheet.",
2330 "id": "EmbeddedChart",
2331 "properties": {
2332 "chartId": {
2333 "description": "The ID of the chart.",
2334 "format": "int32",
2335 "type": "integer"
2336 },
2337 "position": {
2338 "$ref": "EmbeddedObjectPosition",
2339 "description": "The position of the chart."
2340 },
2341 "spec": {
2342 "$ref": "ChartSpec",
2343 "description": "The specification of the chart."
2344 }
2345 },
2346 "type": "object"
2347 },
2348 "AddNamedRangeResponse": {
2349 "description": "The result of adding a named range.",
2350 "id": "AddNamedRangeResponse",
2351 "properties": {
2352 "namedRange": {
2353 "$ref": "NamedRange",
2354 "description": "The named range to add."
2355 }
2356 },
2357 "type": "object"
2358 },
2359 "RowData": {
2360 "description": "Data about each cell in a row.",
2361 "id": "RowData",
2362 "properties": {
2363 "values": {
2364 "description": "The values in the row, one per column.",
2365 "items": {
2366 "$ref": "CellData"
2367 },
2368 "type": "array"
2369 }
2370 },
2371 "type": "object"
2372 },
2373 "Border": {
2374 "description": "A border along a cell.",
2375 "id": "Border",
2376 "properties": {
2377 "color": {
2378 "$ref": "Color",
2379 "description": "The color of the border."
2380 },
2381 "width": {
2382 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.",
2383 "format": "int32",
2384 "type": "integer"
2385 },
2386 "style": {
2387 "description": "The style of the border.",
2388 "enum": [
2389 "STYLE_UNSPECIFIED",
2390 "DOTTED",
2391 "DASHED",
2392 "SOLID",
2393 "SOLID_MEDIUM",
2394 "SOLID_THICK",
2395 "NONE",
2396 "DOUBLE"
2397 ],
2398 "enumDescriptions": [
2399 "The style is not specified. Do not use this.",
2400 "The border is dotted.",
2401 "The border is dashed.",
2402 "The border is a thin solid line.",
2403 "The border is a medium solid line.",
2404 "The border is a thick solid line.",
2405 "No border.\nUsed only when updating a border in order t o erase it.",
2406 "The border is two solid lines."
2407 ],
2408 "type": "string"
2409 }
2410 },
2411 "type": "object"
2412 },
2413 "GridData": {
2414 "description": "Data in the grid, as well as metadata about the dime nsions.",
2415 "id": "GridData",
2416 "properties": {
2417 "columnMetadata": {
2418 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
2419 "items": {
2420 "$ref": "DimensionProperties"
2421 },
2422 "type": "array"
2423 },
2424 "startColumn": {
2425 "description": "The first column this GridData refers to, ze ro-based.",
2426 "format": "int32",
2427 "type": "integer"
2428 },
2429 "rowMetadata": {
2430 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
2431 "items": {
2432 "$ref": "DimensionProperties"
2433 },
2434 "type": "array"
2435 },
2436 "rowData": {
2437 "description": "The data in the grid, one entry per row,\nst arting with the row in startRow.\nThe values in RowData will correspond to colum ns starting\nat start_column.",
2438 "items": {
2439 "$ref": "RowData"
2440 },
2441 "type": "array"
2442 },
2443 "startRow": {
2444 "description": "The first row this GridData refers to, zero- based.",
2445 "format": "int32",
2446 "type": "integer"
2447 }
2448 },
2449 "type": "object"
2450 },
2451 "FindReplaceRequest": {
2452 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
2453 "id": "FindReplaceRequest",
2454 "properties": {
2455 "matchEntireCell": {
2456 "description": "True if the find value should match the enti re cell.",
2457 "type": "boolean"
2458 },
2459 "find": {
2460 "description": "The value to search.",
2461 "type": "string"
2462 },
2463 "searchByRegex": {
2464 "description": "True if the find value is a regex.\nThe regu lar expression and replacement should follow Java regex rules\nat https://docs.o racle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement strin g is allowed to refer to capturing groups.\nFor example, if one cell has the con tents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
2465 "type": "boolean"
2466 },
2467 "replacement": {
2468 "description": "The value to use as the replacement.",
2469 "type": "string"
2470 },
2471 "range": {
2159 "$ref": "GridRange", 2472 "$ref": "GridRange",
2160 "description": "The source data to cut." 2473 "description": "The range to find/replace over."
2161 }, 2474 },
2162 "pasteType": { 2475 "sheetId": {
2163 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.", 2476 "description": "The sheet to find/replace over.",
2477 "format": "int32",
2478 "type": "integer"
2479 },
2480 "matchCase": {
2481 "description": "True if the search is case sensitive.",
2482 "type": "boolean"
2483 },
2484 "allSheets": {
2485 "description": "True to find/replace over all sheets.",
2486 "type": "boolean"
2487 },
2488 "includeFormulas": {
2489 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
2490 "type": "boolean"
2491 }
2492 },
2493 "type": "object"
2494 },
2495 "UpdateNamedRangeRequest": {
2496 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
2497 "id": "UpdateNamedRangeRequest",
2498 "properties": {
2499 "namedRange": {
2500 "$ref": "NamedRange",
2501 "description": "The named range to update with the new prope rties."
2502 },
2503 "fields": {
2504 "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not b e specified.\nA single `\"*\"` can be used as short-hand for listing every field .",
2505 "format": "google-fieldmask",
2506 "type": "string"
2507 }
2508 },
2509 "type": "object"
2510 },
2511 "AddSheetRequest": {
2512 "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmb eddedObjectPosition.newSheet.",
2513 "id": "AddSheetRequest",
2514 "properties": {
2515 "properties": {
2516 "$ref": "SheetProperties",
2517 "description": "The properties the new sheet should have.\nA ll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
2518 }
2519 },
2520 "type": "object"
2521 },
2522 "UpdateCellsRequest": {
2523 "description": "Updates all cells in a range with new data.",
2524 "id": "UpdateCellsRequest",
2525 "properties": {
2526 "start": {
2527 "$ref": "GridCoordinate",
2528 "description": "The coordinate to start writing data at.\nAn y number of rows and columns (including a different number of\ncolumns per row) may be written."
2529 },
2530 "range": {
2531 "$ref": "GridRange",
2532 "description": "The range to write data to.\n\nIf the data i n rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
2533 },
2534 "rows": {
2535 "description": "The data to write.",
2536 "items": {
2537 "$ref": "RowData"
2538 },
2539 "type": "array"
2540 },
2541 "fields": {
2542 "description": "The fields of CellData that should be update d.\nAt least one field must be specified.\nThe root is the CellData; 'row.values .' should not be specified.\nA single `\"*\"` can be used as short-hand for list ing every field.",
2543 "format": "google-fieldmask",
2544 "type": "string"
2545 }
2546 },
2547 "type": "object"
2548 },
2549 "DeleteConditionalFormatRuleResponse": {
2550 "description": "The result of deleting a conditional format rule.",
2551 "id": "DeleteConditionalFormatRuleResponse",
2552 "properties": {
2553 "rule": {
2554 "$ref": "ConditionalFormatRule",
2555 "description": "The rule that was deleted."
2556 }
2557 },
2558 "type": "object"
2559 },
2560 "DeleteRangeRequest": {
2561 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
2562 "id": "DeleteRangeRequest",
2563 "properties": {
2564 "shiftDimension": {
2565 "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace th e deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
2566 "enum": [
2567 "DIMENSION_UNSPECIFIED",
2568 "ROWS",
2569 "COLUMNS"
2570 ],
2571 "enumDescriptions": [
2572 "The default value, do not use.",
2573 "Operates on the rows of a sheet.",
2574 "Operates on the columns of a sheet."
2575 ],
2576 "type": "string"
2577 },
2578 "range": {
2579 "$ref": "GridRange",
2580 "description": "The range of cells to delete."
2581 }
2582 },
2583 "type": "object"
2584 },
2585 "GridCoordinate": {
2586 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
2587 "id": "GridCoordinate",
2588 "properties": {
2589 "rowIndex": {
2590 "description": "The row index of the coordinate.",
2591 "format": "int32",
2592 "type": "integer"
2593 },
2594 "columnIndex": {
2595 "description": "The column index of the coordinate.",
2596 "format": "int32",
2597 "type": "integer"
2598 },
2599 "sheetId": {
2600 "description": "The sheet this coordinate is on.",
2601 "format": "int32",
2602 "type": "integer"
2603 }
2604 },
2605 "type": "object"
2606 },
2607 "UpdateSheetPropertiesRequest": {
2608 "description": "Updates properties of the sheet with the specified\n sheetId.",
2609 "id": "UpdateSheetPropertiesRequest",
2610 "properties": {
2611 "properties": {
2612 "$ref": "SheetProperties",
2613 "description": "The properties to update."
2614 },
2615 "fields": {
2616 "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 .",
2617 "format": "google-fieldmask",
2618 "type": "string"
2619 }
2620 },
2621 "type": "object"
2622 },
2623 "UnmergeCellsRequest": {
2624 "description": "Unmerges cells in the given range.",
2625 "id": "UnmergeCellsRequest",
2626 "properties": {
2627 "range": {
2628 "$ref": "GridRange",
2629 "description": "The range within which all cells should be u nmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range m ust not partially span any merge."
2630 }
2631 },
2632 "type": "object"
2633 },
2634 "GridProperties": {
2635 "description": "Properties of a grid.",
2636 "id": "GridProperties",
2637 "properties": {
2638 "rowCount": {
2639 "description": "The number of rows in the grid.",
2640 "format": "int32",
2641 "type": "integer"
2642 },
2643 "frozenRowCount": {
2644 "description": "The number of rows that are frozen in the gr id.",
2645 "format": "int32",
2646 "type": "integer"
2647 },
2648 "hideGridlines": {
2649 "description": "True if the grid isn't showing gridlines in the UI.",
2650 "type": "boolean"
2651 },
2652 "columnCount": {
2653 "description": "The number of columns in the grid.",
2654 "format": "int32",
2655 "type": "integer"
2656 },
2657 "frozenColumnCount": {
2658 "description": "The number of columns that are frozen in the grid.",
2659 "format": "int32",
2660 "type": "integer"
2661 }
2662 },
2663 "type": "object"
2664 },
2665 "Sheet": {
2666 "description": "A sheet in a spreadsheet.",
2667 "id": "Sheet",
2668 "properties": {
2669 "charts": {
2670 "description": "The specifications of every chart on this sh eet.",
2671 "items": {
2672 "$ref": "EmbeddedChart"
2673 },
2674 "type": "array"
2675 },
2676 "properties": {
2677 "$ref": "SheetProperties",
2678 "description": "The properties of the sheet."
2679 },
2680 "filterViews": {
2681 "description": "The filter views in this sheet.",
2682 "items": {
2683 "$ref": "FilterView"
2684 },
2685 "type": "array"
2686 },
2687 "protectedRanges": {
2688 "description": "The protected ranges in this sheet.",
2689 "items": {
2690 "$ref": "ProtectedRange"
2691 },
2692 "type": "array"
2693 },
2694 "conditionalFormats": {
2695 "description": "The conditional format rules in this sheet." ,
2696 "items": {
2697 "$ref": "ConditionalFormatRule"
2698 },
2699 "type": "array"
2700 },
2701 "basicFilter": {
2702 "$ref": "BasicFilter",
2703 "description": "The filter on this sheet, if any."
2704 },
2705 "merges": {
2706 "description": "The ranges that are merged together.",
2707 "items": {
2708 "$ref": "GridRange"
2709 },
2710 "type": "array"
2711 },
2712 "data": {
2713 "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).",
2714 "items": {
2715 "$ref": "GridData"
2716 },
2717 "type": "array"
2718 },
2719 "bandedRanges": {
2720 "description": "The banded (i.e. alternating colors) ranges on this sheet.",
2721 "items": {
2722 "$ref": "BandedRange"
2723 },
2724 "type": "array"
2725 }
2726 },
2727 "type": "object"
2728 },
2729 "SortSpec": {
2730 "description": "A sort order associated with a specific column or ro w.",
2731 "id": "SortSpec",
2732 "properties": {
2733 "dimensionIndex": {
2734 "description": "The dimension the sort should be applied to. ",
2735 "format": "int32",
2736 "type": "integer"
2737 },
2738 "sortOrder": {
2739 "description": "The order data should be sorted.",
2740 "enum": [
2741 "SORT_ORDER_UNSPECIFIED",
2742 "ASCENDING",
2743 "DESCENDING"
2744 ],
2745 "enumDescriptions": [
2746 "Default value, do not use this.",
2747 "Sort ascending.",
2748 "Sort descending."
2749 ],
2750 "type": "string"
2751 }
2752 },
2753 "type": "object"
2754 },
2755 "UpdateEmbeddedObjectPositionResponse": {
2756 "description": "The result of updating an embedded object's position .",
2757 "id": "UpdateEmbeddedObjectPositionResponse",
2758 "properties": {
2759 "position": {
2760 "$ref": "EmbeddedObjectPosition",
2761 "description": "The new position of the embedded object."
2762 }
2763 },
2764 "type": "object"
2765 },
2766 "BooleanRule": {
2767 "description": "A rule that may or may not match, depending on the c ondition.",
2768 "id": "BooleanRule",
2769 "properties": {
2770 "format": {
2771 "$ref": "CellFormat",
2772 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color."
2773 },
2774 "condition": {
2775 "$ref": "BooleanCondition",
2776 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
2777 }
2778 },
2779 "type": "object"
2780 },
2781 "FilterCriteria": {
2782 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
2783 "id": "FilterCriteria",
2784 "properties": {
2785 "hiddenValues": {
2786 "description": "Values that should be hidden.",
2787 "items": {
2788 "type": "string"
2789 },
2790 "type": "array"
2791 },
2792 "condition": {
2793 "$ref": "BooleanCondition",
2794 "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
2795 }
2796 },
2797 "type": "object"
2798 },
2799 "PivotGroupValueMetadata": {
2800 "description": "Metadata about a value in a pivot grouping.",
2801 "id": "PivotGroupValueMetadata",
2802 "properties": {
2803 "value": {
2804 "$ref": "ExtendedValue",
2805 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
2806 },
2807 "collapsed": {
2808 "description": "True if the data corresponding to the value is collapsed.",
2809 "type": "boolean"
2810 }
2811 },
2812 "type": "object"
2813 },
2814 "Editors": {
2815 "description": "The editors of a protected range.",
2816 "id": "Editors",
2817 "properties": {
2818 "users": {
2819 "description": "The email addresses of users with edit acces s to the protected range.",
2820 "items": {
2821 "type": "string"
2822 },
2823 "type": "array"
2824 },
2825 "groups": {
2826 "description": "The email addresses of groups with edit acce ss to the protected range.",
2827 "items": {
2828 "type": "string"
2829 },
2830 "type": "array"
2831 },
2832 "domainUsersCanEdit": {
2833 "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on doc uments within a domain.",
2834 "type": "boolean"
2835 }
2836 },
2837 "type": "object"
2838 },
2839 "UpdateConditionalFormatRuleRequest": {
2840 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
2841 "id": "UpdateConditionalFormatRuleRequest",
2842 "properties": {
2843 "sheetId": {
2844 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
2845 "format": "int32",
2846 "type": "integer"
2847 },
2848 "newIndex": {
2849 "description": "The zero-based new index the rule should end up at.",
2850 "format": "int32",
2851 "type": "integer"
2852 },
2853 "rule": {
2854 "$ref": "ConditionalFormatRule",
2855 "description": "The rule that should replace the rule at the given index."
2856 },
2857 "index": {
2858 "description": "The zero-based index of the rule that should be replaced or moved.",
2859 "format": "int32",
2860 "type": "integer"
2861 }
2862 },
2863 "type": "object"
2864 },
2865 "DataValidationRule": {
2866 "description": "A data validation rule.",
2867 "id": "DataValidationRule",
2868 "properties": {
2869 "condition": {
2870 "$ref": "BooleanCondition",
2871 "description": "The condition that data in the cell must mat ch."
2872 },
2873 "showCustomUi": {
2874 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
2875 "type": "boolean"
2876 },
2877 "strict": {
2878 "description": "True if invalid data should be rejected.",
2879 "type": "boolean"
2880 },
2881 "inputMessage": {
2882 "description": "A message to show the user when adding data to the cell.",
2883 "type": "string"
2884 }
2885 },
2886 "type": "object"
2887 },
2888 "BasicChartDomain": {
2889 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
2890 "id": "BasicChartDomain",
2891 "properties": {
2892 "domain": {
2893 "$ref": "ChartData",
2894 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
2895 }
2896 },
2897 "type": "object"
2898 },
2899 "PasteDataRequest": {
2900 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
2901 "id": "PasteDataRequest",
2902 "properties": {
2903 "data": {
2904 "description": "The data to insert.",
2905 "type": "string"
2906 },
2907 "delimiter": {
2908 "description": "The delimiter in the data.",
2909 "type": "string"
2910 },
2911 "type": {
2912 "description": "How the data should be pasted.",
2164 "enum": [ 2913 "enum": [
2165 "PASTE_NORMAL", 2914 "PASTE_NORMAL",
2166 "PASTE_VALUES", 2915 "PASTE_VALUES",
2167 "PASTE_FORMAT", 2916 "PASTE_FORMAT",
2168 "PASTE_NO_BORDERS", 2917 "PASTE_NO_BORDERS",
2169 "PASTE_FORMULA", 2918 "PASTE_FORMULA",
2170 "PASTE_DATA_VALIDATION", 2919 "PASTE_DATA_VALIDATION",
2171 "PASTE_CONDITIONAL_FORMATTING" 2920 "PASTE_CONDITIONAL_FORMATTING"
2172 ], 2921 ],
2173 "enumDescriptions": [ 2922 "enumDescriptions": [
2174 "Paste values, formulas, formats, and merges.", 2923 "Paste values, formulas, formats, and merges.",
2175 "Paste the values ONLY without formats, formulas, or mer ges.", 2924 "Paste the values ONLY without formats, formulas, or mer ges.",
2176 "Paste the format and data validation only.", 2925 "Paste the format and data validation only.",
2177 "Like PASTE_NORMAL but without borders.", 2926 "Like PASTE_NORMAL but without borders.",
2178 "Paste the formulas only.", 2927 "Paste the formulas only.",
2179 "Paste the data validation only.", 2928 "Paste the data validation only.",
2180 "Paste the conditional formatting rules only." 2929 "Paste the conditional formatting rules only."
2181 ], 2930 ],
2182 "type": "string" 2931 "type": "string"
2183 }, 2932 },
2184 "destination": { 2933 "html": {
2934 "description": "True if the data is HTML.",
2935 "type": "boolean"
2936 },
2937 "coordinate": {
2185 "$ref": "GridCoordinate", 2938 "$ref": "GridCoordinate",
2186 "description": "The top-left coordinate where the data shoul d be pasted." 2939 "description": "The coordinate at which the data should star t being inserted."
2187 } 2940 }
2188 }, 2941 },
2189 "type": "object" 2942 "type": "object"
2190 }, 2943 },
2191 "Borders": { 2944 "AppendDimensionRequest": {
2192 "description": "The borders of the cell.", 2945 "description": "Appends rows or columns to the end of a sheet.",
2193 "id": "Borders", 2946 "id": "AppendDimensionRequest",
2194 "properties": { 2947 "properties": {
2195 "right": {
2196 "$ref": "Border",
2197 "description": "The right border of the cell."
2198 },
2199 "bottom": {
2200 "$ref": "Border",
2201 "description": "The bottom border of the cell."
2202 },
2203 "top": {
2204 "$ref": "Border",
2205 "description": "The top border of the cell."
2206 },
2207 "left": {
2208 "$ref": "Border",
2209 "description": "The left border of the cell."
2210 }
2211 },
2212 "type": "object"
2213 },
2214 "BasicChartSeries": {
2215 "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
2216 "id": "BasicChartSeries",
2217 "properties": {
2218 "targetAxis": {
2219 "description": "The minor axis that will specify the range o f values for this series.\nFor example, if charting stocks over time, the \"Volu me\" series\nmay want to be pinned to the right with the prices pinned to the le ft,\nbecause the scale of trading volume is different than the scale of\nprices. \nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart 's type.",
2220 "enum": [
2221 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
2222 "BOTTOM_AXIS",
2223 "LEFT_AXIS",
2224 "RIGHT_AXIS"
2225 ],
2226 "enumDescriptions": [
2227 "Default value, do not use.",
2228 "The axis rendered at the bottom of a chart.\nFor most c harts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
2229 "The axis rendered at the left of a chart.\nFor most cha rts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
2230 "The axis rendered at the right of a chart.\nFor most ch arts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
2231 ],
2232 "type": "string"
2233 },
2234 "series": {
2235 "$ref": "ChartData",
2236 "description": "The data being visualized in this chart seri es."
2237 },
2238 "type": {
2239 "description": "The type of this series. Valid only if the\n chartType is\nCOMBO.\nDifferent types will change the way the series is visualiz ed.\nOnly LINE, AREA,\nand COLUMN are supported.",
2240 "enum": [
2241 "BASIC_CHART_TYPE_UNSPECIFIED",
2242 "BAR",
2243 "LINE",
2244 "AREA",
2245 "COLUMN",
2246 "SCATTER",
2247 "COMBO"
2248 ],
2249 "enumDescriptions": [
2250 "Default value, do not use.",
2251 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
2252 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
2253 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
2254 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
2255 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
2256 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
2257 ],
2258 "type": "string"
2259 }
2260 },
2261 "type": "object"
2262 },
2263 "AutoResizeDimensionsRequest": {
2264 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
2265 "id": "AutoResizeDimensionsRequest",
2266 "properties": {
2267 "dimensions": {
2268 "$ref": "DimensionRange",
2269 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
2270 }
2271 },
2272 "type": "object"
2273 },
2274 "UpdateBordersRequest": {
2275 "description": "Updates the borders of a range.\nIf a field is not s et in the request, that means the border remains as-is.\nFor example, with two s ubsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE } `\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a bord ers of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a borde r, explicitly set the style to\nNONE.",
2276 "id": "UpdateBordersRequest",
2277 "properties": {
2278 "innerVertical": {
2279 "$ref": "Border",
2280 "description": "The vertical border to put within the range. "
2281 },
2282 "right": {
2283 "$ref": "Border",
2284 "description": "The border to put at the right of the range. "
2285 },
2286 "range": {
2287 "$ref": "GridRange",
2288 "description": "The range whose borders should be updated."
2289 },
2290 "innerHorizontal": {
2291 "$ref": "Border",
2292 "description": "The horizontal border to put within the rang e."
2293 },
2294 "top": {
2295 "$ref": "Border",
2296 "description": "The border to put at the top of the range."
2297 },
2298 "left": {
2299 "$ref": "Border",
2300 "description": "The border to put at the left of the range."
2301 },
2302 "bottom": {
2303 "$ref": "Border",
2304 "description": "The border to put at the bottom of the range ."
2305 }
2306 },
2307 "type": "object"
2308 },
2309 "CellFormat": {
2310 "description": "The format of a cell.",
2311 "id": "CellFormat",
2312 "properties": {
2313 "numberFormat": {
2314 "$ref": "NumberFormat",
2315 "description": "A format describing how number values should be represented to the user."
2316 },
2317 "horizontalAlignment": {
2318 "description": "The horizontal alignment of the value in the cell.",
2319 "enum": [
2320 "HORIZONTAL_ALIGN_UNSPECIFIED",
2321 "LEFT",
2322 "CENTER",
2323 "RIGHT"
2324 ],
2325 "enumDescriptions": [
2326 "The horizontal alignment is not specified. Do not use t his.",
2327 "The text is explicitly aligned to the left of the cell. ",
2328 "The text is explicitly aligned to the center of the cel l.",
2329 "The text is explicitly aligned to the right of the cell ."
2330 ],
2331 "type": "string"
2332 },
2333 "hyperlinkDisplayType": {
2334 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
2335 "enum": [
2336 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
2337 "LINKED",
2338 "PLAIN_TEXT"
2339 ],
2340 "enumDescriptions": [
2341 "The default value: the hyperlink is rendered. Do not us e this.",
2342 "A hyperlink should be explicitly rendered.",
2343 "A hyperlink should not be rendered."
2344 ],
2345 "type": "string"
2346 },
2347 "textFormat": {
2348 "$ref": "TextFormat",
2349 "description": "The format of the text in the cell (unless o verridden by a format run)."
2350 },
2351 "backgroundColor": {
2352 "$ref": "Color",
2353 "description": "The background color of the cell."
2354 },
2355 "verticalAlignment": {
2356 "description": "The vertical alignment of the value in the c ell.",
2357 "enum": [
2358 "VERTICAL_ALIGN_UNSPECIFIED",
2359 "TOP",
2360 "MIDDLE",
2361 "BOTTOM"
2362 ],
2363 "enumDescriptions": [
2364 "The vertical alignment is not specified. Do not use th is.",
2365 "The text is explicitly aligned to the top of the cell." ,
2366 "The text is explicitly aligned to the middle of the cel l.",
2367 "The text is explicitly aligned to the bottom of the cel l."
2368 ],
2369 "type": "string"
2370 },
2371 "padding": {
2372 "$ref": "Padding",
2373 "description": "The padding of the cell."
2374 },
2375 "textDirection": {
2376 "description": "The direction of the text in the cell.",
2377 "enum": [
2378 "TEXT_DIRECTION_UNSPECIFIED",
2379 "LEFT_TO_RIGHT",
2380 "RIGHT_TO_LEFT"
2381 ],
2382 "enumDescriptions": [
2383 "The text direction is not specified. Do not use this.",
2384 "The text direction of left-to-right was set by the user .",
2385 "The text direction of right-to-left was set by the user ."
2386 ],
2387 "type": "string"
2388 },
2389 "borders": {
2390 "$ref": "Borders",
2391 "description": "The borders of the cell."
2392 },
2393 "wrapStrategy": {
2394 "description": "The wrap strategy for the value in the cell. ",
2395 "enum": [
2396 "WRAP_STRATEGY_UNSPECIFIED",
2397 "OVERFLOW_CELL",
2398 "LEGACY_WRAP",
2399 "CLIP",
2400 "WRAP"
2401 ],
2402 "enumDescriptions": [
2403 "The default value, do not use.",
2404 "Lines that are longer than the cell width will be writt en in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the n ext line unless the user manually inserts a new line.\nExample:\n\n | First s entence. |\n | Manual newline that is very long. <- Text continues into next cell\n | Next newline. |",
2405 "This wrap strategy represents the old Google Sheets wra p strategy where\nwords that are longer than a line are clipped rather than brok en. This\nstrategy is not supported on all platforms and is being phased out.\nE xample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | wor d. |",
2406 "Lines that are longer than the cell width will be clipp ed.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| <- Te xt is clipped\n | Next newline. |",
2407 "Words that are longer than a line are wrapped at the ch aracter level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooo oooooo| <- Word is broken.\n | ong word. |"
2408 ],
2409 "type": "string"
2410 },
2411 "textRotation": {
2412 "$ref": "TextRotation",
2413 "description": "The rotation applied to text in a cell"
2414 }
2415 },
2416 "type": "object"
2417 },
2418 "ClearValuesResponse": {
2419 "description": "The response when clearing a range of values in a sp readsheet.",
2420 "id": "ClearValuesResponse",
2421 "properties": {
2422 "spreadsheetId": {
2423 "description": "The spreadsheet the updates were applied to. ",
2424 "type": "string"
2425 },
2426 "clearedRange": {
2427 "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.)",
2428 "type": "string"
2429 }
2430 },
2431 "type": "object"
2432 },
2433 "DeleteConditionalFormatRuleRequest": {
2434 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
2435 "id": "DeleteConditionalFormatRuleRequest",
2436 "properties": {
2437 "index": {
2438 "description": "The zero-based index of the rule to be delet ed.",
2439 "format": "int32",
2440 "type": "integer"
2441 },
2442 "sheetId": { 2948 "sheetId": {
2443 "description": "The sheet the rule is being deleted from.", 2949 "description": "The sheet to append rows or columns to.",
2444 "format": "int32", 2950 "format": "int32",
2445 "type": "integer" 2951 "type": "integer"
2446 } 2952 },
2447 }, 2953 "dimension": {
2448 "type": "object" 2954 "description": "Whether rows or columns should be appended." ,
2449 },
2450 "DeleteNamedRangeRequest": {
2451 "description": "Removes the named range with the given ID from the s preadsheet.",
2452 "id": "DeleteNamedRangeRequest",
2453 "properties": {
2454 "namedRangeId": {
2455 "description": "The ID of the named range to delete.",
2456 "type": "string"
2457 }
2458 },
2459 "type": "object"
2460 },
2461 "AddBandingResponse": {
2462 "description": "The result of adding a banded range.",
2463 "id": "AddBandingResponse",
2464 "properties": {
2465 "bandedRange": {
2466 "$ref": "BandedRange",
2467 "description": "The banded range that was added."
2468 }
2469 },
2470 "type": "object"
2471 },
2472 "ChartData": {
2473 "description": "The data included in a domain or series.",
2474 "id": "ChartData",
2475 "properties": {
2476 "sourceRange": {
2477 "$ref": "ChartSourceRange",
2478 "description": "The source ranges of the data."
2479 }
2480 },
2481 "type": "object"
2482 },
2483 "BatchGetValuesResponse": {
2484 "description": "The response when retrieving more than one range of values in a spreadsheet.",
2485 "id": "BatchGetValuesResponse",
2486 "properties": {
2487 "spreadsheetId": {
2488 "description": "The ID of the spreadsheet the data was retri eved from.",
2489 "type": "string"
2490 },
2491 "valueRanges": {
2492 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
2493 "items": {
2494 "$ref": "ValueRange"
2495 },
2496 "type": "array"
2497 }
2498 },
2499 "type": "object"
2500 },
2501 "UpdateBandingRequest": {
2502 "description": "Updates properties of the supplied banded range.",
2503 "id": "UpdateBandingRequest",
2504 "properties": {
2505 "fields": {
2506 "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.",
2507 "format": "google-fieldmask",
2508 "type": "string"
2509 },
2510 "bandedRange": {
2511 "$ref": "BandedRange",
2512 "description": "The banded range to update with the new prop erties."
2513 }
2514 },
2515 "type": "object"
2516 },
2517 "Color": {
2518 "description": "Represents a color in the RGBA color space. This rep resentation is designed\nfor simplicity of conversion to/from color representati ons in various\nlanguages over compactness; for example, the fields of this repr esentation\ncan be trivially provided to the constructor of \"java.awt.Color\" i n Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:bl ue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily format ted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples :\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getG reen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGr een(green / denominator)\n .setBlue(blue / denominator);\n i nt alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlp ha(\n FloatValue\n .newBuilder()\n . setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj- C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protoco lor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor color WithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* to Proto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [resu lt setRed:red];\n [result setGreen:green];\n [result setBlue:blu e];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWi thValue(alpha)];\n }\n [result autorelease];\n return re sult;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var prot oToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\ n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color .blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = M ath.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbPara ms, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function( red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0 ; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n re sultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
2519 "id": "Color",
2520 "properties": {
2521 "red": {
2522 "description": "The amount of red in the color as a value in the interval [0, 1].",
2523 "format": "float",
2524 "type": "number"
2525 },
2526 "green": {
2527 "description": "The amount of green in the color as a value in the interval [0, 1].",
2528 "format": "float",
2529 "type": "number"
2530 },
2531 "blue": {
2532 "description": "The amount of blue in the color as a value i n the interval [0, 1].",
2533 "format": "float",
2534 "type": "number"
2535 },
2536 "alpha": {
2537 "description": "The fraction of this color that should be ap plied to the pixel. That is,\nthe final pixel color is defined by the equation:\ n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\n This means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish betwee n a default value and the value being unset.\nIf omitted, this color object is t o be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
2538 "format": "float",
2539 "type": "number"
2540 }
2541 },
2542 "type": "object"
2543 },
2544 "PivotGroup": {
2545 "description": "A single grouping (either row or column) in a pivot table.",
2546 "id": "PivotGroup",
2547 "properties": {
2548 "sourceColumnOffset": {
2549 "description": "The column offset of the source range that t his grouping is based on.\n\nFor example, if the source was `C10:E15`, a `source ColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
2550 "format": "int32",
2551 "type": "integer"
2552 },
2553 "showTotals": {
2554 "description": "True if the pivot table should include the t otals for this grouping.",
2555 "type": "boolean"
2556 },
2557 "valueMetadata": {
2558 "description": "Metadata about values in the grouping.",
2559 "items": {
2560 "$ref": "PivotGroupValueMetadata"
2561 },
2562 "type": "array"
2563 },
2564 "sortOrder": {
2565 "description": "The order the values in this group should be sorted.",
2566 "enum": [
2567 "SORT_ORDER_UNSPECIFIED",
2568 "ASCENDING",
2569 "DESCENDING"
2570 ],
2571 "enumDescriptions": [
2572 "Default value, do not use this.",
2573 "Sort ascending.",
2574 "Sort descending."
2575 ],
2576 "type": "string"
2577 },
2578 "valueBucket": {
2579 "$ref": "PivotGroupSortValueBucket",
2580 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
2581 }
2582 },
2583 "type": "object"
2584 },
2585 "PivotTable": {
2586 "description": "A pivot table.",
2587 "id": "PivotTable",
2588 "properties": {
2589 "criteria": {
2590 "additionalProperties": {
2591 "$ref": "PivotFilterCriteria"
2592 },
2593 "description": "An optional mapping of filters per source co lumn offset.\n\nThe filters will be applied before aggregating data into the piv ot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if th e source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, where as the key `1` is for column `D`.",
2594 "type": "object"
2595 },
2596 "rows": {
2597 "description": "Each row grouping in the pivot table.",
2598 "items": {
2599 "$ref": "PivotGroup"
2600 },
2601 "type": "array"
2602 },
2603 "valueLayout": {
2604 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
2605 "enum": [
2606 "HORIZONTAL",
2607 "VERTICAL"
2608 ],
2609 "enumDescriptions": [
2610 "Values are laid out horizontally (as columns).",
2611 "Values are laid out vertically (as rows)."
2612 ],
2613 "type": "string"
2614 },
2615 "columns": {
2616 "description": "Each column grouping in the pivot table.",
2617 "items": {
2618 "$ref": "PivotGroup"
2619 },
2620 "type": "array"
2621 },
2622 "values": {
2623 "description": "A list of values to include in the pivot tab le.",
2624 "items": {
2625 "$ref": "PivotValue"
2626 },
2627 "type": "array"
2628 },
2629 "source": {
2630 "$ref": "GridRange",
2631 "description": "The range the pivot table is reading data fr om."
2632 }
2633 },
2634 "type": "object"
2635 },
2636 "ChartSourceRange": {
2637 "description": "Source ranges for a chart.",
2638 "id": "ChartSourceRange",
2639 "properties": {
2640 "sources": {
2641 "description": "The ranges of data for a series or domain.\n Exactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source rang e, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sourc es: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sourc es: C1:C5, E10:E12",
2642 "items": {
2643 "$ref": "GridRange"
2644 },
2645 "type": "array"
2646 }
2647 },
2648 "type": "object"
2649 },
2650 "ValueRange": {
2651 "description": "Data within a range of the spreadsheet.",
2652 "id": "ValueRange",
2653 "properties": {
2654 "majorDimension": {
2655 "description": "The major dimension of the values.\n\nFor ou tput, 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 `r ange=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, w ith `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2, A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaul ts to ROWS.",
2656 "enum": [ 2955 "enum": [
2657 "DIMENSION_UNSPECIFIED", 2956 "DIMENSION_UNSPECIFIED",
2658 "ROWS", 2957 "ROWS",
2659 "COLUMNS"
2660 ],
2661 "enumDescriptions": [
2662 "The default value, do not use.",
2663 "Operates on the rows of a sheet.",
2664 "Operates on the columns of a sheet."
2665 ],
2666 "type": "string"
2667 },
2668 "values": {
2669 "description": "The data that was read or to be written. Th is is an array of arrays,\nthe outer array representing all the data and each in ner array\nrepresenting a major dimension. Each item in the inner array\ncorresp onds with one cell.\n\nFor output, empty trailing rows and columns will not be i ncluded.\n\nFor input, supported value types are: bool, string, and double.\nNul l values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
2670 "items": {
2671 "items": {
2672 "type": "any"
2673 },
2674 "type": "array"
2675 },
2676 "type": "array"
2677 },
2678 "range": {
2679 "description": "The range the values cover, in A1 notation.\ nFor output, this range indicates the entire requested range,\neven though the v alues will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appende d.",
2680 "type": "string"
2681 }
2682 },
2683 "type": "object"
2684 },
2685 "AppendCellsRequest": {
2686 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
2687 "id": "AppendCellsRequest",
2688 "properties": {
2689 "rows": {
2690 "description": "The data to append.",
2691 "items": {
2692 "$ref": "RowData"
2693 },
2694 "type": "array"
2695 },
2696 "fields": {
2697 "description": "The fields of CellData that should be update d.\nAt least one field must be specified.\nThe root is the CellData; 'row.values .' should not be specified.\nA single `\"*\"` can be used as short-hand for list ing every field.",
2698 "format": "google-fieldmask",
2699 "type": "string"
2700 },
2701 "sheetId": {
2702 "description": "The sheet ID to append the data to.",
2703 "format": "int32",
2704 "type": "integer"
2705 }
2706 },
2707 "type": "object"
2708 },
2709 "AddBandingRequest": {
2710 "description": "Adds a new banded range to the spreadsheet.",
2711 "id": "AddBandingRequest",
2712 "properties": {
2713 "bandedRange": {
2714 "$ref": "BandedRange",
2715 "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.)"
2716 }
2717 },
2718 "type": "object"
2719 },
2720 "Response": {
2721 "description": "A single response from an update.",
2722 "id": "Response",
2723 "properties": {
2724 "addProtectedRange": {
2725 "$ref": "AddProtectedRangeResponse",
2726 "description": "A reply from adding a protected range."
2727 },
2728 "duplicateSheet": {
2729 "$ref": "DuplicateSheetResponse",
2730 "description": "A reply from duplicating a sheet."
2731 },
2732 "updateEmbeddedObjectPosition": {
2733 "$ref": "UpdateEmbeddedObjectPositionResponse",
2734 "description": "A reply from updating an embedded object's p osition."
2735 },
2736 "deleteConditionalFormatRule": {
2737 "$ref": "DeleteConditionalFormatRuleResponse",
2738 "description": "A reply from deleting a conditional format r ule."
2739 },
2740 "duplicateFilterView": {
2741 "$ref": "DuplicateFilterViewResponse",
2742 "description": "A reply from duplicating a filter view."
2743 },
2744 "addChart": {
2745 "$ref": "AddChartResponse",
2746 "description": "A reply from adding a chart."
2747 },
2748 "findReplace": {
2749 "$ref": "FindReplaceResponse",
2750 "description": "A reply from doing a find/replace."
2751 },
2752 "addSheet": {
2753 "$ref": "AddSheetResponse",
2754 "description": "A reply from adding a sheet."
2755 },
2756 "updateConditionalFormatRule": {
2757 "$ref": "UpdateConditionalFormatRuleResponse",
2758 "description": "A reply from updating a conditional format r ule."
2759 },
2760 "addNamedRange": {
2761 "$ref": "AddNamedRangeResponse",
2762 "description": "A reply from adding a named range."
2763 },
2764 "addFilterView": {
2765 "$ref": "AddFilterViewResponse",
2766 "description": "A reply from adding a filter view."
2767 },
2768 "addBanding": {
2769 "$ref": "AddBandingResponse",
2770 "description": "A reply from adding a banded range."
2771 }
2772 },
2773 "type": "object"
2774 },
2775 "InsertRangeRequest": {
2776 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
2777 "id": "InsertRangeRequest",
2778 "properties": {
2779 "range": {
2780 "$ref": "GridRange",
2781 "description": "The range to insert new cells into."
2782 },
2783 "shiftDimension": {
2784 "description": "The dimension which will be shifted when ins erting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existi ng cells will be shifted right.",
2785 "enum": [
2786 "DIMENSION_UNSPECIFIED",
2787 "ROWS",
2788 "COLUMNS" 2958 "COLUMNS"
2789 ], 2959 ],
2790 "enumDescriptions": [ 2960 "enumDescriptions": [
2791 "The default value, do not use.", 2961 "The default value, do not use.",
2792 "Operates on the rows of a sheet.", 2962 "Operates on the rows of a sheet.",
2793 "Operates on the columns of a sheet." 2963 "Operates on the columns of a sheet."
2794 ], 2964 ],
2795 "type": "string" 2965 "type": "string"
2796 }
2797 },
2798 "type": "object"
2799 },
2800 "EmbeddedChart": {
2801 "description": "A chart embedded in a sheet.",
2802 "id": "EmbeddedChart",
2803 "properties": {
2804 "spec": {
2805 "$ref": "ChartSpec",
2806 "description": "The specification of the chart."
2807 },
2808 "chartId": {
2809 "description": "The ID of the chart.",
2810 "format": "int32",
2811 "type": "integer"
2812 },
2813 "position": {
2814 "$ref": "EmbeddedObjectPosition",
2815 "description": "The position of the chart."
2816 }
2817 },
2818 "type": "object"
2819 },
2820 "TextFormatRun": {
2821 "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.",
2822 "id": "TextFormatRun",
2823 "properties": {
2824 "format": {
2825 "$ref": "TextFormat",
2826 "description": "The format of this run. Absent values inher it the cell's format."
2827 },
2828 "startIndex": {
2829 "description": "The character index where this run starts.",
2830 "format": "int32",
2831 "type": "integer"
2832 }
2833 },
2834 "type": "object"
2835 },
2836 "AddNamedRangeResponse": {
2837 "description": "The result of adding a named range.",
2838 "id": "AddNamedRangeResponse",
2839 "properties": {
2840 "namedRange": {
2841 "$ref": "NamedRange",
2842 "description": "The named range to add."
2843 }
2844 },
2845 "type": "object"
2846 },
2847 "RowData": {
2848 "description": "Data about each cell in a row.",
2849 "id": "RowData",
2850 "properties": {
2851 "values": {
2852 "description": "The values in the row, one per column.",
2853 "items": {
2854 "$ref": "CellData"
2855 },
2856 "type": "array"
2857 }
2858 },
2859 "type": "object"
2860 },
2861 "GridData": {
2862 "description": "Data in the grid, as well as metadata about the dime nsions.",
2863 "id": "GridData",
2864 "properties": {
2865 "columnMetadata": {
2866 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
2867 "items": {
2868 "$ref": "DimensionProperties"
2869 },
2870 "type": "array"
2871 },
2872 "startColumn": {
2873 "description": "The first column this GridData refers to, ze ro-based.",
2874 "format": "int32",
2875 "type": "integer"
2876 },
2877 "rowMetadata": {
2878 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
2879 "items": {
2880 "$ref": "DimensionProperties"
2881 },
2882 "type": "array"
2883 },
2884 "rowData": {
2885 "description": "The data in the grid, one entry per row,\nst arting with the row in startRow.\nThe values in RowData will correspond to colum ns starting\nat start_column.",
2886 "items": {
2887 "$ref": "RowData"
2888 },
2889 "type": "array"
2890 },
2891 "startRow": {
2892 "description": "The first row this GridData refers to, zero- based.",
2893 "format": "int32",
2894 "type": "integer"
2895 }
2896 },
2897 "type": "object"
2898 },
2899 "Border": {
2900 "description": "A border along a cell.",
2901 "id": "Border",
2902 "properties": {
2903 "width": {
2904 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.",
2905 "format": "int32",
2906 "type": "integer"
2907 },
2908 "style": {
2909 "description": "The style of the border.",
2910 "enum": [
2911 "STYLE_UNSPECIFIED",
2912 "DOTTED",
2913 "DASHED",
2914 "SOLID",
2915 "SOLID_MEDIUM",
2916 "SOLID_THICK",
2917 "NONE",
2918 "DOUBLE"
2919 ],
2920 "enumDescriptions": [
2921 "The style is not specified. Do not use this.",
2922 "The border is dotted.",
2923 "The border is dashed.",
2924 "The border is a thin solid line.",
2925 "The border is a medium solid line.",
2926 "The border is a thick solid line.",
2927 "No border.\nUsed only when updating a border in order t o erase it.",
2928 "The border is two solid lines."
2929 ],
2930 "type": "string"
2931 },
2932 "color": {
2933 "$ref": "Color",
2934 "description": "The color of the border."
2935 }
2936 },
2937 "type": "object"
2938 },
2939 "UpdateNamedRangeRequest": {
2940 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
2941 "id": "UpdateNamedRangeRequest",
2942 "properties": {
2943 "namedRange": {
2944 "$ref": "NamedRange",
2945 "description": "The named range to update with the new prope rties."
2946 },
2947 "fields": {
2948 "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not b e specified.\nA single `\"*\"` can be used as short-hand for listing every field .",
2949 "format": "google-fieldmask",
2950 "type": "string"
2951 }
2952 },
2953 "type": "object"
2954 },
2955 "FindReplaceRequest": {
2956 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
2957 "id": "FindReplaceRequest",
2958 "properties": {
2959 "includeFormulas": {
2960 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
2961 "type": "boolean"
2962 },
2963 "matchEntireCell": {
2964 "description": "True if the find value should match the enti re cell.",
2965 "type": "boolean"
2966 },
2967 "searchByRegex": {
2968 "description": "True if the find value is a regex.\nThe regu lar expression and replacement should follow Java regex rules\nat https://docs.o racle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement strin g is allowed to refer to capturing groups.\nFor example, if one cell has the con tents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
2969 "type": "boolean"
2970 },
2971 "find": {
2972 "description": "The value to search.",
2973 "type": "string"
2974 },
2975 "replacement": {
2976 "description": "The value to use as the replacement.",
2977 "type": "string"
2978 },
2979 "range": {
2980 "$ref": "GridRange",
2981 "description": "The range to find/replace over."
2982 },
2983 "sheetId": {
2984 "description": "The sheet to find/replace over.",
2985 "format": "int32",
2986 "type": "integer"
2987 },
2988 "allSheets": {
2989 "description": "True to find/replace over all sheets.",
2990 "type": "boolean"
2991 },
2992 "matchCase": {
2993 "description": "True if the search is case sensitive.",
2994 "type": "boolean"
2995 }
2996 },
2997 "type": "object"
2998 },
2999 "AddSheetRequest": {
3000 "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmb eddedObjectPosition.newSheet.",
3001 "id": "AddSheetRequest",
3002 "properties": {
3003 "properties": {
3004 "$ref": "SheetProperties",
3005 "description": "The properties the new sheet should have.\nA ll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
3006 }
3007 },
3008 "type": "object"
3009 },
3010 "UpdateCellsRequest": {
3011 "description": "Updates all cells in a range with new data.",
3012 "id": "UpdateCellsRequest",
3013 "properties": {
3014 "start": {
3015 "$ref": "GridCoordinate",
3016 "description": "The coordinate to start writing data at.\nAn y number of rows and columns (including a different number of\ncolumns per row) may be written."
3017 },
3018 "range": {
3019 "$ref": "GridRange",
3020 "description": "The range to write data to.\n\nIf the data i n rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
3021 },
3022 "rows": {
3023 "description": "The data to write.",
3024 "items": {
3025 "$ref": "RowData"
3026 },
3027 "type": "array"
3028 },
3029 "fields": {
3030 "description": "The fields of CellData that should be update d.\nAt least one field must be specified.\nThe root is the CellData; 'row.values .' should not be specified.\nA single `\"*\"` can be used as short-hand for list ing every field.",
3031 "format": "google-fieldmask",
3032 "type": "string"
3033 }
3034 },
3035 "type": "object"
3036 },
3037 "DeleteConditionalFormatRuleResponse": {
3038 "description": "The result of deleting a conditional format rule.",
3039 "id": "DeleteConditionalFormatRuleResponse",
3040 "properties": {
3041 "rule": {
3042 "$ref": "ConditionalFormatRule",
3043 "description": "The rule that was deleted."
3044 }
3045 },
3046 "type": "object"
3047 },
3048 "DeleteRangeRequest": {
3049 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
3050 "id": "DeleteRangeRequest",
3051 "properties": {
3052 "shiftDimension": {
3053 "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace th e deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
3054 "enum": [
3055 "DIMENSION_UNSPECIFIED",
3056 "ROWS",
3057 "COLUMNS"
3058 ],
3059 "enumDescriptions": [
3060 "The default value, do not use.",
3061 "Operates on the rows of a sheet.",
3062 "Operates on the columns of a sheet."
3063 ],
3064 "type": "string"
3065 },
3066 "range": {
3067 "$ref": "GridRange",
3068 "description": "The range of cells to delete."
3069 }
3070 },
3071 "type": "object"
3072 },
3073 "GridCoordinate": {
3074 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
3075 "id": "GridCoordinate",
3076 "properties": {
3077 "rowIndex": {
3078 "description": "The row index of the coordinate.",
3079 "format": "int32",
3080 "type": "integer"
3081 },
3082 "columnIndex": {
3083 "description": "The column index of the coordinate.",
3084 "format": "int32",
3085 "type": "integer"
3086 },
3087 "sheetId": {
3088 "description": "The sheet this coordinate is on.",
3089 "format": "int32",
3090 "type": "integer"
3091 }
3092 },
3093 "type": "object"
3094 },
3095 "UpdateSheetPropertiesRequest": {
3096 "description": "Updates properties of the sheet with the specified\n sheetId.",
3097 "id": "UpdateSheetPropertiesRequest",
3098 "properties": {
3099 "fields": {
3100 "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 .",
3101 "format": "google-fieldmask",
3102 "type": "string"
3103 },
3104 "properties": {
3105 "$ref": "SheetProperties",
3106 "description": "The properties to update."
3107 }
3108 },
3109 "type": "object"
3110 },
3111 "UnmergeCellsRequest": {
3112 "description": "Unmerges cells in the given range.",
3113 "id": "UnmergeCellsRequest",
3114 "properties": {
3115 "range": {
3116 "$ref": "GridRange",
3117 "description": "The range within which all cells should be u nmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range m ust not partially span any merge."
3118 }
3119 },
3120 "type": "object"
3121 },
3122 "GridProperties": {
3123 "description": "Properties of a grid.",
3124 "id": "GridProperties",
3125 "properties": {
3126 "frozenRowCount": {
3127 "description": "The number of rows that are frozen in the gr id.",
3128 "format": "int32",
3129 "type": "integer"
3130 },
3131 "hideGridlines": {
3132 "description": "True if the grid isn't showing gridlines in the UI.",
3133 "type": "boolean"
3134 },
3135 "columnCount": {
3136 "description": "The number of columns in the grid.",
3137 "format": "int32",
3138 "type": "integer"
3139 },
3140 "frozenColumnCount": {
3141 "description": "The number of columns that are frozen in the grid.",
3142 "format": "int32",
3143 "type": "integer"
3144 },
3145 "rowCount": {
3146 "description": "The number of rows in the grid.",
3147 "format": "int32",
3148 "type": "integer"
3149 }
3150 },
3151 "type": "object"
3152 },
3153 "Sheet": {
3154 "description": "A sheet in a spreadsheet.",
3155 "id": "Sheet",
3156 "properties": {
3157 "data": {
3158 "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).",
3159 "items": {
3160 "$ref": "GridData"
3161 },
3162 "type": "array"
3163 },
3164 "bandedRanges": {
3165 "description": "The banded (i.e. alternating colors) ranges on this sheet.",
3166 "items": {
3167 "$ref": "BandedRange"
3168 },
3169 "type": "array"
3170 },
3171 "properties": {
3172 "$ref": "SheetProperties",
3173 "description": "The properties of the sheet."
3174 },
3175 "charts": {
3176 "description": "The specifications of every chart on this sh eet.",
3177 "items": {
3178 "$ref": "EmbeddedChart"
3179 },
3180 "type": "array"
3181 },
3182 "filterViews": {
3183 "description": "The filter views in this sheet.",
3184 "items": {
3185 "$ref": "FilterView"
3186 },
3187 "type": "array"
3188 },
3189 "protectedRanges": {
3190 "description": "The protected ranges in this sheet.",
3191 "items": {
3192 "$ref": "ProtectedRange"
3193 },
3194 "type": "array"
3195 },
3196 "conditionalFormats": {
3197 "description": "The conditional format rules in this sheet." ,
3198 "items": {
3199 "$ref": "ConditionalFormatRule"
3200 },
3201 "type": "array"
3202 },
3203 "basicFilter": {
3204 "$ref": "BasicFilter",
3205 "description": "The filter on this sheet, if any."
3206 },
3207 "merges": {
3208 "description": "The ranges that are merged together.",
3209 "items": {
3210 "$ref": "GridRange"
3211 },
3212 "type": "array"
3213 }
3214 },
3215 "type": "object"
3216 },
3217 "SortSpec": {
3218 "description": "A sort order associated with a specific column or ro w.",
3219 "id": "SortSpec",
3220 "properties": {
3221 "dimensionIndex": {
3222 "description": "The dimension the sort should be applied to. ",
3223 "format": "int32",
3224 "type": "integer"
3225 },
3226 "sortOrder": {
3227 "description": "The order data should be sorted.",
3228 "enum": [
3229 "SORT_ORDER_UNSPECIFIED",
3230 "ASCENDING",
3231 "DESCENDING"
3232 ],
3233 "enumDescriptions": [
3234 "Default value, do not use this.",
3235 "Sort ascending.",
3236 "Sort descending."
3237 ],
3238 "type": "string"
3239 }
3240 },
3241 "type": "object"
3242 },
3243 "UpdateEmbeddedObjectPositionResponse": {
3244 "description": "The result of updating an embedded object's position .",
3245 "id": "UpdateEmbeddedObjectPositionResponse",
3246 "properties": {
3247 "position": {
3248 "$ref": "EmbeddedObjectPosition",
3249 "description": "The new position of the embedded object."
3250 }
3251 },
3252 "type": "object"
3253 },
3254 "BooleanRule": {
3255 "description": "A rule that may or may not match, depending on the c ondition.",
3256 "id": "BooleanRule",
3257 "properties": {
3258 "format": {
3259 "$ref": "CellFormat",
3260 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color."
3261 },
3262 "condition": {
3263 "$ref": "BooleanCondition",
3264 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
3265 }
3266 },
3267 "type": "object"
3268 },
3269 "PivotGroupValueMetadata": {
3270 "description": "Metadata about a value in a pivot grouping.",
3271 "id": "PivotGroupValueMetadata",
3272 "properties": {
3273 "value": {
3274 "$ref": "ExtendedValue",
3275 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
3276 },
3277 "collapsed": {
3278 "description": "True if the data corresponding to the value is collapsed.",
3279 "type": "boolean"
3280 }
3281 },
3282 "type": "object"
3283 },
3284 "FilterCriteria": {
3285 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
3286 "id": "FilterCriteria",
3287 "properties": {
3288 "hiddenValues": {
3289 "description": "Values that should be hidden.",
3290 "items": {
3291 "type": "string"
3292 },
3293 "type": "array"
3294 },
3295 "condition": {
3296 "$ref": "BooleanCondition",
3297 "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
3298 }
3299 },
3300 "type": "object"
3301 },
3302 "Editors": {
3303 "description": "The editors of a protected range.",
3304 "id": "Editors",
3305 "properties": {
3306 "users": {
3307 "description": "The email addresses of users with edit acces s to the protected range.",
3308 "items": {
3309 "type": "string"
3310 },
3311 "type": "array"
3312 },
3313 "groups": {
3314 "description": "The email addresses of groups with edit acce ss to the protected range.",
3315 "items": {
3316 "type": "string"
3317 },
3318 "type": "array"
3319 },
3320 "domainUsersCanEdit": {
3321 "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on doc uments within a domain.",
3322 "type": "boolean"
3323 }
3324 },
3325 "type": "object"
3326 },
3327 "UpdateConditionalFormatRuleRequest": {
3328 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
3329 "id": "UpdateConditionalFormatRuleRequest",
3330 "properties": {
3331 "index": {
3332 "description": "The zero-based index of the rule that should be replaced or moved.",
3333 "format": "int32",
3334 "type": "integer"
3335 },
3336 "sheetId": {
3337 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
3338 "format": "int32",
3339 "type": "integer"
3340 },
3341 "newIndex": {
3342 "description": "The zero-based new index the rule should end up at.",
3343 "format": "int32",
3344 "type": "integer"
3345 },
3346 "rule": {
3347 "$ref": "ConditionalFormatRule",
3348 "description": "The rule that should replace the rule at the given index."
3349 }
3350 },
3351 "type": "object"
3352 },
3353 "BasicChartDomain": {
3354 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
3355 "id": "BasicChartDomain",
3356 "properties": {
3357 "domain": {
3358 "$ref": "ChartData",
3359 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
3360 }
3361 },
3362 "type": "object"
3363 },
3364 "DataValidationRule": {
3365 "description": "A data validation rule.",
3366 "id": "DataValidationRule",
3367 "properties": {
3368 "showCustomUi": {
3369 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
3370 "type": "boolean"
3371 },
3372 "strict": {
3373 "description": "True if invalid data should be rejected.",
3374 "type": "boolean"
3375 },
3376 "inputMessage": {
3377 "description": "A message to show the user when adding data to the cell.",
3378 "type": "string"
3379 },
3380 "condition": {
3381 "$ref": "BooleanCondition",
3382 "description": "The condition that data in the cell must mat ch."
3383 }
3384 },
3385 "type": "object"
3386 },
3387 "PasteDataRequest": {
3388 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
3389 "id": "PasteDataRequest",
3390 "properties": {
3391 "coordinate": {
3392 "$ref": "GridCoordinate",
3393 "description": "The coordinate at which the data should star t being inserted."
3394 },
3395 "data": {
3396 "description": "The data to insert.",
3397 "type": "string"
3398 },
3399 "delimiter": {
3400 "description": "The delimiter in the data.",
3401 "type": "string"
3402 },
3403 "type": {
3404 "description": "How the data should be pasted.",
3405 "enum": [
3406 "PASTE_NORMAL",
3407 "PASTE_VALUES",
3408 "PASTE_FORMAT",
3409 "PASTE_NO_BORDERS",
3410 "PASTE_FORMULA",
3411 "PASTE_DATA_VALIDATION",
3412 "PASTE_CONDITIONAL_FORMATTING"
3413 ],
3414 "enumDescriptions": [
3415 "Paste values, formulas, formats, and merges.",
3416 "Paste the values ONLY without formats, formulas, or mer ges.",
3417 "Paste the format and data validation only.",
3418 "Like PASTE_NORMAL but without borders.",
3419 "Paste the formulas only.",
3420 "Paste the data validation only.",
3421 "Paste the conditional formatting rules only."
3422 ],
3423 "type": "string"
3424 },
3425 "html": {
3426 "description": "True if the data is HTML.",
3427 "type": "boolean"
3428 }
3429 },
3430 "type": "object"
3431 },
3432 "AppendDimensionRequest": {
3433 "description": "Appends rows or columns to the end of a sheet.",
3434 "id": "AppendDimensionRequest",
3435 "properties": {
3436 "dimension": {
3437 "description": "Whether rows or columns should be appended." ,
3438 "enum": [
3439 "DIMENSION_UNSPECIFIED",
3440 "ROWS",
3441 "COLUMNS"
3442 ],
3443 "enumDescriptions": [
3444 "The default value, do not use.",
3445 "Operates on the rows of a sheet.",
3446 "Operates on the columns of a sheet."
3447 ],
3448 "type": "string"
3449 }, 2966 },
3450 "length": { 2967 "length": {
3451 "description": "The number of rows or columns to append.", 2968 "description": "The number of rows or columns to append.",
3452 "format": "int32", 2969 "format": "int32",
3453 "type": "integer" 2970 "type": "integer"
3454 },
3455 "sheetId": {
3456 "description": "The sheet to append rows or columns to.",
3457 "format": "int32",
3458 "type": "integer"
3459 } 2971 }
3460 }, 2972 },
3461 "type": "object" 2973 "type": "object"
3462 }, 2974 },
3463 "AddNamedRangeRequest": { 2975 "AddNamedRangeRequest": {
3464 "description": "Adds a named range to the spreadsheet.", 2976 "description": "Adds a named range to the spreadsheet.",
3465 "id": "AddNamedRangeRequest", 2977 "id": "AddNamedRangeRequest",
3466 "properties": { 2978 "properties": {
3467 "namedRange": { 2979 "namedRange": {
3468 "$ref": "NamedRange", 2980 "$ref": "NamedRange",
3469 "description": "The named range to add. The namedRangeId\nfi eld 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.)" 2981 "description": "The named range to add. The namedRangeId\nfi eld 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.)"
3470 } 2982 }
3471 }, 2983 },
3472 "type": "object" 2984 "type": "object"
3473 }, 2985 },
3474 "UpdateEmbeddedObjectPositionRequest": { 2986 "UpdateEmbeddedObjectPositionRequest": {
3475 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).", 2987 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
3476 "id": "UpdateEmbeddedObjectPositionRequest", 2988 "id": "UpdateEmbeddedObjectPositionRequest",
3477 "properties": { 2989 "properties": {
3478 "fields": {
3479 "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.",
3480 "format": "google-fieldmask",
3481 "type": "string"
3482 },
3483 "objectId": { 2990 "objectId": {
3484 "description": "The ID of the object to moved.", 2991 "description": "The ID of the object to moved.",
3485 "format": "int32", 2992 "format": "int32",
3486 "type": "integer" 2993 "type": "integer"
3487 }, 2994 },
3488 "newPosition": { 2995 "newPosition": {
3489 "$ref": "EmbeddedObjectPosition", 2996 "$ref": "EmbeddedObjectPosition",
3490 "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." 2997 "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."
2998 },
2999 "fields": {
3000 "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.",
3001 "format": "google-fieldmask",
3002 "type": "string"
3491 } 3003 }
3492 }, 3004 },
3493 "type": "object" 3005 "type": "object"
3494 }, 3006 },
3495 "TextRotation": { 3007 "TextRotation": {
3496 "description": "The rotation applied to text in a cell.", 3008 "description": "The rotation applied to text in a cell.",
3497 "id": "TextRotation", 3009 "id": "TextRotation",
3498 "properties": { 3010 "properties": {
3011 "vertical": {
3012 "description": "If true, text reads top to bottom, but the o rientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
3013 "type": "boolean"
3014 },
3499 "angle": { 3015 "angle": {
3500 "description": "The angle between the standard orientation a nd the desired orientation.\nMeasured in degrees. Valid values are between -90 a nd 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNo te: For LTR text direction positive angles are in the counterclockwise\ndirectio n, whereas for RTL they are in the clockwise direction", 3016 "description": "The angle between the standard orientation a nd the desired orientation.\nMeasured in degrees. Valid values are between -90 a nd 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNo te: For LTR text direction positive angles are in the counterclockwise\ndirectio n, whereas for RTL they are in the clockwise direction",
3501 "format": "int32", 3017 "format": "int32",
3502 "type": "integer" 3018 "type": "integer"
3503 },
3504 "vertical": {
3505 "description": "If true, text reads top to bottom, but the o rientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
3506 "type": "boolean"
3507 } 3019 }
3508 }, 3020 },
3509 "type": "object" 3021 "type": "object"
3510 }, 3022 },
3511 "PieChartSpec": { 3023 "PieChartSpec": {
3512 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.", 3024 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.",
3513 "id": "PieChartSpec", 3025 "id": "PieChartSpec",
3514 "properties": { 3026 "properties": {
3515 "domain": {
3516 "$ref": "ChartData",
3517 "description": "The data that covers the domain of the pie c hart."
3518 },
3519 "threeDimensional": {
3520 "description": "True if the pie is three dimensional.",
3521 "type": "boolean"
3522 },
3523 "series": { 3027 "series": {
3524 "$ref": "ChartData", 3028 "$ref": "ChartData",
3525 "description": "The data that covers the one and only series of the pie chart." 3029 "description": "The data that covers the one and only series of the pie chart."
3526 }, 3030 },
3527 "legendPosition": { 3031 "legendPosition": {
3528 "description": "Where the legend of the pie chart should be drawn.", 3032 "description": "Where the legend of the pie chart should be drawn.",
3529 "enum": [ 3033 "enum": [
3530 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED", 3034 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
3531 "BOTTOM_LEGEND", 3035 "BOTTOM_LEGEND",
3532 "LEFT_LEGEND", 3036 "LEFT_LEGEND",
(...skipping 10 matching lines...) Expand all
3543 "The legend is rendered on the top of the chart.", 3047 "The legend is rendered on the top of the chart.",
3544 "No legend is rendered.", 3048 "No legend is rendered.",
3545 "Each pie slice has a label attached to it." 3049 "Each pie slice has a label attached to it."
3546 ], 3050 ],
3547 "type": "string" 3051 "type": "string"
3548 }, 3052 },
3549 "pieHole": { 3053 "pieHole": {
3550 "description": "The size of the hole in the pie chart.", 3054 "description": "The size of the hole in the pie chart.",
3551 "format": "double", 3055 "format": "double",
3552 "type": "number" 3056 "type": "number"
3057 },
3058 "domain": {
3059 "$ref": "ChartData",
3060 "description": "The data that covers the domain of the pie c hart."
3061 },
3062 "threeDimensional": {
3063 "description": "True if the pie is three dimensional.",
3064 "type": "boolean"
3553 } 3065 }
3554 }, 3066 },
3555 "type": "object" 3067 "type": "object"
3556 }, 3068 },
3557 "UpdateFilterViewRequest": { 3069 "UpdateFilterViewRequest": {
3558 "description": "Updates properties of the filter view.", 3070 "description": "Updates properties of the filter view.",
3559 "id": "UpdateFilterViewRequest", 3071 "id": "UpdateFilterViewRequest",
3560 "properties": { 3072 "properties": {
3561 "filter": { 3073 "filter": {
3562 "$ref": "FilterView", 3074 "$ref": "FilterView",
3563 "description": "The new properties of the filter view." 3075 "description": "The new properties of the filter view."
3564 }, 3076 },
3565 "fields": { 3077 "fields": {
3566 "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be sp ecified.\nA single `\"*\"` can be used as short-hand for listing every field.", 3078 "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be sp ecified.\nA single `\"*\"` can be used as short-hand for listing every field.",
3567 "format": "google-fieldmask", 3079 "format": "google-fieldmask",
3568 "type": "string" 3080 "type": "string"
3569 } 3081 }
3570 }, 3082 },
3571 "type": "object" 3083 "type": "object"
3572 }, 3084 },
3573 "ConditionalFormatRule": { 3085 "ConditionalFormatRule": {
3574 "description": "A rule describing a conditional format.", 3086 "description": "A rule describing a conditional format.",
3575 "id": "ConditionalFormatRule", 3087 "id": "ConditionalFormatRule",
3576 "properties": { 3088 "properties": {
3089 "gradientRule": {
3090 "$ref": "GradientRule",
3091 "description": "The formatting will vary based on the gradie nts in the rule."
3092 },
3093 "booleanRule": {
3094 "$ref": "BooleanRule",
3095 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
3096 },
3577 "ranges": { 3097 "ranges": {
3578 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.", 3098 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.",
3579 "items": { 3099 "items": {
3580 "$ref": "GridRange" 3100 "$ref": "GridRange"
3581 }, 3101 },
3582 "type": "array" 3102 "type": "array"
3583 },
3584 "gradientRule": {
3585 "$ref": "GradientRule",
3586 "description": "The formatting will vary based on the gradie nts in the rule."
3587 },
3588 "booleanRule": {
3589 "$ref": "BooleanRule",
3590 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
3591 } 3103 }
3592 }, 3104 },
3593 "type": "object" 3105 "type": "object"
3594 }, 3106 },
3595 "CopyPasteRequest": { 3107 "CopyPasteRequest": {
3596 "description": "Copies data from the source to the destination.", 3108 "description": "Copies data from the source to the destination.",
3597 "id": "CopyPasteRequest", 3109 "id": "CopyPasteRequest",
3598 "properties": { 3110 "properties": {
3111 "destination": {
3112 "$ref": "GridRange",
3113 "description": "The location to paste to. If the range cover s a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of t he destination range)."
3114 },
3115 "pasteOrientation": {
3116 "description": "How that data should be oriented when pastin g.",
3117 "enum": [
3118 "NORMAL",
3119 "TRANSPOSE"
3120 ],
3121 "enumDescriptions": [
3122 "Paste normally.",
3123 "Paste transposed, where all rows become columns and vic e versa."
3124 ],
3125 "type": "string"
3126 },
3599 "source": { 3127 "source": {
3600 "$ref": "GridRange", 3128 "$ref": "GridRange",
3601 "description": "The source range to copy." 3129 "description": "The source range to copy."
3602 }, 3130 },
3603 "pasteType": { 3131 "pasteType": {
3604 "description": "What kind of data to paste.", 3132 "description": "What kind of data to paste.",
3605 "enum": [ 3133 "enum": [
3606 "PASTE_NORMAL", 3134 "PASTE_NORMAL",
3607 "PASTE_VALUES", 3135 "PASTE_VALUES",
3608 "PASTE_FORMAT", 3136 "PASTE_FORMAT",
3609 "PASTE_NO_BORDERS", 3137 "PASTE_NO_BORDERS",
3610 "PASTE_FORMULA", 3138 "PASTE_FORMULA",
3611 "PASTE_DATA_VALIDATION", 3139 "PASTE_DATA_VALIDATION",
3612 "PASTE_CONDITIONAL_FORMATTING" 3140 "PASTE_CONDITIONAL_FORMATTING"
3613 ], 3141 ],
3614 "enumDescriptions": [ 3142 "enumDescriptions": [
3615 "Paste values, formulas, formats, and merges.", 3143 "Paste values, formulas, formats, and merges.",
3616 "Paste the values ONLY without formats, formulas, or mer ges.", 3144 "Paste the values ONLY without formats, formulas, or mer ges.",
3617 "Paste the format and data validation only.", 3145 "Paste the format and data validation only.",
3618 "Like PASTE_NORMAL but without borders.", 3146 "Like PASTE_NORMAL but without borders.",
3619 "Paste the formulas only.", 3147 "Paste the formulas only.",
3620 "Paste the data validation only.", 3148 "Paste the data validation only.",
3621 "Paste the conditional formatting rules only." 3149 "Paste the conditional formatting rules only."
3622 ], 3150 ],
3623 "type": "string" 3151 "type": "string"
3624 }, 3152 }
3625 "destination": { 3153 },
3626 "$ref": "GridRange", 3154 "type": "object"
3627 "description": "The location to paste to. If the range cover s a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of t he destination range)." 3155 },
3628 }, 3156 "Request": {
3629 "pasteOrientation": { 3157 "description": "A single kind of update to apply to a spreadsheet.",
3630 "description": "How that data should be oriented when pastin g.", 3158 "id": "Request",
3631 "enum": [ 3159 "properties": {
3632 "NORMAL", 3160 "moveDimension": {
3633 "TRANSPOSE" 3161 "$ref": "MoveDimensionRequest",
3634 ], 3162 "description": "Moves rows or columns to another location in a sheet."
3635 "enumDescriptions": [ 3163 },
3636 "Paste normally.", 3164 "updateBanding": {
3637 "Paste transposed, where all rows become columns and vic e versa." 3165 "$ref": "UpdateBandingRequest",
3638 ], 3166 "description": "Updates a banded range"
3639 "type": "string" 3167 },
3640 } 3168 "addProtectedRange": {
3641 }, 3169 "$ref": "AddProtectedRangeRequest",
3642 "type": "object" 3170 "description": "Adds a protected range."
3171 },
3172 "deleteNamedRange": {
3173 "$ref": "DeleteNamedRangeRequest",
3174 "description": "Deletes a named range."
3175 },
3176 "duplicateSheet": {
3177 "$ref": "DuplicateSheetRequest",
3178 "description": "Duplicates a sheet."
3179 },
3180 "deleteSheet": {
3181 "$ref": "DeleteSheetRequest",
3182 "description": "Deletes a sheet."
3183 },
3184 "unmergeCells": {
3185 "$ref": "UnmergeCellsRequest",
3186 "description": "Unmerges merged cells."
3187 },
3188 "updateEmbeddedObjectPosition": {
3189 "$ref": "UpdateEmbeddedObjectPositionRequest",
3190 "description": "Updates an embedded object's (e.g. chart, im age) position."
3191 },
3192 "updateDimensionProperties": {
3193 "$ref": "UpdateDimensionPropertiesRequest",
3194 "description": "Updates dimensions' properties."
3195 },
3196 "pasteData": {
3197 "$ref": "PasteDataRequest",
3198 "description": "Pastes data (HTML or delimited) into a sheet ."
3199 },
3200 "setBasicFilter": {
3201 "$ref": "SetBasicFilterRequest",
3202 "description": "Sets the basic filter on a sheet."
3203 },
3204 "addConditionalFormatRule": {
3205 "$ref": "AddConditionalFormatRuleRequest",
3206 "description": "Adds a new conditional format rule."
3207 },
3208 "updateCells": {
3209 "$ref": "UpdateCellsRequest",
3210 "description": "Updates many cells at once."
3211 },
3212 "addNamedRange": {
3213 "$ref": "AddNamedRangeRequest",
3214 "description": "Adds a named range."
3215 },
3216 "updateSpreadsheetProperties": {
3217 "$ref": "UpdateSpreadsheetPropertiesRequest",
3218 "description": "Updates the spreadsheet's properties."
3219 },
3220 "deleteEmbeddedObject": {
3221 "$ref": "DeleteEmbeddedObjectRequest",
3222 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
3223 },
3224 "updateFilterView": {
3225 "$ref": "UpdateFilterViewRequest",
3226 "description": "Updates the properties of a filter view."
3227 },
3228 "addBanding": {
3229 "$ref": "AddBandingRequest",
3230 "description": "Adds a new banded range"
3231 },
3232 "autoResizeDimensions": {
3233 "$ref": "AutoResizeDimensionsRequest",
3234 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
3235 },
3236 "appendCells": {
3237 "$ref": "AppendCellsRequest",
3238 "description": "Appends cells after the last row with data i n a sheet."
3239 },
3240 "cutPaste": {
3241 "$ref": "CutPasteRequest",
3242 "description": "Cuts data from one area and pastes it to ano ther."
3243 },
3244 "mergeCells": {
3245 "$ref": "MergeCellsRequest",
3246 "description": "Merges cells together."
3247 },
3248 "updateNamedRange": {
3249 "$ref": "UpdateNamedRangeRequest",
3250 "description": "Updates a named range."
3251 },
3252 "updateSheetProperties": {
3253 "$ref": "UpdateSheetPropertiesRequest",
3254 "description": "Updates a sheet's properties."
3255 },
3256 "autoFill": {
3257 "$ref": "AutoFillRequest",
3258 "description": "Automatically fills in more data based on ex isting data."
3259 },
3260 "deleteDimension": {
3261 "$ref": "DeleteDimensionRequest",
3262 "description": "Deletes rows or columns in a sheet."
3263 },
3264 "sortRange": {
3265 "$ref": "SortRangeRequest",
3266 "description": "Sorts data in a range."
3267 },
3268 "deleteProtectedRange": {
3269 "$ref": "DeleteProtectedRangeRequest",
3270 "description": "Deletes a protected range."
3271 },
3272 "duplicateFilterView": {
3273 "$ref": "DuplicateFilterViewRequest",
3274 "description": "Duplicates a filter view."
3275 },
3276 "addChart": {
3277 "$ref": "AddChartRequest",
3278 "description": "Adds a chart."
3279 },
3280 "findReplace": {
3281 "$ref": "FindReplaceRequest",
3282 "description": "Finds and replaces occurrences of some text with other text."
3283 },
3284 "textToColumns": {
3285 "$ref": "TextToColumnsRequest",
3286 "description": "Converts a column of text into many columns of text."
3287 },
3288 "updateChartSpec": {
3289 "$ref": "UpdateChartSpecRequest",
3290 "description": "Updates a chart's specifications."
3291 },
3292 "updateProtectedRange": {
3293 "$ref": "UpdateProtectedRangeRequest",
3294 "description": "Updates a protected range."
3295 },
3296 "addSheet": {
3297 "$ref": "AddSheetRequest",
3298 "description": "Adds a sheet."
3299 },
3300 "copyPaste": {
3301 "$ref": "CopyPasteRequest",
3302 "description": "Copies data from one area and pastes it to a nother."
3303 },
3304 "deleteFilterView": {
3305 "$ref": "DeleteFilterViewRequest",
3306 "description": "Deletes a filter view from a sheet."
3307 },
3308 "insertDimension": {
3309 "$ref": "InsertDimensionRequest",
3310 "description": "Inserts new rows or columns in a sheet."
3311 },
3312 "deleteRange": {
3313 "$ref": "DeleteRangeRequest",
3314 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
3315 },
3316 "deleteBanding": {
3317 "$ref": "DeleteBandingRequest",
3318 "description": "Removes a banded range"
3319 },
3320 "addFilterView": {
3321 "$ref": "AddFilterViewRequest",
3322 "description": "Adds a filter view."
3323 },
3324 "updateBorders": {
3325 "$ref": "UpdateBordersRequest",
3326 "description": "Updates the borders in a range of cells."
3327 },
3328 "setDataValidation": {
3329 "$ref": "SetDataValidationRequest",
3330 "description": "Sets data validation for one or more cells."
3331 },
3332 "deleteConditionalFormatRule": {
3333 "$ref": "DeleteConditionalFormatRuleRequest",
3334 "description": "Deletes an existing conditional format rule. "
3335 },
3336 "clearBasicFilter": {
3337 "$ref": "ClearBasicFilterRequest",
3338 "description": "Clears the basic filter on a sheet."
3339 },
3340 "repeatCell": {
3341 "$ref": "RepeatCellRequest",
3342 "description": "Repeats a single cell across a range."
3343 },
3344 "appendDimension": {
3345 "$ref": "AppendDimensionRequest",
3346 "description": "Appends dimensions to the end of a sheet."
3347 },
3348 "updateConditionalFormatRule": {
3349 "$ref": "UpdateConditionalFormatRuleRequest",
3350 "description": "Updates an existing conditional format rule. "
3351 },
3352 "insertRange": {
3353 "$ref": "InsertRangeRequest",
3354 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
3355 }
3356 },
3357 "type": "object"
3643 }, 3358 },
3644 "BooleanCondition": { 3359 "BooleanCondition": {
3645 "description": "A condition that can evaluate to true or false.\nBoo leanConditions are used by conditional formatting,\ndata validation, and the cri teria in filters.", 3360 "description": "A condition that can evaluate to true or false.\nBoo leanConditions are used by conditional formatting,\ndata validation, and the cri teria in filters.",
3646 "id": "BooleanCondition", 3361 "id": "BooleanCondition",
3647 "properties": { 3362 "properties": {
3648 "type": { 3363 "type": {
3649 "description": "The type of condition.", 3364 "description": "The type of condition.",
3650 "enum": [ 3365 "enum": [
3651 "CONDITION_TYPE_UNSPECIFIED", 3366 "CONDITION_TYPE_UNSPECIFIED",
3652 "NUMBER_GREATER", 3367 "NUMBER_GREATER",
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after
3714 "values": { 3429 "values": {
3715 "description": "The values of the condition. The number of s upported values depends\non the condition type. Some support zero values,\nothe rs one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary numbe r of values.", 3430 "description": "The values of the condition. The number of s upported values depends\non the condition type. Some support zero values,\nothe rs one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary numbe r of values.",
3716 "items": { 3431 "items": {
3717 "$ref": "ConditionValue" 3432 "$ref": "ConditionValue"
3718 }, 3433 },
3719 "type": "array" 3434 "type": "array"
3720 } 3435 }
3721 }, 3436 },
3722 "type": "object" 3437 "type": "object"
3723 }, 3438 },
3724 "Request": {
3725 "description": "A single kind of update to apply to a spreadsheet.",
3726 "id": "Request",
3727 "properties": {
3728 "moveDimension": {
3729 "$ref": "MoveDimensionRequest",
3730 "description": "Moves rows or columns to another location in a sheet."
3731 },
3732 "updateBanding": {
3733 "$ref": "UpdateBandingRequest",
3734 "description": "Updates a banded range"
3735 },
3736 "deleteNamedRange": {
3737 "$ref": "DeleteNamedRangeRequest",
3738 "description": "Deletes a named range."
3739 },
3740 "addProtectedRange": {
3741 "$ref": "AddProtectedRangeRequest",
3742 "description": "Adds a protected range."
3743 },
3744 "duplicateSheet": {
3745 "$ref": "DuplicateSheetRequest",
3746 "description": "Duplicates a sheet."
3747 },
3748 "unmergeCells": {
3749 "$ref": "UnmergeCellsRequest",
3750 "description": "Unmerges merged cells."
3751 },
3752 "deleteSheet": {
3753 "$ref": "DeleteSheetRequest",
3754 "description": "Deletes a sheet."
3755 },
3756 "updateEmbeddedObjectPosition": {
3757 "$ref": "UpdateEmbeddedObjectPositionRequest",
3758 "description": "Updates an embedded object's (e.g. chart, im age) position."
3759 },
3760 "updateDimensionProperties": {
3761 "$ref": "UpdateDimensionPropertiesRequest",
3762 "description": "Updates dimensions' properties."
3763 },
3764 "pasteData": {
3765 "$ref": "PasteDataRequest",
3766 "description": "Pastes data (HTML or delimited) into a sheet ."
3767 },
3768 "setBasicFilter": {
3769 "$ref": "SetBasicFilterRequest",
3770 "description": "Sets the basic filter on a sheet."
3771 },
3772 "addConditionalFormatRule": {
3773 "$ref": "AddConditionalFormatRuleRequest",
3774 "description": "Adds a new conditional format rule."
3775 },
3776 "updateCells": {
3777 "$ref": "UpdateCellsRequest",
3778 "description": "Updates many cells at once."
3779 },
3780 "addNamedRange": {
3781 "$ref": "AddNamedRangeRequest",
3782 "description": "Adds a named range."
3783 },
3784 "updateSpreadsheetProperties": {
3785 "$ref": "UpdateSpreadsheetPropertiesRequest",
3786 "description": "Updates the spreadsheet's properties."
3787 },
3788 "deleteEmbeddedObject": {
3789 "$ref": "DeleteEmbeddedObjectRequest",
3790 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
3791 },
3792 "updateFilterView": {
3793 "$ref": "UpdateFilterViewRequest",
3794 "description": "Updates the properties of a filter view."
3795 },
3796 "addBanding": {
3797 "$ref": "AddBandingRequest",
3798 "description": "Adds a new banded range"
3799 },
3800 "appendCells": {
3801 "$ref": "AppendCellsRequest",
3802 "description": "Appends cells after the last row with data i n a sheet."
3803 },
3804 "autoResizeDimensions": {
3805 "$ref": "AutoResizeDimensionsRequest",
3806 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
3807 },
3808 "cutPaste": {
3809 "$ref": "CutPasteRequest",
3810 "description": "Cuts data from one area and pastes it to ano ther."
3811 },
3812 "mergeCells": {
3813 "$ref": "MergeCellsRequest",
3814 "description": "Merges cells together."
3815 },
3816 "updateNamedRange": {
3817 "$ref": "UpdateNamedRangeRequest",
3818 "description": "Updates a named range."
3819 },
3820 "updateSheetProperties": {
3821 "$ref": "UpdateSheetPropertiesRequest",
3822 "description": "Updates a sheet's properties."
3823 },
3824 "autoFill": {
3825 "$ref": "AutoFillRequest",
3826 "description": "Automatically fills in more data based on ex isting data."
3827 },
3828 "deleteDimension": {
3829 "$ref": "DeleteDimensionRequest",
3830 "description": "Deletes rows or columns in a sheet."
3831 },
3832 "sortRange": {
3833 "$ref": "SortRangeRequest",
3834 "description": "Sorts data in a range."
3835 },
3836 "deleteProtectedRange": {
3837 "$ref": "DeleteProtectedRangeRequest",
3838 "description": "Deletes a protected range."
3839 },
3840 "duplicateFilterView": {
3841 "$ref": "DuplicateFilterViewRequest",
3842 "description": "Duplicates a filter view."
3843 },
3844 "addChart": {
3845 "$ref": "AddChartRequest",
3846 "description": "Adds a chart."
3847 },
3848 "findReplace": {
3849 "$ref": "FindReplaceRequest",
3850 "description": "Finds and replaces occurrences of some text with other text."
3851 },
3852 "textToColumns": {
3853 "$ref": "TextToColumnsRequest",
3854 "description": "Converts a column of text into many columns of text."
3855 },
3856 "updateChartSpec": {
3857 "$ref": "UpdateChartSpecRequest",
3858 "description": "Updates a chart's specifications."
3859 },
3860 "addSheet": {
3861 "$ref": "AddSheetRequest",
3862 "description": "Adds a sheet."
3863 },
3864 "updateProtectedRange": {
3865 "$ref": "UpdateProtectedRangeRequest",
3866 "description": "Updates a protected range."
3867 },
3868 "deleteFilterView": {
3869 "$ref": "DeleteFilterViewRequest",
3870 "description": "Deletes a filter view from a sheet."
3871 },
3872 "copyPaste": {
3873 "$ref": "CopyPasteRequest",
3874 "description": "Copies data from one area and pastes it to a nother."
3875 },
3876 "insertDimension": {
3877 "$ref": "InsertDimensionRequest",
3878 "description": "Inserts new rows or columns in a sheet."
3879 },
3880 "deleteRange": {
3881 "$ref": "DeleteRangeRequest",
3882 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
3883 },
3884 "deleteBanding": {
3885 "$ref": "DeleteBandingRequest",
3886 "description": "Removes a banded range"
3887 },
3888 "addFilterView": {
3889 "$ref": "AddFilterViewRequest",
3890 "description": "Adds a filter view."
3891 },
3892 "updateBorders": {
3893 "$ref": "UpdateBordersRequest",
3894 "description": "Updates the borders in a range of cells."
3895 },
3896 "setDataValidation": {
3897 "$ref": "SetDataValidationRequest",
3898 "description": "Sets data validation for one or more cells."
3899 },
3900 "deleteConditionalFormatRule": {
3901 "$ref": "DeleteConditionalFormatRuleRequest",
3902 "description": "Deletes an existing conditional format rule. "
3903 },
3904 "repeatCell": {
3905 "$ref": "RepeatCellRequest",
3906 "description": "Repeats a single cell across a range."
3907 },
3908 "clearBasicFilter": {
3909 "$ref": "ClearBasicFilterRequest",
3910 "description": "Clears the basic filter on a sheet."
3911 },
3912 "appendDimension": {
3913 "$ref": "AppendDimensionRequest",
3914 "description": "Appends dimensions to the end of a sheet."
3915 },
3916 "updateConditionalFormatRule": {
3917 "$ref": "UpdateConditionalFormatRuleRequest",
3918 "description": "Updates an existing conditional format rule. "
3919 },
3920 "insertRange": {
3921 "$ref": "InsertRangeRequest",
3922 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
3923 }
3924 },
3925 "type": "object"
3926 },
3927 "GridRange": { 3439 "GridRange": {
3928 "description": "A range on a sheet.\nAll indexes are zero-based.\nIn dexes are half open, e.g the start index is inclusive\nand the end index is excl usive -- [start_index, end_index).\nMissing indexes indicate the range is unboun ded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `She et1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A 3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\n The start index must always be less than or equal to the end index.\nIf the star t index equals the end index, then the range is empty.\nEmpty ranges are typical ly not meaningful and are usually rendered in the\nUI as `#REF!`.", 3440 "description": "A range on a sheet.\nAll indexes are zero-based.\nIn dexes are half open, e.g the start index is inclusive\nand the end index is excl usive -- [start_index, end_index).\nMissing indexes indicate the range is unboun ded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `She et1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A 3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\n The start index must always be less than or equal to the end index.\nIf the star t index equals the end index, then the range is empty.\nEmpty ranges are typical ly not meaningful and are usually rendered in the\nUI as `#REF!`.",
3929 "id": "GridRange", 3441 "id": "GridRange",
3930 "properties": { 3442 "properties": {
3931 "endRowIndex": { 3443 "endRowIndex": {
3932 "description": "The end row (exclusive) of the range, or not set if unbounded.", 3444 "description": "The end row (exclusive) of the range, or not set if unbounded.",
3933 "format": "int32", 3445 "format": "int32",
3934 "type": "integer" 3446 "type": "integer"
3935 }, 3447 },
3936 "endColumnIndex": { 3448 "endColumnIndex": {
(...skipping 16 matching lines...) Expand all
3953 "format": "int32", 3465 "format": "int32",
3954 "type": "integer" 3466 "type": "integer"
3955 } 3467 }
3956 }, 3468 },
3957 "type": "object" 3469 "type": "object"
3958 }, 3470 },
3959 "BasicChartSpec": { 3471 "BasicChartSpec": {
3960 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.", 3472 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.",
3961 "id": "BasicChartSpec", 3473 "id": "BasicChartSpec",
3962 "properties": { 3474 "properties": {
3963 "legendPosition": {
3964 "description": "The position of the chart legend.",
3965 "enum": [
3966 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
3967 "BOTTOM_LEGEND",
3968 "LEFT_LEGEND",
3969 "RIGHT_LEGEND",
3970 "TOP_LEGEND",
3971 "NO_LEGEND"
3972 ],
3973 "enumDescriptions": [
3974 "Default value, do not use.",
3975 "The legend is rendered on the bottom of the chart.",
3976 "The legend is rendered on the left of the chart.",
3977 "The legend is rendered on the right of the chart.",
3978 "The legend is rendered on the top of the chart.",
3979 "No legend is rendered."
3980 ],
3981 "type": "string"
3982 },
3983 "domains": {
3984 "description": "The domain of data this is charting.\nOnly a single domain is currently supported.",
3985 "items": {
3986 "$ref": "BasicChartDomain"
3987 },
3988 "type": "array"
3989 },
3990 "headerCount": { 3475 "headerCount": {
3991 "description": "The number of rows or columns in the data th at are \"headers\".\nIf not set, Google Sheets will guess how many rows are head ers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)", 3476 "description": "The number of rows or columns in the data th at are \"headers\".\nIf not set, Google Sheets will guess how many rows are head ers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
3992 "format": "int32", 3477 "format": "int32",
3993 "type": "integer" 3478 "type": "integer"
3994 }, 3479 },
3995 "axis": { 3480 "axis": {
3996 "description": "The axis on the chart.", 3481 "description": "The axis on the chart.",
3997 "items": { 3482 "items": {
3998 "$ref": "BasicChartAxis" 3483 "$ref": "BasicChartAxis"
3999 }, 3484 },
(...skipping 20 matching lines...) Expand all
4020 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>." 3505 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
4021 ], 3506 ],
4022 "type": "string" 3507 "type": "string"
4023 }, 3508 },
4024 "series": { 3509 "series": {
4025 "description": "The data this chart is visualizing.", 3510 "description": "The data this chart is visualizing.",
4026 "items": { 3511 "items": {
4027 "$ref": "BasicChartSeries" 3512 "$ref": "BasicChartSeries"
4028 }, 3513 },
4029 "type": "array" 3514 "type": "array"
3515 },
3516 "legendPosition": {
3517 "description": "The position of the chart legend.",
3518 "enum": [
3519 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
3520 "BOTTOM_LEGEND",
3521 "LEFT_LEGEND",
3522 "RIGHT_LEGEND",
3523 "TOP_LEGEND",
3524 "NO_LEGEND"
3525 ],
3526 "enumDescriptions": [
3527 "Default value, do not use.",
3528 "The legend is rendered on the bottom of the chart.",
3529 "The legend is rendered on the left of the chart.",
3530 "The legend is rendered on the right of the chart.",
3531 "The legend is rendered on the top of the chart.",
3532 "No legend is rendered."
3533 ],
3534 "type": "string"
3535 },
3536 "domains": {
3537 "description": "The domain of data this is charting.\nOnly a single domain is supported.",
3538 "items": {
3539 "$ref": "BasicChartDomain"
3540 },
3541 "type": "array"
4030 } 3542 }
4031 }, 3543 },
4032 "type": "object" 3544 "type": "object"
4033 }, 3545 },
4034 "SetDataValidationRequest": { 3546 "SetDataValidationRequest": {
4035 "description": "Sets a data validation rule to every cell in the ran ge.\nTo clear validation in a range, call this with no rule specified.", 3547 "description": "Sets a data validation rule to every cell in the ran ge.\nTo clear validation in a range, call this with no rule specified.",
4036 "id": "SetDataValidationRequest", 3548 "id": "SetDataValidationRequest",
4037 "properties": { 3549 "properties": {
4038 "rule": { 3550 "rule": {
4039 "$ref": "DataValidationRule", 3551 "$ref": "DataValidationRule",
(...skipping 19 matching lines...) Expand all
4059 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format." 3571 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
4060 }, 3572 },
4061 "note": { 3573 "note": {
4062 "description": "Any note on the cell.", 3574 "description": "Any note on the cell.",
4063 "type": "string" 3575 "type": "string"
4064 }, 3576 },
4065 "effectiveFormat": { 3577 "effectiveFormat": {
4066 "$ref": "CellFormat", 3578 "$ref": "CellFormat",
4067 "description": "The effective format being used by the cell. \nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read- only." 3579 "description": "The effective format being used by the cell. \nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read- only."
4068 }, 3580 },
3581 "dataValidation": {
3582 "$ref": "DataValidationRule",
3583 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
3584 },
4069 "userEnteredValue": { 3585 "userEnteredValue": {
4070 "$ref": "ExtendedValue", 3586 "$ref": "ExtendedValue",
4071 "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represente d as doubles in\nserial number format." 3587 "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represente d as doubles in\nserial number format."
4072 }, 3588 },
4073 "dataValidation": {
4074 "$ref": "DataValidationRule",
4075 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
4076 },
4077 "effectiveValue": { 3589 "effectiveValue": {
4078 "$ref": "ExtendedValue", 3590 "$ref": "ExtendedValue",
4079 "description": "The effective value of the cell. For cells w ith formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only." 3591 "description": "The effective value of the cell. For cells w ith formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only."
4080 }, 3592 },
4081 "formattedValue": { 3593 "formattedValue": {
4082 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.", 3594 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.",
4083 "type": "string" 3595 "type": "string"
4084 }, 3596 },
4085 "textFormatRuns": { 3597 "textFormatRuns": {
4086 "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the nex t\nrun. Properties of a run will continue unless explicitly changed\nin a subseq uent run (and properties of the first run will continue\nthe properties of the c ell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be eras ed.", 3598 "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the nex t\nrun. Properties of a run will continue unless explicitly changed\nin a subseq uent run (and properties of the first run will continue\nthe properties of the c ell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be eras ed.",
4087 "items": { 3599 "items": {
4088 "$ref": "TextFormatRun" 3600 "$ref": "TextFormatRun"
4089 }, 3601 },
4090 "type": "array" 3602 "type": "array"
4091 }, 3603 },
4092 "hyperlink": { 3604 "hyperlink": {
4093 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula.)", 3605 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula.)",
4094 "type": "string" 3606 "type": "string"
4095 } 3607 }
4096 }, 3608 },
4097 "type": "object" 3609 "type": "object"
4098 }, 3610 },
4099 "BatchUpdateSpreadsheetRequest": { 3611 "BatchUpdateSpreadsheetRequest": {
4100 "description": "The request for updating any aspect of a spreadsheet .", 3612 "description": "The request for updating any aspect of a spreadsheet .",
4101 "id": "BatchUpdateSpreadsheetRequest", 3613 "id": "BatchUpdateSpreadsheetRequest",
4102 "properties": { 3614 "properties": {
3615 "requests": {
3616 "description": "A list of updates to apply to the spreadshee t.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
3617 "items": {
3618 "$ref": "Request"
3619 },
3620 "type": "array"
3621 },
4103 "includeSpreadsheetInResponse": { 3622 "includeSpreadsheetInResponse": {
4104 "description": "Determines if the update response should inc lude the spreadsheet\nresource.", 3623 "description": "Determines if the update response should inc lude the spreadsheet\nresource.",
4105 "type": "boolean" 3624 "type": "boolean"
4106 }, 3625 },
4107 "responseRanges": { 3626 "responseRanges": {
4108 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.", 3627 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
4109 "items": { 3628 "items": {
4110 "type": "string" 3629 "type": "string"
4111 }, 3630 },
4112 "type": "array" 3631 "type": "array"
4113 }, 3632 },
4114 "responseIncludeGridData": { 3633 "responseIncludeGridData": {
4115 "description": "True if grid data should be returned. Meanin gful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is igno red if a field mask was set in the request.", 3634 "description": "True if grid data should be returned. Meanin gful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is igno red if a field mask was set in the request.",
4116 "type": "boolean" 3635 "type": "boolean"
4117 },
4118 "requests": {
4119 "description": "A list of updates to apply to the spreadshee t.",
4120 "items": {
4121 "$ref": "Request"
4122 },
4123 "type": "array"
4124 }
4125 },
4126 "type": "object"
4127 },
4128 "Padding": {
4129 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
4130 "id": "Padding",
4131 "properties": {
4132 "left": {
4133 "description": "The left padding of the cell.",
4134 "format": "int32",
4135 "type": "integer"
4136 },
4137 "right": {
4138 "description": "The right padding of the cell.",
4139 "format": "int32",
4140 "type": "integer"
4141 },
4142 "bottom": {
4143 "description": "The bottom padding of the cell.",
4144 "format": "int32",
4145 "type": "integer"
4146 },
4147 "top": {
4148 "description": "The top padding of the cell.",
4149 "format": "int32",
4150 "type": "integer"
4151 } 3636 }
4152 }, 3637 },
4153 "type": "object" 3638 "type": "object"
4154 }, 3639 },
4155 "BasicChartAxis": { 3640 "BasicChartAxis": {
4156 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.", 3641 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
4157 "id": "BasicChartAxis", 3642 "id": "BasicChartAxis",
4158 "properties": { 3643 "properties": {
4159 "position": { 3644 "position": {
4160 "description": "The position of this axis.", 3645 "description": "The position of this axis.",
(...skipping 15 matching lines...) Expand all
4176 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.", 3661 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.",
4177 "type": "string" 3662 "type": "string"
4178 }, 3663 },
4179 "format": { 3664 "format": {
4180 "$ref": "TextFormat", 3665 "$ref": "TextFormat",
4181 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain." 3666 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
4182 } 3667 }
4183 }, 3668 },
4184 "type": "object" 3669 "type": "object"
4185 }, 3670 },
3671 "Padding": {
3672 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
3673 "id": "Padding",
3674 "properties": {
3675 "top": {
3676 "description": "The top padding of the cell.",
3677 "format": "int32",
3678 "type": "integer"
3679 },
3680 "left": {
3681 "description": "The left padding of the cell.",
3682 "format": "int32",
3683 "type": "integer"
3684 },
3685 "right": {
3686 "description": "The right padding of the cell.",
3687 "format": "int32",
3688 "type": "integer"
3689 },
3690 "bottom": {
3691 "description": "The bottom padding of the cell.",
3692 "format": "int32",
3693 "type": "integer"
3694 }
3695 },
3696 "type": "object"
3697 },
4186 "DeleteDimensionRequest": { 3698 "DeleteDimensionRequest": {
4187 "description": "Deletes the dimensions from the sheet.", 3699 "description": "Deletes the dimensions from the sheet.",
4188 "id": "DeleteDimensionRequest", 3700 "id": "DeleteDimensionRequest",
4189 "properties": { 3701 "properties": {
4190 "range": { 3702 "range": {
4191 "$ref": "DimensionRange", 3703 "$ref": "DimensionRange",
4192 "description": "The dimensions to delete from the sheet." 3704 "description": "The dimensions to delete from the sheet."
4193 } 3705 }
4194 }, 3706 },
4195 "type": "object" 3707 "type": "object"
3708 },
3709 "UpdateChartSpecRequest": {
3710 "description": "Updates a chart's specifications.\n(This does not mo ve or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPosit ionRequest.)",
3711 "id": "UpdateChartSpecRequest",
3712 "properties": {
3713 "chartId": {
3714 "description": "The ID of the chart to update.",
3715 "format": "int32",
3716 "type": "integer"
3717 },
3718 "spec": {
3719 "$ref": "ChartSpec",
3720 "description": "The specification to apply to the chart."
3721 }
3722 },
3723 "type": "object"
3724 },
3725 "DeleteFilterViewRequest": {
3726 "description": "Deletes a particular filter view.",
3727 "id": "DeleteFilterViewRequest",
3728 "properties": {
3729 "filterId": {
3730 "description": "The ID of the filter to delete.",
3731 "format": "int32",
3732 "type": "integer"
3733 }
3734 },
3735 "type": "object"
3736 },
3737 "BatchUpdateValuesResponse": {
3738 "description": "The response when updating a range of values in a sp readsheet.",
3739 "id": "BatchUpdateValuesResponse",
3740 "properties": {
3741 "totalUpdatedRows": {
3742 "description": "The total number of rows where at least one cell in the row was updated.",
3743 "format": "int32",
3744 "type": "integer"
3745 },
3746 "responses": {
3747 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.",
3748 "items": {
3749 "$ref": "UpdateValuesResponse"
3750 },
3751 "type": "array"
3752 },
3753 "totalUpdatedSheets": {
3754 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.",
3755 "format": "int32",
3756 "type": "integer"
3757 },
3758 "totalUpdatedCells": {
3759 "description": "The total number of cells updated.",
3760 "format": "int32",
3761 "type": "integer"
3762 },
3763 "totalUpdatedColumns": {
3764 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
3765 "format": "int32",
3766 "type": "integer"
3767 },
3768 "spreadsheetId": {
3769 "description": "The spreadsheet the updates were applied to. ",
3770 "type": "string"
3771 }
3772 },
3773 "type": "object"
3774 },
3775 "SortRangeRequest": {
3776 "description": "Sorts data in rows based on a sort order per column. ",
3777 "id": "SortRangeRequest",
3778 "properties": {
3779 "range": {
3780 "$ref": "GridRange",
3781 "description": "The range to sort."
3782 },
3783 "sortSpecs": {
3784 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
3785 "items": {
3786 "$ref": "SortSpec"
3787 },
3788 "type": "array"
3789 }
3790 },
3791 "type": "object"
3792 },
3793 "MergeCellsRequest": {
3794 "description": "Merges all cells in the range.",
3795 "id": "MergeCellsRequest",
3796 "properties": {
3797 "mergeType": {
3798 "description": "How the cells should be merged.",
3799 "enum": [
3800 "MERGE_ALL",
3801 "MERGE_COLUMNS",
3802 "MERGE_ROWS"
3803 ],
3804 "enumDescriptions": [
3805 "Create a single merge from the range",
3806 "Create a merge for each column in the range",
3807 "Create a merge for each row in the range"
3808 ],
3809 "type": "string"
3810 },
3811 "range": {
3812 "$ref": "GridRange",
3813 "description": "The range of cells to merge."
3814 }
3815 },
3816 "type": "object"
3817 },
3818 "AddProtectedRangeRequest": {
3819 "description": "Adds a new protected range.",
3820 "id": "AddProtectedRangeRequest",
3821 "properties": {
3822 "protectedRange": {
3823 "$ref": "ProtectedRange",
3824 "description": "The protected range to be added. The\nprotec tedRangeId field is optional; if\none is not set, an id will be randomly generat ed. (It is an error to\nspecify the ID of a range that already exists.)"
3825 }
3826 },
3827 "type": "object"
3828 },
3829 "BatchClearValuesRequest": {
3830 "description": "The request for clearing more than one range of valu es in a spreadsheet.",
3831 "id": "BatchClearValuesRequest",
3832 "properties": {
3833 "ranges": {
3834 "description": "The ranges to clear, in A1 notation.",
3835 "items": {
3836 "type": "string"
3837 },
3838 "type": "array"
3839 }
3840 },
3841 "type": "object"
3842 },
3843 "DuplicateFilterViewResponse": {
3844 "description": "The result of a filter view being duplicated.",
3845 "id": "DuplicateFilterViewResponse",
3846 "properties": {
3847 "filter": {
3848 "$ref": "FilterView",
3849 "description": "The newly created filter."
3850 }
3851 },
3852 "type": "object"
3853 },
3854 "DuplicateSheetResponse": {
3855 "description": "The result of duplicating a sheet.",
3856 "id": "DuplicateSheetResponse",
3857 "properties": {
3858 "properties": {
3859 "$ref": "SheetProperties",
3860 "description": "The properties of the duplicate sheet."
3861 }
3862 },
3863 "type": "object"
3864 },
3865 "TextToColumnsRequest": {
3866 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.",
3867 "id": "TextToColumnsRequest",
3868 "properties": {
3869 "delimiter": {
3870 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.",
3871 "type": "string"
3872 },
3873 "source": {
3874 "$ref": "GridRange",
3875 "description": "The source data range. This must span exact ly one column."
3876 },
3877 "delimiterType": {
3878 "description": "The delimiter type to use.",
3879 "enum": [
3880 "DELIMITER_TYPE_UNSPECIFIED",
3881 "COMMA",
3882 "SEMICOLON",
3883 "PERIOD",
3884 "SPACE",
3885 "CUSTOM"
3886 ],
3887 "enumDescriptions": [
3888 "Default value. This value must not be used.",
3889 "\",\"",
3890 "\";\"",
3891 "\".\"",
3892 "\" \"",
3893 "A custom value as defined in delimiter."
3894 ],
3895 "type": "string"
3896 }
3897 },
3898 "type": "object"
3899 },
3900 "ClearBasicFilterRequest": {
3901 "description": "Clears the basic filter, if any exists on the sheet. ",
3902 "id": "ClearBasicFilterRequest",
3903 "properties": {
3904 "sheetId": {
3905 "description": "The sheet ID on which the basic filter shoul d be cleared.",
3906 "format": "int32",
3907 "type": "integer"
3908 }
3909 },
3910 "type": "object"
3911 },
3912 "BatchUpdateSpreadsheetResponse": {
3913 "description": "The reply for batch updating a spreadsheet.",
3914 "id": "BatchUpdateSpreadsheetResponse",
3915 "properties": {
3916 "spreadsheetId": {
3917 "description": "The spreadsheet the updates were applied to. ",
3918 "type": "string"
3919 },
3920 "replies": {
3921 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.",
3922 "items": {
3923 "$ref": "Response"
3924 },
3925 "type": "array"
3926 },
3927 "updatedSpreadsheet": {
3928 "$ref": "Spreadsheet",
3929 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`."
3930 }
3931 },
3932 "type": "object"
3933 },
3934 "DeleteBandingRequest": {
3935 "description": "Removes the banded range with the given ID from the spreadsheet.",
3936 "id": "DeleteBandingRequest",
3937 "properties": {
3938 "bandedRangeId": {
3939 "description": "The ID of the banded range to delete.",
3940 "format": "int32",
3941 "type": "integer"
3942 }
3943 },
3944 "type": "object"
3945 },
3946 "AppendValuesResponse": {
3947 "description": "The response when updating a range of values in a sp readsheet.",
3948 "id": "AppendValuesResponse",
3949 "properties": {
3950 "updates": {
3951 "$ref": "UpdateValuesResponse",
3952 "description": "Information about the updates that were appl ied."
3953 },
3954 "tableRange": {
3955 "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no t able was found.",
3956 "type": "string"
3957 },
3958 "spreadsheetId": {
3959 "description": "The spreadsheet the updates were applied to. ",
3960 "type": "string"
3961 }
3962 },
3963 "type": "object"
3964 },
3965 "MoveDimensionRequest": {
3966 "description": "Moves one or more rows or columns.",
3967 "id": "MoveDimensionRequest",
3968 "properties": {
3969 "destinationIndex": {
3970 "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is remove d\nfrom the grid. Existing data will be shifted down or right\n(depending on th e dimension) to make room for the moved dimensions.\nThe source dimensions are r emoved from the grid, so the\nthe data may end up in a different index than spec ified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\ "1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1. .3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5) .\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
3971 "format": "int32",
3972 "type": "integer"
3973 },
3974 "source": {
3975 "$ref": "DimensionRange",
3976 "description": "The source dimensions to move."
3977 }
3978 },
3979 "type": "object"
3980 },
3981 "PivotFilterCriteria": {
3982 "description": "Criteria for showing/hiding rows in a pivot table.",
3983 "id": "PivotFilterCriteria",
3984 "properties": {
3985 "visibleValues": {
3986 "description": "Values that should be included. Values not listed here are excluded.",
3987 "items": {
3988 "type": "string"
3989 },
3990 "type": "array"
3991 }
3992 },
3993 "type": "object"
3994 },
3995 "AddFilterViewRequest": {
3996 "description": "Adds a filter view.",
3997 "id": "AddFilterViewRequest",
3998 "properties": {
3999 "filter": {
4000 "$ref": "FilterView",
4001 "description": "The filter to add. The filterViewId\nfield i s optional; if one is not set, an id will be randomly generated. (It\nis an erro r to specify the ID of a filter that already exists.)"
4002 }
4003 },
4004 "type": "object"
4005 },
4006 "AddConditionalFormatRuleRequest": {
4007 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.",
4008 "id": "AddConditionalFormatRuleRequest",
4009 "properties": {
4010 "rule": {
4011 "$ref": "ConditionalFormatRule",
4012 "description": "The rule to add."
4013 },
4014 "index": {
4015 "description": "The zero-based index where the rule should b e inserted.",
4016 "format": "int32",
4017 "type": "integer"
4018 }
4019 },
4020 "type": "object"
4021 },
4022 "ChartSpec": {
4023 "description": "The specifications of a chart.",
4024 "id": "ChartSpec",
4025 "properties": {
4026 "basicChart": {
4027 "$ref": "BasicChartSpec",
4028 "description": "A basic chart specification, can be one of m any kinds of charts.\nSee BasicChartType for the list of all\ncharts this suppor ts."
4029 },
4030 "hiddenDimensionStrategy": {
4031 "description": "Determines how the charts will use hidden ro ws or columns.",
4032 "enum": [
4033 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
4034 "SKIP_HIDDEN_ROWS_AND_COLUMNS",
4035 "SKIP_HIDDEN_ROWS",
4036 "SKIP_HIDDEN_COLUMNS",
4037 "SHOW_ALL"
4038 ],
4039 "enumDescriptions": [
4040 "Default value, do not use.",
4041 "Charts will skip hidden rows and columns.",
4042 "Charts will skip hidden rows only.",
4043 "Charts will skip hidden columns only.",
4044 "Charts will not skip any hidden rows or columns."
4045 ],
4046 "type": "string"
4047 },
4048 "title": {
4049 "description": "The title of the chart.",
4050 "type": "string"
4051 },
4052 "pieChart": {
4053 "$ref": "PieChartSpec",
4054 "description": "A pie chart specification."
4055 }
4056 },
4057 "type": "object"
4058 },
4059 "NumberFormat": {
4060 "description": "The number format of a cell.",
4061 "id": "NumberFormat",
4062 "properties": {
4063 "type": {
4064 "description": "The type of the number format.\nWhen writing , this field must be set.",
4065 "enum": [
4066 "NUMBER_FORMAT_TYPE_UNSPECIFIED",
4067 "TEXT",
4068 "NUMBER",
4069 "PERCENT",
4070 "CURRENCY",
4071 "DATE",
4072 "TIME",
4073 "DATE_TIME",
4074 "SCIENTIFIC"
4075 ],
4076 "enumDescriptions": [
4077 "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
4078 "Text formatting, e.g `1000.12`",
4079 "Number formatting, e.g, `1,000.12`",
4080 "Percent formatting, e.g `10.12%`",
4081 "Currency formatting, e.g `$1,000.12`",
4082 "Date formatting, e.g `9/26/2008`",
4083 "Time formatting, e.g `3:59:00 PM`",
4084 "Date+Time formatting, e.g `9/26/08 15:59:00`",
4085 "Scientific number formatting, e.g `1.01E+03`"
4086 ],
4087 "type": "string"
4088 },
4089 "pattern": {
4090 "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/api/guides/for mats) for more\ninformation about the supported patterns.",
4091 "type": "string"
4092 }
4093 },
4094 "type": "object"
4095 },
4096 "SheetProperties": {
4097 "description": "Properties of a sheet.",
4098 "id": "SheetProperties",
4099 "properties": {
4100 "title": {
4101 "description": "The name of the sheet.",
4102 "type": "string"
4103 },
4104 "tabColor": {
4105 "$ref": "Color",
4106 "description": "The color of the tab in the UI."
4107 },
4108 "index": {
4109 "description": "The index of the sheet within the spreadshee t.\nWhen adding or updating sheet properties, if this field\nis excluded then th e sheet will be added or moved to the end\nof the sheet list. When updating shee t indices or inserting\nsheets, movement is considered in \"before the move\" in dexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ah ead of S2 the index would have to be set to 2. A sheet\nindex update request wil l be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
4110 "format": "int32",
4111 "type": "integer"
4112 },
4113 "sheetId": {
4114 "description": "The ID of the sheet. Must be non-negative.\n This field cannot be changed once set.",
4115 "format": "int32",
4116 "type": "integer"
4117 },
4118 "rightToLeft": {
4119 "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
4120 "type": "boolean"
4121 },
4122 "hidden": {
4123 "description": "True if the sheet is hidden in the UI, false if it's visible.",
4124 "type": "boolean"
4125 },
4126 "gridProperties": {
4127 "$ref": "GridProperties",
4128 "description": "Additional properties of the sheet if this s heet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid p roperties on non-grid sheets."
4129 },
4130 "sheetType": {
4131 "description": "The type of sheet. Defaults to GRID.\nThis f ield cannot be changed once set.",
4132 "enum": [
4133 "SHEET_TYPE_UNSPECIFIED",
4134 "GRID",
4135 "OBJECT"
4136 ],
4137 "enumDescriptions": [
4138 "Default value, do not use.",
4139 "The sheet is a grid.",
4140 "The sheet has no grid and instead has an object like a chart or image."
4141 ],
4142 "type": "string"
4143 }
4144 },
4145 "type": "object"
4146 },
4147 "UpdateDimensionPropertiesRequest": {
4148 "description": "Updates properties of dimensions within the specifie d range.",
4149 "id": "UpdateDimensionPropertiesRequest",
4150 "properties": {
4151 "range": {
4152 "$ref": "DimensionRange",
4153 "description": "The rows or columns to update."
4154 },
4155 "fields": {
4156 "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 .",
4157 "format": "google-fieldmask",
4158 "type": "string"
4159 },
4160 "properties": {
4161 "$ref": "DimensionProperties",
4162 "description": "Properties to update."
4163 }
4164 },
4165 "type": "object"
4166 },
4167 "SourceAndDestination": {
4168 "description": "A combination of a source range and how to extend th at source.",
4169 "id": "SourceAndDestination",
4170 "properties": {
4171 "fillLength": {
4172 "description": "The number of rows or columns that data shou ld be filled into.\nPositive numbers expand beyond the last row or last column\n of the source. Negative numbers expand before the first row\nor first column of the source.",
4173 "format": "int32",
4174 "type": "integer"
4175 },
4176 "source": {
4177 "$ref": "GridRange",
4178 "description": "The location of the data to use as the sourc e of the autofill."
4179 },
4180 "dimension": {
4181 "description": "The dimension that data should be filled int o.",
4182 "enum": [
4183 "DIMENSION_UNSPECIFIED",
4184 "ROWS",
4185 "COLUMNS"
4186 ],
4187 "enumDescriptions": [
4188 "The default value, do not use.",
4189 "Operates on the rows of a sheet.",
4190 "Operates on the columns of a sheet."
4191 ],
4192 "type": "string"
4193 }
4194 },
4195 "type": "object"
4196 } 4196 }
4197 }, 4197 },
4198 "servicePath": "", 4198 "servicePath": "",
4199 "title": "Google Sheets API", 4199 "title": "Google Sheets API",
4200 "version": "v4" 4200 "version": "v4"
4201 } 4201 }
OLDNEW
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/siteVerification__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698