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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 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/slides__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/spreadsheets": {
6 "description": "View and manage your spreadsheets in Google Drive"
7 },
8 "https://www.googleapis.com/auth/drive.file": { 5 "https://www.googleapis.com/auth/drive.file": {
9 "description": "View and manage Google Drive files and folde rs that you have opened or created with this app" 6 "description": "View and manage Google Drive files and folde rs that you have opened or created with this app"
10 }, 7 },
11 "https://www.googleapis.com/auth/drive": { 8 "https://www.googleapis.com/auth/drive": {
12 "description": "View and manage the files in your Google Dri ve" 9 "description": "View and manage the files in your Google Dri ve"
13 }, 10 },
14 "https://www.googleapis.com/auth/drive.readonly": { 11 "https://www.googleapis.com/auth/drive.readonly": {
15 "description": "View the files in your Google Drive" 12 "description": "View the files in your Google Drive"
16 }, 13 },
17 "https://www.googleapis.com/auth/spreadsheets.readonly": { 14 "https://www.googleapis.com/auth/spreadsheets.readonly": {
18 "description": "View your Google Spreadsheets" 15 "description": "View your Google Spreadsheets"
16 },
17 "https://www.googleapis.com/auth/spreadsheets": {
18 "description": "View and manage your spreadsheets in Google Drive"
19 } 19 }
20 } 20 }
21 } 21 }
22 }, 22 },
23 "basePath": "", 23 "basePath": "",
24 "baseUrl": "https://sheets.googleapis.com/", 24 "baseUrl": "https://sheets.googleapis.com/",
25 "batchPath": "batch", 25 "batchPath": "batch",
26 "canonicalName": "Sheets", 26 "canonicalName": "Sheets",
27 "description": "Reads and writes Google Sheets.", 27 "description": "Reads and writes Google Sheets.",
28 "discoveryVersion": "v1", 28 "discoveryVersion": "v1",
29 "documentationLink": "https://developers.google.com/sheets/", 29 "documentationLink": "https://developers.google.com/sheets/",
30 "icons": { 30 "icons": {
31 "x16": "http://www.google.com/images/icons/product/search-16.gif", 31 "x16": "http://www.google.com/images/icons/product/search-16.gif",
32 "x32": "http://www.google.com/images/icons/product/search-32.gif" 32 "x32": "http://www.google.com/images/icons/product/search-32.gif"
33 }, 33 },
34 "id": "sheets:v4", 34 "id": "sheets:v4",
35 "kind": "discovery#restDescription", 35 "kind": "discovery#restDescription",
36 "name": "sheets", 36 "name": "sheets",
37 "ownerDomain": "google.com", 37 "ownerDomain": "google.com",
38 "ownerName": "Google", 38 "ownerName": "Google",
39 "parameters": { 39 "parameters": {
40 "bearer_token": { 40 "fields": {
41 "description": "OAuth bearer token.", 41 "description": "Selector specifying which fields to include in a par tial response.",
42 "location": "query", 42 "location": "query",
43 "type": "string" 43 "type": "string"
44 }, 44 },
45 "oauth_token": {
46 "description": "OAuth 2.0 token for the current user.",
47 "location": "query",
48 "type": "string"
49 },
50 "upload_protocol": {
51 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
52 "location": "query",
53 "type": "string"
54 },
55 "prettyPrint": {
56 "default": "true",
57 "description": "Returns response with indentations and line breaks." ,
58 "location": "query",
59 "type": "boolean"
60 },
61 "uploadType": { 45 "uploadType": {
62 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 46 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
63 "location": "query", 47 "location": "query",
64 "type": "string" 48 "type": "string"
65 }, 49 },
66 "fields": {
67 "description": "Selector specifying which fields to include in a par tial response.",
68 "location": "query",
69 "type": "string"
70 },
71 "callback": {
72 "description": "JSONP",
73 "location": "query",
74 "type": "string"
75 },
76 "$.xgafv": { 50 "$.xgafv": {
77 "description": "V1 error format.", 51 "description": "V1 error format.",
78 "enum": [ 52 "enum": [
79 "1", 53 "1",
80 "2" 54 "2"
81 ], 55 ],
82 "enumDescriptions": [ 56 "enumDescriptions": [
83 "v1 error format", 57 "v1 error format",
84 "v2 error format" 58 "v2 error format"
85 ], 59 ],
86 "location": "query", 60 "location": "query",
87 "type": "string" 61 "type": "string"
88 }, 62 },
63 "callback": {
64 "description": "JSONP",
65 "location": "query",
66 "type": "string"
67 },
89 "alt": { 68 "alt": {
90 "default": "json", 69 "default": "json",
91 "description": "Data format for response.", 70 "description": "Data format for response.",
92 "enum": [ 71 "enum": [
93 "json", 72 "json",
94 "media", 73 "media",
95 "proto" 74 "proto"
96 ], 75 ],
97 "enumDescriptions": [ 76 "enumDescriptions": [
98 "Responses with Content-Type of application/json", 77 "Responses with Content-Type of application/json",
99 "Media download with context-dependent Content-Type", 78 "Media download with context-dependent Content-Type",
100 "Responses with Content-Type of application/x-protobuf" 79 "Responses with Content-Type of application/x-protobuf"
101 ], 80 ],
102 "location": "query", 81 "location": "query",
103 "type": "string" 82 "type": "string"
104 }, 83 },
84 "access_token": {
85 "description": "OAuth access token.",
86 "location": "query",
87 "type": "string"
88 },
105 "key": { 89 "key": {
106 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 90 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
107 "location": "query", 91 "location": "query",
108 "type": "string" 92 "type": "string"
109 }, 93 },
110 "access_token": {
111 "description": "OAuth access token.",
112 "location": "query",
113 "type": "string"
114 },
115 "quotaUser": { 94 "quotaUser": {
116 "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.", 95 "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.",
117 "location": "query", 96 "location": "query",
118 "type": "string" 97 "type": "string"
119 }, 98 },
120 "pp": { 99 "pp": {
121 "default": "true", 100 "default": "true",
122 "description": "Pretty-print response.", 101 "description": "Pretty-print response.",
123 "location": "query", 102 "location": "query",
124 "type": "boolean" 103 "type": "boolean"
104 },
105 "oauth_token": {
106 "description": "OAuth 2.0 token for the current user.",
107 "location": "query",
108 "type": "string"
109 },
110 "bearer_token": {
111 "description": "OAuth bearer token.",
112 "location": "query",
113 "type": "string"
114 },
115 "upload_protocol": {
116 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
117 "location": "query",
118 "type": "string"
119 },
120 "prettyPrint": {
121 "default": "true",
122 "description": "Returns response with indentations and line breaks." ,
123 "location": "query",
124 "type": "boolean"
125 } 125 }
126 }, 126 },
127 "protocol": "rest", 127 "protocol": "rest",
128 "resources": { 128 "resources": {
129 "spreadsheets": { 129 "spreadsheets": {
130 "methods": { 130 "methods": {
131 "get": { 131 "get": {
132 "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.", 132 "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.",
133 "httpMethod": "GET", 133 "httpMethod": "GET",
134 "id": "sheets.spreadsheets.get", 134 "id": "sheets.spreadsheets.get",
(...skipping 84 matching lines...) Expand 10 before | Expand all | Expand 10 after
219 "methods": { 219 "methods": {
220 "update": { 220 "update": {
221 "description": "Sets values in a range of a spreadsh eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption .", 221 "description": "Sets values in a range of a spreadsh eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption .",
222 "httpMethod": "PUT", 222 "httpMethod": "PUT",
223 "id": "sheets.spreadsheets.values.update", 223 "id": "sheets.spreadsheets.values.update",
224 "parameterOrder": [ 224 "parameterOrder": [
225 "spreadsheetId", 225 "spreadsheetId",
226 "range" 226 "range"
227 ], 227 ],
228 "parameters": { 228 "parameters": {
229 "includeValuesInResponse": {
230 "description": "Determines if the update res ponse should include the values\nof the cells that were updated. By default, res ponses\ndo not include the updated values.\nIf the range to write was larger tha n than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
231 "location": "query",
232 "type": "boolean"
233 },
234 "range": {
235 "description": "The A1 notation of the value s to update.",
236 "location": "path",
237 "required": true,
238 "type": "string"
239 },
229 "spreadsheetId": { 240 "spreadsheetId": {
230 "description": "The ID of the spreadsheet to update.", 241 "description": "The ID of the spreadsheet to update.",
231 "location": "path", 242 "location": "path",
232 "required": true, 243 "required": true,
233 "type": "string" 244 "type": "string"
234 }, 245 },
235 "responseValueRenderOption": { 246 "responseValueRenderOption": {
236 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.", 247 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
237 "enum": [ 248 "enum": [
238 "FORMATTED_VALUE", 249 "FORMATTED_VALUE",
(...skipping 14 matching lines...) Expand all
253 "type": "string" 264 "type": "string"
254 }, 265 },
255 "responseDateTimeRenderOption": { 266 "responseDateTimeRenderOption": {
256 "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].", 267 "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].",
257 "enum": [ 268 "enum": [
258 "SERIAL_NUMBER", 269 "SERIAL_NUMBER",
259 "FORMATTED_STRING" 270 "FORMATTED_STRING"
260 ], 271 ],
261 "location": "query", 272 "location": "query",
262 "type": "string" 273 "type": "string"
263 },
264 "range": {
265 "description": "The A1 notation of the value s to update.",
266 "location": "path",
267 "required": true,
268 "type": "string"
269 },
270 "includeValuesInResponse": {
271 "description": "Determines if the update res ponse should include the values\nof the cells that were updated. By default, res ponses\ndo not include the updated values.\nIf the range to write was larger tha n than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
272 "location": "query",
273 "type": "boolean"
274 } 274 }
275 }, 275 },
276 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}", 276 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}",
277 "request": { 277 "request": {
278 "$ref": "ValueRange" 278 "$ref": "ValueRange"
279 }, 279 },
280 "response": { 280 "response": {
281 "$ref": "UpdateValuesResponse" 281 "$ref": "UpdateValuesResponse"
282 }, 282 },
283 "scopes": [ 283 "scopes": [
(...skipping 129 matching lines...) Expand 10 before | Expand all | Expand 10 after
413 }, 413 },
414 "append": { 414 "append": {
415 "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.", 415 "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.",
416 "httpMethod": "POST", 416 "httpMethod": "POST",
417 "id": "sheets.spreadsheets.values.append", 417 "id": "sheets.spreadsheets.values.append",
418 "parameterOrder": [ 418 "parameterOrder": [
419 "spreadsheetId", 419 "spreadsheetId",
420 "range" 420 "range"
421 ], 421 ],
422 "parameters": { 422 "parameters": {
423 "spreadsheetId": {
424 "description": "The ID of the spreadsheet to update.",
425 "location": "path",
426 "required": true,
427 "type": "string"
428 },
429 "responseValueRenderOption": {
430 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
431 "enum": [
432 "FORMATTED_VALUE",
433 "UNFORMATTED_VALUE",
434 "FORMULA"
435 ],
436 "location": "query",
437 "type": "string"
438 },
423 "insertDataOption": { 439 "insertDataOption": {
424 "description": "How the input data should be inserted.", 440 "description": "How the input data should be inserted.",
425 "enum": [ 441 "enum": [
426 "OVERWRITE", 442 "OVERWRITE",
427 "INSERT_ROWS" 443 "INSERT_ROWS"
428 ], 444 ],
429 "location": "query", 445 "location": "query",
430 "type": "string" 446 "type": "string"
431 }, 447 },
432 "valueInputOption": { 448 "valueInputOption": {
(...skipping 18 matching lines...) Expand all
451 "range": { 467 "range": {
452 "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.", 468 "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.",
453 "location": "path", 469 "location": "path",
454 "required": true, 470 "required": true,
455 "type": "string" 471 "type": "string"
456 }, 472 },
457 "includeValuesInResponse": { 473 "includeValuesInResponse": {
458 "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.", 474 "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.",
459 "location": "query", 475 "location": "query",
460 "type": "boolean" 476 "type": "boolean"
461 },
462 "spreadsheetId": {
463 "description": "The ID of the spreadsheet to update.",
464 "location": "path",
465 "required": true,
466 "type": "string"
467 },
468 "responseValueRenderOption": {
469 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
470 "enum": [
471 "FORMATTED_VALUE",
472 "UNFORMATTED_VALUE",
473 "FORMULA"
474 ],
475 "location": "query",
476 "type": "string"
477 } 477 }
478 }, 478 },
479 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append", 479 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append",
480 "request": { 480 "request": {
481 "$ref": "ValueRange" 481 "$ref": "ValueRange"
482 }, 482 },
483 "response": { 483 "response": {
484 "$ref": "AppendValuesResponse" 484 "$ref": "AppendValuesResponse"
485 }, 485 },
486 "scopes": [ 486 "scopes": [
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
519 }, 519 },
520 "get": { 520 "get": {
521 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.", 521 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.",
522 "httpMethod": "GET", 522 "httpMethod": "GET",
523 "id": "sheets.spreadsheets.values.get", 523 "id": "sheets.spreadsheets.values.get",
524 "parameterOrder": [ 524 "parameterOrder": [
525 "spreadsheetId", 525 "spreadsheetId",
526 "range" 526 "range"
527 ], 527 ],
528 "parameters": { 528 "parameters": {
529 "spreadsheetId": {
530 "description": "The ID of the spreadsheet to retrieve data from.",
531 "location": "path",
532 "required": true,
533 "type": "string"
534 },
535 "range": {
536 "description": "The A1 notation of the value s to retrieve.",
537 "location": "path",
538 "required": true,
539 "type": "string"
540 },
541 "valueRenderOption": { 529 "valueRenderOption": {
542 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.", 530 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.",
543 "enum": [ 531 "enum": [
544 "FORMATTED_VALUE", 532 "FORMATTED_VALUE",
545 "UNFORMATTED_VALUE", 533 "UNFORMATTED_VALUE",
546 "FORMULA" 534 "FORMULA"
547 ], 535 ],
548 "location": "query", 536 "location": "query",
549 "type": "string" 537 "type": "string"
550 }, 538 },
551 "dateTimeRenderOption": { 539 "dateTimeRenderOption": {
552 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti on.SERIAL_NUMBER].", 540 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti on.SERIAL_NUMBER].",
553 "enum": [ 541 "enum": [
554 "SERIAL_NUMBER", 542 "SERIAL_NUMBER",
555 "FORMATTED_STRING" 543 "FORMATTED_STRING"
556 ], 544 ],
557 "location": "query", 545 "location": "query",
558 "type": "string" 546 "type": "string"
559 }, 547 },
560 "majorDimension": { 548 "majorDimension": {
561 "description": "The major dimension that res ults should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2= 4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4 ]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1, 3],[2,4]]`.", 549 "description": "The major dimension that res ults should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2= 4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4 ]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1, 3],[2,4]]`.",
562 "enum": [ 550 "enum": [
563 "DIMENSION_UNSPECIFIED", 551 "DIMENSION_UNSPECIFIED",
564 "ROWS", 552 "ROWS",
565 "COLUMNS" 553 "COLUMNS"
566 ], 554 ],
567 "location": "query", 555 "location": "query",
568 "type": "string" 556 "type": "string"
557 },
558 "spreadsheetId": {
559 "description": "The ID of the spreadsheet to retrieve data from.",
560 "location": "path",
561 "required": true,
562 "type": "string"
563 },
564 "range": {
565 "description": "The A1 notation of the value s to retrieve.",
566 "location": "path",
567 "required": true,
568 "type": "string"
569 } 569 }
570 }, 570 },
571 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}", 571 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}",
572 "response": { 572 "response": {
573 "$ref": "ValueRange" 573 "$ref": "ValueRange"
574 }, 574 },
575 "scopes": [ 575 "scopes": [
576 "https://www.googleapis.com/auth/drive", 576 "https://www.googleapis.com/auth/drive",
577 "https://www.googleapis.com/auth/drive.file", 577 "https://www.googleapis.com/auth/drive.file",
578 "https://www.googleapis.com/auth/drive.readonly" , 578 "https://www.googleapis.com/auth/drive.readonly" ,
579 "https://www.googleapis.com/auth/spreadsheets", 579 "https://www.googleapis.com/auth/spreadsheets",
580 "https://www.googleapis.com/auth/spreadsheets.re adonly" 580 "https://www.googleapis.com/auth/spreadsheets.re adonly"
581 ] 581 ]
582 } 582 }
583 } 583 }
584 }, 584 },
585 "sheets": { 585 "sheets": {
586 "methods": { 586 "methods": {
587 "copyTo": { 587 "copyTo": {
588 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ", 588 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ",
589 "httpMethod": "POST", 589 "httpMethod": "POST",
590 "id": "sheets.spreadsheets.sheets.copyTo", 590 "id": "sheets.spreadsheets.sheets.copyTo",
591 "parameterOrder": [ 591 "parameterOrder": [
592 "spreadsheetId", 592 "spreadsheetId",
593 "sheetId" 593 "sheetId"
594 ], 594 ],
595 "parameters": { 595 "parameters": {
596 "spreadsheetId": {
597 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
598 "location": "path",
599 "required": true,
600 "type": "string"
601 },
596 "sheetId": { 602 "sheetId": {
597 "description": "The ID of the sheet to copy. ", 603 "description": "The ID of the sheet to copy. ",
598 "format": "int32", 604 "format": "int32",
599 "location": "path", 605 "location": "path",
600 "required": true, 606 "required": true,
601 "type": "integer" 607 "type": "integer"
602 },
603 "spreadsheetId": {
604 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
605 "location": "path",
606 "required": true,
607 "type": "string"
608 } 608 }
609 }, 609 },
610 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo", 610 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo",
611 "request": { 611 "request": {
612 "$ref": "CopySheetToAnotherSpreadsheetRequest" 612 "$ref": "CopySheetToAnotherSpreadsheetRequest"
613 }, 613 },
614 "response": { 614 "response": {
615 "$ref": "SheetProperties" 615 "$ref": "SheetProperties"
616 }, 616 },
617 "scopes": [ 617 "scopes": [
618 "https://www.googleapis.com/auth/drive", 618 "https://www.googleapis.com/auth/drive",
619 "https://www.googleapis.com/auth/drive.file", 619 "https://www.googleapis.com/auth/drive.file",
620 "https://www.googleapis.com/auth/spreadsheets" 620 "https://www.googleapis.com/auth/spreadsheets"
621 ] 621 ]
622 } 622 }
623 } 623 }
624 } 624 }
625 } 625 }
626 } 626 }
627 }, 627 },
628 "revision": "20170519", 628 "revision": "20170602",
629 "rootUrl": "https://sheets.googleapis.com/", 629 "rootUrl": "https://sheets.googleapis.com/",
630 "schemas": { 630 "schemas": {
631 "PasteDataRequest": {
632 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
633 "id": "PasteDataRequest",
634 "properties": {
635 "type": {
636 "description": "How the data should be pasted.",
637 "enum": [
638 "PASTE_NORMAL",
639 "PASTE_VALUES",
640 "PASTE_FORMAT",
641 "PASTE_NO_BORDERS",
642 "PASTE_FORMULA",
643 "PASTE_DATA_VALIDATION",
644 "PASTE_CONDITIONAL_FORMATTING"
645 ],
646 "enumDescriptions": [
647 "Paste values, formulas, formats, and merges.",
648 "Paste the values ONLY without formats, formulas, or mer ges.",
649 "Paste the format and data validation only.",
650 "Like PASTE_NORMAL but without borders.",
651 "Paste the formulas only.",
652 "Paste the data validation only.",
653 "Paste the conditional formatting rules only."
654 ],
655 "type": "string"
656 },
657 "html": {
658 "description": "True if the data is HTML.",
659 "type": "boolean"
660 },
661 "coordinate": {
662 "$ref": "GridCoordinate",
663 "description": "The coordinate at which the data should star t being inserted."
664 },
665 "data": {
666 "description": "The data to insert.",
667 "type": "string"
668 },
669 "delimiter": {
670 "description": "The delimiter in the data.",
671 "type": "string"
672 }
673 },
674 "type": "object"
675 },
676 "AppendDimensionRequest": {
677 "description": "Appends rows or columns to the end of a sheet.",
678 "id": "AppendDimensionRequest",
679 "properties": {
680 "sheetId": {
681 "description": "The sheet to append rows or columns to.",
682 "format": "int32",
683 "type": "integer"
684 },
685 "dimension": {
686 "description": "Whether rows or columns should be appended." ,
687 "enum": [
688 "DIMENSION_UNSPECIFIED",
689 "ROWS",
690 "COLUMNS"
691 ],
692 "enumDescriptions": [
693 "The default value, do not use.",
694 "Operates on the rows of a sheet.",
695 "Operates on the columns of a sheet."
696 ],
697 "type": "string"
698 },
699 "length": {
700 "description": "The number of rows or columns to append.",
701 "format": "int32",
702 "type": "integer"
703 }
704 },
705 "type": "object"
706 },
707 "AddNamedRangeRequest": {
708 "description": "Adds a named range to the spreadsheet.",
709 "id": "AddNamedRangeRequest",
710 "properties": {
711 "namedRange": {
712 "$ref": "NamedRange",
713 "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.)"
714 }
715 },
716 "type": "object"
717 },
718 "UpdateEmbeddedObjectPositionRequest": {
719 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
720 "id": "UpdateEmbeddedObjectPositionRequest",
721 "properties": {
722 "newPosition": {
723 "$ref": "EmbeddedObjectPosition",
724 "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."
725 },
726 "fields": {
727 "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.",
728 "format": "google-fieldmask",
729 "type": "string"
730 },
731 "objectId": {
732 "description": "The ID of the object to moved.",
733 "format": "int32",
734 "type": "integer"
735 }
736 },
737 "type": "object"
738 },
739 "TextRotation": {
740 "description": "The rotation applied to text in a cell.",
741 "id": "TextRotation",
742 "properties": {
743 "angle": {
744 "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",
745 "format": "int32",
746 "type": "integer"
747 },
748 "vertical": {
749 "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 |",
750 "type": "boolean"
751 }
752 },
753 "type": "object"
754 },
755 "PieChartSpec": {
756 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.",
757 "id": "PieChartSpec",
758 "properties": {
759 "domain": {
760 "$ref": "ChartData",
761 "description": "The data that covers the domain of the pie c hart."
762 },
763 "threeDimensional": {
764 "description": "True if the pie is three dimensional.",
765 "type": "boolean"
766 },
767 "series": {
768 "$ref": "ChartData",
769 "description": "The data that covers the one and only series of the pie chart."
770 },
771 "legendPosition": {
772 "description": "Where the legend of the pie chart should be drawn.",
773 "enum": [
774 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
775 "BOTTOM_LEGEND",
776 "LEFT_LEGEND",
777 "RIGHT_LEGEND",
778 "TOP_LEGEND",
779 "NO_LEGEND",
780 "LABELED_LEGEND"
781 ],
782 "enumDescriptions": [
783 "Default value, do not use.",
784 "The legend is rendered on the bottom of the chart.",
785 "The legend is rendered on the left of the chart.",
786 "The legend is rendered on the right of the chart.",
787 "The legend is rendered on the top of the chart.",
788 "No legend is rendered.",
789 "Each pie slice has a label attached to it."
790 ],
791 "type": "string"
792 },
793 "pieHole": {
794 "description": "The size of the hole in the pie chart.",
795 "format": "double",
796 "type": "number"
797 }
798 },
799 "type": "object"
800 },
801 "UpdateFilterViewRequest": {
802 "description": "Updates properties of the filter view.",
803 "id": "UpdateFilterViewRequest",
804 "properties": {
805 "filter": {
806 "$ref": "FilterView",
807 "description": "The new properties of the filter view."
808 },
809 "fields": {
810 "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.",
811 "format": "google-fieldmask",
812 "type": "string"
813 }
814 },
815 "type": "object"
816 },
817 "ConditionalFormatRule": {
818 "description": "A rule describing a conditional format.",
819 "id": "ConditionalFormatRule",
820 "properties": {
821 "gradientRule": {
822 "$ref": "GradientRule",
823 "description": "The formatting will vary based on the gradie nts in the rule."
824 },
825 "booleanRule": {
826 "$ref": "BooleanRule",
827 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
828 },
829 "ranges": {
830 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.",
831 "items": {
832 "$ref": "GridRange"
833 },
834 "type": "array"
835 }
836 },
837 "type": "object"
838 },
839 "CopyPasteRequest": {
840 "description": "Copies data from the source to the destination.",
841 "id": "CopyPasteRequest",
842 "properties": {
843 "destination": {
844 "$ref": "GridRange",
845 "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)."
846 },
847 "pasteOrientation": {
848 "description": "How that data should be oriented when pastin g.",
849 "enum": [
850 "NORMAL",
851 "TRANSPOSE"
852 ],
853 "enumDescriptions": [
854 "Paste normally.",
855 "Paste transposed, where all rows become columns and vic e versa."
856 ],
857 "type": "string"
858 },
859 "source": {
860 "$ref": "GridRange",
861 "description": "The source range to copy."
862 },
863 "pasteType": {
864 "description": "What kind of data to paste.",
865 "enum": [
866 "PASTE_NORMAL",
867 "PASTE_VALUES",
868 "PASTE_FORMAT",
869 "PASTE_NO_BORDERS",
870 "PASTE_FORMULA",
871 "PASTE_DATA_VALIDATION",
872 "PASTE_CONDITIONAL_FORMATTING"
873 ],
874 "enumDescriptions": [
875 "Paste values, formulas, formats, and merges.",
876 "Paste the values ONLY without formats, formulas, or mer ges.",
877 "Paste the format and data validation only.",
878 "Like PASTE_NORMAL but without borders.",
879 "Paste the formulas only.",
880 "Paste the data validation only.",
881 "Paste the conditional formatting rules only."
882 ],
883 "type": "string"
884 }
885 },
886 "type": "object"
887 },
888 "Request": {
889 "description": "A single kind of update to apply to a spreadsheet.",
890 "id": "Request",
891 "properties": {
892 "sortRange": {
893 "$ref": "SortRangeRequest",
894 "description": "Sorts data in a range."
895 },
896 "deleteProtectedRange": {
897 "$ref": "DeleteProtectedRangeRequest",
898 "description": "Deletes a protected range."
899 },
900 "duplicateFilterView": {
901 "$ref": "DuplicateFilterViewRequest",
902 "description": "Duplicates a filter view."
903 },
904 "addChart": {
905 "$ref": "AddChartRequest",
906 "description": "Adds a chart."
907 },
908 "findReplace": {
909 "$ref": "FindReplaceRequest",
910 "description": "Finds and replaces occurrences of some text with other text."
911 },
912 "updateChartSpec": {
913 "$ref": "UpdateChartSpecRequest",
914 "description": "Updates a chart's specifications."
915 },
916 "textToColumns": {
917 "$ref": "TextToColumnsRequest",
918 "description": "Converts a column of text into many columns of text."
919 },
920 "updateProtectedRange": {
921 "$ref": "UpdateProtectedRangeRequest",
922 "description": "Updates a protected range."
923 },
924 "addSheet": {
925 "$ref": "AddSheetRequest",
926 "description": "Adds a sheet."
927 },
928 "copyPaste": {
929 "$ref": "CopyPasteRequest",
930 "description": "Copies data from one area and pastes it to a nother."
931 },
932 "deleteFilterView": {
933 "$ref": "DeleteFilterViewRequest",
934 "description": "Deletes a filter view from a sheet."
935 },
936 "insertDimension": {
937 "$ref": "InsertDimensionRequest",
938 "description": "Inserts new rows or columns in a sheet."
939 },
940 "deleteRange": {
941 "$ref": "DeleteRangeRequest",
942 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
943 },
944 "deleteBanding": {
945 "$ref": "DeleteBandingRequest",
946 "description": "Removes a banded range"
947 },
948 "addFilterView": {
949 "$ref": "AddFilterViewRequest",
950 "description": "Adds a filter view."
951 },
952 "updateBorders": {
953 "$ref": "UpdateBordersRequest",
954 "description": "Updates the borders in a range of cells."
955 },
956 "setDataValidation": {
957 "$ref": "SetDataValidationRequest",
958 "description": "Sets data validation for one or more cells."
959 },
960 "deleteConditionalFormatRule": {
961 "$ref": "DeleteConditionalFormatRuleRequest",
962 "description": "Deletes an existing conditional format rule. "
963 },
964 "clearBasicFilter": {
965 "$ref": "ClearBasicFilterRequest",
966 "description": "Clears the basic filter on a sheet."
967 },
968 "repeatCell": {
969 "$ref": "RepeatCellRequest",
970 "description": "Repeats a single cell across a range."
971 },
972 "appendDimension": {
973 "$ref": "AppendDimensionRequest",
974 "description": "Appends dimensions to the end of a sheet."
975 },
976 "updateConditionalFormatRule": {
977 "$ref": "UpdateConditionalFormatRuleRequest",
978 "description": "Updates an existing conditional format rule. "
979 },
980 "insertRange": {
981 "$ref": "InsertRangeRequest",
982 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
983 },
984 "moveDimension": {
985 "$ref": "MoveDimensionRequest",
986 "description": "Moves rows or columns to another location in a sheet."
987 },
988 "updateBanding": {
989 "$ref": "UpdateBandingRequest",
990 "description": "Updates a banded range"
991 },
992 "deleteNamedRange": {
993 "$ref": "DeleteNamedRangeRequest",
994 "description": "Deletes a named range."
995 },
996 "addProtectedRange": {
997 "$ref": "AddProtectedRangeRequest",
998 "description": "Adds a protected range."
999 },
1000 "duplicateSheet": {
1001 "$ref": "DuplicateSheetRequest",
1002 "description": "Duplicates a sheet."
1003 },
1004 "deleteSheet": {
1005 "$ref": "DeleteSheetRequest",
1006 "description": "Deletes a sheet."
1007 },
1008 "unmergeCells": {
1009 "$ref": "UnmergeCellsRequest",
1010 "description": "Unmerges merged cells."
1011 },
1012 "updateEmbeddedObjectPosition": {
1013 "$ref": "UpdateEmbeddedObjectPositionRequest",
1014 "description": "Updates an embedded object's (e.g. chart, im age) position."
1015 },
1016 "updateDimensionProperties": {
1017 "$ref": "UpdateDimensionPropertiesRequest",
1018 "description": "Updates dimensions' properties."
1019 },
1020 "pasteData": {
1021 "$ref": "PasteDataRequest",
1022 "description": "Pastes data (HTML or delimited) into a sheet ."
1023 },
1024 "setBasicFilter": {
1025 "$ref": "SetBasicFilterRequest",
1026 "description": "Sets the basic filter on a sheet."
1027 },
1028 "addConditionalFormatRule": {
1029 "$ref": "AddConditionalFormatRuleRequest",
1030 "description": "Adds a new conditional format rule."
1031 },
1032 "updateCells": {
1033 "$ref": "UpdateCellsRequest",
1034 "description": "Updates many cells at once."
1035 },
1036 "addNamedRange": {
1037 "$ref": "AddNamedRangeRequest",
1038 "description": "Adds a named range."
1039 },
1040 "updateSpreadsheetProperties": {
1041 "$ref": "UpdateSpreadsheetPropertiesRequest",
1042 "description": "Updates the spreadsheet's properties."
1043 },
1044 "deleteEmbeddedObject": {
1045 "$ref": "DeleteEmbeddedObjectRequest",
1046 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
1047 },
1048 "updateFilterView": {
1049 "$ref": "UpdateFilterViewRequest",
1050 "description": "Updates the properties of a filter view."
1051 },
1052 "addBanding": {
1053 "$ref": "AddBandingRequest",
1054 "description": "Adds a new banded range"
1055 },
1056 "autoResizeDimensions": {
1057 "$ref": "AutoResizeDimensionsRequest",
1058 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
1059 },
1060 "appendCells": {
1061 "$ref": "AppendCellsRequest",
1062 "description": "Appends cells after the last row with data i n a sheet."
1063 },
1064 "cutPaste": {
1065 "$ref": "CutPasteRequest",
1066 "description": "Cuts data from one area and pastes it to ano ther."
1067 },
1068 "mergeCells": {
1069 "$ref": "MergeCellsRequest",
1070 "description": "Merges cells together."
1071 },
1072 "updateNamedRange": {
1073 "$ref": "UpdateNamedRangeRequest",
1074 "description": "Updates a named range."
1075 },
1076 "updateSheetProperties": {
1077 "$ref": "UpdateSheetPropertiesRequest",
1078 "description": "Updates a sheet's properties."
1079 },
1080 "autoFill": {
1081 "$ref": "AutoFillRequest",
1082 "description": "Automatically fills in more data based on ex isting data."
1083 },
1084 "deleteDimension": {
1085 "$ref": "DeleteDimensionRequest",
1086 "description": "Deletes rows or columns in a sheet."
1087 }
1088 },
1089 "type": "object"
1090 },
1091 "BooleanCondition": {
1092 "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.",
1093 "id": "BooleanCondition",
1094 "properties": {
1095 "type": {
1096 "description": "The type of condition.",
1097 "enum": [
1098 "CONDITION_TYPE_UNSPECIFIED",
1099 "NUMBER_GREATER",
1100 "NUMBER_GREATER_THAN_EQ",
1101 "NUMBER_LESS",
1102 "NUMBER_LESS_THAN_EQ",
1103 "NUMBER_EQ",
1104 "NUMBER_NOT_EQ",
1105 "NUMBER_BETWEEN",
1106 "NUMBER_NOT_BETWEEN",
1107 "TEXT_CONTAINS",
1108 "TEXT_NOT_CONTAINS",
1109 "TEXT_STARTS_WITH",
1110 "TEXT_ENDS_WITH",
1111 "TEXT_EQ",
1112 "TEXT_IS_EMAIL",
1113 "TEXT_IS_URL",
1114 "DATE_EQ",
1115 "DATE_BEFORE",
1116 "DATE_AFTER",
1117 "DATE_ON_OR_BEFORE",
1118 "DATE_ON_OR_AFTER",
1119 "DATE_BETWEEN",
1120 "DATE_NOT_BETWEEN",
1121 "DATE_IS_VALID",
1122 "ONE_OF_RANGE",
1123 "ONE_OF_LIST",
1124 "BLANK",
1125 "NOT_BLANK",
1126 "CUSTOM_FORMULA"
1127 ],
1128 "enumDescriptions": [
1129 "The default value, do not use.",
1130 "The cell's value must be greater than the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
1131 "The cell's value must be greater than or equal to the c ondition's value.\nSupported by data validation, conditional formatting and filt ers.\nRequires a single ConditionValue.",
1132 "The cell's value must be less than the condition's valu e.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
1133 "The cell's value must be less than or equal to the cond ition's value.\nSupported by data validation, conditional formatting and filters .\nRequires a single ConditionValue.",
1134 "The cell's value must be equal to the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
1135 "The cell's value must be not equal to the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
1136 "The cell's value must be between the two condition valu es.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
1137 "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequ ires exactly two ConditionValues.",
1138 "The cell's value must contain the condition's value.\nS upported by data validation, conditional formatting and filters.\nRequires a sin gle ConditionValue.",
1139 "The cell's value must not contain the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
1140 "The cell's value must start with the condition's value. \nSupported by conditional formatting and filters.\nRequires a single ConditionV alue.",
1141 "The cell's value must end with the condition's value.\n Supported by conditional formatting and filters.\nRequires a single ConditionVal ue.",
1142 "The cell's value must be exactly the condition's value. \nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
1143 "The cell's value must be a valid email address.\nSuppor ted by data validation.\nRequires no ConditionValues.",
1144 "The cell's value must be a valid URL.\nSupported by dat a validation.\nRequires no ConditionValues.",
1145 "The cell's value must be the same date as the condition 's value.\nSupported by data validation, conditional formatting and filters.\nRe quires a single ConditionValue.",
1146 "The cell's value must be before the date of the conditi on's value.\nSupported by data validation, conditional formatting and filters.\n Requires a single ConditionValue\nthat may be a relative date.",
1147 "The cell's value must be after the date of the conditio n's value.\nSupported by data validation, conditional formatting and filters.\nR equires a single ConditionValue\nthat may be a relative date.",
1148 "The cell's value must be on or before the date of the c ondition's value.\nSupported by data validation.\nRequires a single ConditionVal ue\nthat may be a relative date.",
1149 "The cell's value must be on or after the date of the co ndition's value.\nSupported by data validation.\nRequires a single ConditionValu e\nthat may be a relative date.",
1150 "The cell's value must be between the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
1151 "The cell's value must be outside the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
1152 "The cell's value must be a date.\nSupported by data val idation.\nRequires no ConditionValues.",
1153 "The cell's value must be listed in the grid in conditio n value's range.\nSupported by data validation.\nRequires a single ConditionValu e,\nand the value must be a valid range in A1 notation.",
1154 "The cell's value must in the list of condition values.\ nSupported by data validation.\nSupports any number of condition values,\none pe r item in the list.\nFormulas are not supported in the values.",
1155 "The cell's value must be empty.\nSupported by condition al formatting and filters.\nRequires no ConditionValues.",
1156 "The cell's value must not be empty.\nSupported by condi tional formatting and filters.\nRequires no ConditionValues.",
1157 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue."
1158 ],
1159 "type": "string"
1160 },
1161 "values": {
1162 "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.",
1163 "items": {
1164 "$ref": "ConditionValue"
1165 },
1166 "type": "array"
1167 }
1168 },
1169 "type": "object"
1170 },
1171 "GridRange": {
1172 "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!`.",
1173 "id": "GridRange",
1174 "properties": {
1175 "endRowIndex": {
1176 "description": "The end row (exclusive) of the range, or not set if unbounded.",
1177 "format": "int32",
1178 "type": "integer"
1179 },
1180 "endColumnIndex": {
1181 "description": "The end column (exclusive) of the range, or not set if unbounded.",
1182 "format": "int32",
1183 "type": "integer"
1184 },
1185 "startRowIndex": {
1186 "description": "The start row (inclusive) of the range, or n ot set if unbounded.",
1187 "format": "int32",
1188 "type": "integer"
1189 },
1190 "startColumnIndex": {
1191 "description": "The start column (inclusive) of the range, o r not set if unbounded.",
1192 "format": "int32",
1193 "type": "integer"
1194 },
1195 "sheetId": {
1196 "description": "The sheet this range is on.",
1197 "format": "int32",
1198 "type": "integer"
1199 }
1200 },
1201 "type": "object"
1202 },
1203 "BasicChartSpec": {
1204 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.",
1205 "id": "BasicChartSpec",
1206 "properties": {
1207 "chartType": {
1208 "description": "The type of the chart.",
1209 "enum": [
1210 "BASIC_CHART_TYPE_UNSPECIFIED",
1211 "BAR",
1212 "LINE",
1213 "AREA",
1214 "COLUMN",
1215 "SCATTER",
1216 "COMBO"
1217 ],
1218 "enumDescriptions": [
1219 "Default value, do not use.",
1220 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
1221 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
1222 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
1223 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
1224 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
1225 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
1226 ],
1227 "type": "string"
1228 },
1229 "series": {
1230 "description": "The data this chart is visualizing.",
1231 "items": {
1232 "$ref": "BasicChartSeries"
1233 },
1234 "type": "array"
1235 },
1236 "legendPosition": {
1237 "description": "The position of the chart legend.",
1238 "enum": [
1239 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
1240 "BOTTOM_LEGEND",
1241 "LEFT_LEGEND",
1242 "RIGHT_LEGEND",
1243 "TOP_LEGEND",
1244 "NO_LEGEND"
1245 ],
1246 "enumDescriptions": [
1247 "Default value, do not use.",
1248 "The legend is rendered on the bottom of the chart.",
1249 "The legend is rendered on the left of the chart.",
1250 "The legend is rendered on the right of the chart.",
1251 "The legend is rendered on the top of the chart.",
1252 "No legend is rendered."
1253 ],
1254 "type": "string"
1255 },
1256 "domains": {
1257 "description": "The domain of data this is charting.\nOnly a single domain is supported.",
1258 "items": {
1259 "$ref": "BasicChartDomain"
1260 },
1261 "type": "array"
1262 },
1263 "headerCount": {
1264 "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.)",
1265 "format": "int32",
1266 "type": "integer"
1267 },
1268 "axis": {
1269 "description": "The axis on the chart.",
1270 "items": {
1271 "$ref": "BasicChartAxis"
1272 },
1273 "type": "array"
1274 }
1275 },
1276 "type": "object"
1277 },
1278 "SetDataValidationRequest": {
1279 "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.",
1280 "id": "SetDataValidationRequest",
1281 "properties": {
1282 "rule": {
1283 "$ref": "DataValidationRule",
1284 "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
1285 },
1286 "range": {
1287 "$ref": "GridRange",
1288 "description": "The range the data validation rule should ap ply to."
1289 }
1290 },
1291 "type": "object"
1292 },
1293 "CellData": {
1294 "description": "Data about a specific cell.",
1295 "id": "CellData",
1296 "properties": {
1297 "formattedValue": {
1298 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.",
1299 "type": "string"
1300 },
1301 "textFormatRuns": {
1302 "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.",
1303 "items": {
1304 "$ref": "TextFormatRun"
1305 },
1306 "type": "array"
1307 },
1308 "hyperlink": {
1309 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnter edValue.formulaValue\nfield.)",
1310 "type": "string"
1311 },
1312 "pivotTable": {
1313 "$ref": "PivotTable",
1314 "description": "A pivot table anchored at this cell. The siz e of pivot table itself\nis computed dynamically based on its data, grouping, fi lters, values,\netc. Only the top-left cell of the pivot table contains the pivo t table\ndefinition. The other cells will contain the calculated values of the\n results of the pivot in their effective_value fields."
1315 },
1316 "userEnteredFormat": {
1317 "$ref": "CellFormat",
1318 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
1319 },
1320 "note": {
1321 "description": "Any note on the cell.",
1322 "type": "string"
1323 },
1324 "effectiveFormat": {
1325 "$ref": "CellFormat",
1326 "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."
1327 },
1328 "dataValidation": {
1329 "$ref": "DataValidationRule",
1330 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
1331 },
1332 "userEnteredValue": {
1333 "$ref": "ExtendedValue",
1334 "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."
1335 },
1336 "effectiveValue": {
1337 "$ref": "ExtendedValue",
1338 "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."
1339 }
1340 },
1341 "type": "object"
1342 },
1343 "BatchUpdateSpreadsheetRequest": {
1344 "description": "The request for updating any aspect of a spreadsheet .",
1345 "id": "BatchUpdateSpreadsheetRequest",
1346 "properties": {
1347 "includeSpreadsheetInResponse": {
1348 "description": "Determines if the update response should inc lude the spreadsheet\nresource.",
1349 "type": "boolean"
1350 },
1351 "responseRanges": {
1352 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
1353 "items": {
1354 "type": "string"
1355 },
1356 "type": "array"
1357 },
1358 "responseIncludeGridData": {
1359 "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.",
1360 "type": "boolean"
1361 },
1362 "requests": {
1363 "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.",
1364 "items": {
1365 "$ref": "Request"
1366 },
1367 "type": "array"
1368 }
1369 },
1370 "type": "object"
1371 },
1372 "Padding": {
1373 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
1374 "id": "Padding",
1375 "properties": {
1376 "right": {
1377 "description": "The right padding of the cell.",
1378 "format": "int32",
1379 "type": "integer"
1380 },
1381 "bottom": {
1382 "description": "The bottom padding of the cell.",
1383 "format": "int32",
1384 "type": "integer"
1385 },
1386 "top": {
1387 "description": "The top padding of the cell.",
1388 "format": "int32",
1389 "type": "integer"
1390 },
1391 "left": {
1392 "description": "The left padding of the cell.",
1393 "format": "int32",
1394 "type": "integer"
1395 }
1396 },
1397 "type": "object"
1398 },
1399 "BasicChartAxis": {
1400 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
1401 "id": "BasicChartAxis",
1402 "properties": {
1403 "position": {
1404 "description": "The position of this axis.",
1405 "enum": [
1406 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
1407 "BOTTOM_AXIS",
1408 "LEFT_AXIS",
1409 "RIGHT_AXIS"
1410 ],
1411 "enumDescriptions": [
1412 "Default value, do not use.",
1413 "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.",
1414 "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.",
1415 "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."
1416 ],
1417 "type": "string"
1418 },
1419 "title": {
1420 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.",
1421 "type": "string"
1422 },
1423 "format": {
1424 "$ref": "TextFormat",
1425 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
1426 }
1427 },
1428 "type": "object"
1429 },
1430 "DeleteDimensionRequest": {
1431 "description": "Deletes the dimensions from the sheet.",
1432 "id": "DeleteDimensionRequest",
1433 "properties": {
1434 "range": {
1435 "$ref": "DimensionRange",
1436 "description": "The dimensions to delete from the sheet."
1437 }
1438 },
1439 "type": "object"
1440 },
1441 "UpdateChartSpecRequest": { 631 "UpdateChartSpecRequest": {
1442 "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.)", 632 "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.)",
1443 "id": "UpdateChartSpecRequest", 633 "id": "UpdateChartSpecRequest",
1444 "properties": { 634 "properties": {
1445 "spec": { 635 "spec": {
1446 "$ref": "ChartSpec", 636 "$ref": "ChartSpec",
1447 "description": "The specification to apply to the chart." 637 "description": "The specification to apply to the chart."
1448 }, 638 },
1449 "chartId": { 639 "chartId": {
1450 "description": "The ID of the chart to update.", 640 "description": "The ID of the chart to update.",
(...skipping 12 matching lines...) Expand all
1463 "format": "int32", 653 "format": "int32",
1464 "type": "integer" 654 "type": "integer"
1465 } 655 }
1466 }, 656 },
1467 "type": "object" 657 "type": "object"
1468 }, 658 },
1469 "BatchUpdateValuesResponse": { 659 "BatchUpdateValuesResponse": {
1470 "description": "The response when updating a range of values in a sp readsheet.", 660 "description": "The response when updating a range of values in a sp readsheet.",
1471 "id": "BatchUpdateValuesResponse", 661 "id": "BatchUpdateValuesResponse",
1472 "properties": { 662 "properties": {
1473 "totalUpdatedSheets": {
1474 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.",
1475 "format": "int32",
1476 "type": "integer"
1477 },
1478 "totalUpdatedCells": {
1479 "description": "The total number of cells updated.",
1480 "format": "int32",
1481 "type": "integer"
1482 },
1483 "totalUpdatedColumns": {
1484 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
1485 "format": "int32",
1486 "type": "integer"
1487 },
1488 "spreadsheetId": {
1489 "description": "The spreadsheet the updates were applied to. ",
1490 "type": "string"
1491 },
1492 "totalUpdatedRows": {
1493 "description": "The total number of rows where at least one cell in the row was updated.",
1494 "format": "int32",
1495 "type": "integer"
1496 },
1497 "responses": { 663 "responses": {
1498 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.", 664 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.",
1499 "items": { 665 "items": {
1500 "$ref": "UpdateValuesResponse" 666 "$ref": "UpdateValuesResponse"
1501 }, 667 },
1502 "type": "array" 668 "type": "array"
669 },
670 "totalUpdatedSheets": {
671 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.",
672 "format": "int32",
673 "type": "integer"
674 },
675 "totalUpdatedCells": {
676 "description": "The total number of cells updated.",
677 "format": "int32",
678 "type": "integer"
679 },
680 "totalUpdatedColumns": {
681 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
682 "format": "int32",
683 "type": "integer"
684 },
685 "spreadsheetId": {
686 "description": "The spreadsheet the updates were applied to. ",
687 "type": "string"
688 },
689 "totalUpdatedRows": {
690 "description": "The total number of rows where at least one cell in the row was updated.",
691 "format": "int32",
692 "type": "integer"
1503 } 693 }
1504 }, 694 },
1505 "type": "object" 695 "type": "object"
1506 }, 696 },
1507 "SortRangeRequest": { 697 "SortRangeRequest": {
1508 "description": "Sorts data in rows based on a sort order per column. ", 698 "description": "Sorts data in rows based on a sort order per column. ",
1509 "id": "SortRangeRequest", 699 "id": "SortRangeRequest",
1510 "properties": { 700 "properties": {
1511 "range": { 701 "range": {
1512 "$ref": "GridRange", 702 "$ref": "GridRange",
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after
1603 "format": "int32", 793 "format": "int32",
1604 "type": "integer" 794 "type": "integer"
1605 } 795 }
1606 }, 796 },
1607 "type": "object" 797 "type": "object"
1608 }, 798 },
1609 "TextToColumnsRequest": { 799 "TextToColumnsRequest": {
1610 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.", 800 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.",
1611 "id": "TextToColumnsRequest", 801 "id": "TextToColumnsRequest",
1612 "properties": { 802 "properties": {
803 "delimiter": {
804 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.",
805 "type": "string"
806 },
1613 "source": { 807 "source": {
1614 "$ref": "GridRange", 808 "$ref": "GridRange",
1615 "description": "The source data range. This must span exact ly one column." 809 "description": "The source data range. This must span exact ly one column."
1616 }, 810 },
1617 "delimiterType": { 811 "delimiterType": {
1618 "description": "The delimiter type to use.", 812 "description": "The delimiter type to use.",
1619 "enum": [ 813 "enum": [
1620 "DELIMITER_TYPE_UNSPECIFIED", 814 "DELIMITER_TYPE_UNSPECIFIED",
1621 "COMMA", 815 "COMMA",
1622 "SEMICOLON", 816 "SEMICOLON",
1623 "PERIOD", 817 "PERIOD",
1624 "SPACE", 818 "SPACE",
1625 "CUSTOM" 819 "CUSTOM"
1626 ], 820 ],
1627 "enumDescriptions": [ 821 "enumDescriptions": [
1628 "Default value. This value must not be used.", 822 "Default value. This value must not be used.",
1629 "\",\"", 823 "\",\"",
1630 "\";\"", 824 "\";\"",
1631 "\".\"", 825 "\".\"",
1632 "\" \"", 826 "\" \"",
1633 "A custom value as defined in delimiter." 827 "A custom value as defined in delimiter."
1634 ], 828 ],
1635 "type": "string" 829 "type": "string"
1636 },
1637 "delimiter": {
1638 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.",
1639 "type": "string"
1640 }
1641 },
1642 "type": "object"
1643 },
1644 "DeleteBandingRequest": {
1645 "description": "Removes the banded range with the given ID from the spreadsheet.",
1646 "id": "DeleteBandingRequest",
1647 "properties": {
1648 "bandedRangeId": {
1649 "description": "The ID of the banded range to delete.",
1650 "format": "int32",
1651 "type": "integer"
1652 } 830 }
1653 }, 831 },
1654 "type": "object" 832 "type": "object"
1655 }, 833 },
1656 "BatchUpdateSpreadsheetResponse": { 834 "BatchUpdateSpreadsheetResponse": {
1657 "description": "The reply for batch updating a spreadsheet.", 835 "description": "The reply for batch updating a spreadsheet.",
1658 "id": "BatchUpdateSpreadsheetResponse", 836 "id": "BatchUpdateSpreadsheetResponse",
1659 "properties": { 837 "properties": {
1660 "replies": { 838 "replies": {
1661 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.", 839 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.",
1662 "items": { 840 "items": {
1663 "$ref": "Response" 841 "$ref": "Response"
1664 }, 842 },
1665 "type": "array" 843 "type": "array"
1666 }, 844 },
1667 "updatedSpreadsheet": { 845 "updatedSpreadsheet": {
1668 "$ref": "Spreadsheet", 846 "$ref": "Spreadsheet",
1669 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`." 847 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`."
1670 }, 848 },
1671 "spreadsheetId": { 849 "spreadsheetId": {
1672 "description": "The spreadsheet the updates were applied to. ", 850 "description": "The spreadsheet the updates were applied to. ",
1673 "type": "string" 851 "type": "string"
1674 } 852 }
1675 }, 853 },
1676 "type": "object" 854 "type": "object"
1677 }, 855 },
856 "DeleteBandingRequest": {
857 "description": "Removes the banded range with the given ID from the spreadsheet.",
858 "id": "DeleteBandingRequest",
859 "properties": {
860 "bandedRangeId": {
861 "description": "The ID of the banded range to delete.",
862 "format": "int32",
863 "type": "integer"
864 }
865 },
866 "type": "object"
867 },
1678 "AppendValuesResponse": { 868 "AppendValuesResponse": {
1679 "description": "The response when updating a range of values in a sp readsheet.", 869 "description": "The response when updating a range of values in a sp readsheet.",
1680 "id": "AppendValuesResponse", 870 "id": "AppendValuesResponse",
1681 "properties": { 871 "properties": {
1682 "tableRange": {
1683 "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.",
1684 "type": "string"
1685 },
1686 "spreadsheetId": {
1687 "description": "The spreadsheet the updates were applied to. ",
1688 "type": "string"
1689 },
1690 "updates": { 872 "updates": {
1691 "$ref": "UpdateValuesResponse", 873 "$ref": "UpdateValuesResponse",
1692 "description": "Information about the updates that were appl ied." 874 "description": "Information about the updates that were appl ied."
1693 } 875 },
1694 }, 876 "tableRange": {
1695 "type": "object" 877 "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.",
1696 }, 878 "type": "string"
1697 "AddFilterViewRequest": { 879 },
1698 "description": "Adds a filter view.", 880 "spreadsheetId": {
1699 "id": "AddFilterViewRequest", 881 "description": "The spreadsheet the updates were applied to. ",
1700 "properties": { 882 "type": "string"
1701 "filter": { 883 }
1702 "$ref": "FilterView", 884 },
1703 "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.)" 885 "type": "object"
886 },
887 "MoveDimensionRequest": {
888 "description": "Moves one or more rows or columns.",
889 "id": "MoveDimensionRequest",
890 "properties": {
891 "destinationIndex": {
892 "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`.",
893 "format": "int32",
894 "type": "integer"
895 },
896 "source": {
897 "$ref": "DimensionRange",
898 "description": "The source dimensions to move."
1704 } 899 }
1705 }, 900 },
1706 "type": "object" 901 "type": "object"
1707 }, 902 },
1708 "PivotFilterCriteria": { 903 "PivotFilterCriteria": {
1709 "description": "Criteria for showing/hiding rows in a pivot table.", 904 "description": "Criteria for showing/hiding rows in a pivot table.",
1710 "id": "PivotFilterCriteria", 905 "id": "PivotFilterCriteria",
1711 "properties": { 906 "properties": {
1712 "visibleValues": { 907 "visibleValues": {
1713 "description": "Values that should be included. Values not listed here are excluded.", 908 "description": "Values that should be included. Values not listed here are excluded.",
1714 "items": { 909 "items": {
1715 "type": "string" 910 "type": "string"
1716 }, 911 },
1717 "type": "array" 912 "type": "array"
1718 } 913 }
1719 }, 914 },
1720 "type": "object" 915 "type": "object"
1721 }, 916 },
1722 "MoveDimensionRequest": { 917 "AddFilterViewRequest": {
1723 "description": "Moves one or more rows or columns.", 918 "description": "Adds a filter view.",
1724 "id": "MoveDimensionRequest", 919 "id": "AddFilterViewRequest",
1725 "properties": { 920 "properties": {
1726 "destinationIndex": { 921 "filter": {
1727 "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`.", 922 "$ref": "FilterView",
1728 "format": "int32", 923 "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.)"
1729 "type": "integer"
1730 },
1731 "source": {
1732 "$ref": "DimensionRange",
1733 "description": "The source dimensions to move."
1734 } 924 }
1735 }, 925 },
1736 "type": "object" 926 "type": "object"
1737 }, 927 },
1738 "AddConditionalFormatRuleRequest": { 928 "AddConditionalFormatRuleRequest": {
1739 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.", 929 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.",
1740 "id": "AddConditionalFormatRuleRequest", 930 "id": "AddConditionalFormatRuleRequest",
1741 "properties": { 931 "properties": {
932 "index": {
933 "description": "The zero-based index where the rule should b e inserted.",
934 "format": "int32",
935 "type": "integer"
936 },
1742 "rule": { 937 "rule": {
1743 "$ref": "ConditionalFormatRule", 938 "$ref": "ConditionalFormatRule",
1744 "description": "The rule to add." 939 "description": "The rule to add."
1745 },
1746 "index": {
1747 "description": "The zero-based index where the rule should b e inserted.",
1748 "format": "int32",
1749 "type": "integer"
1750 } 940 }
1751 }, 941 },
1752 "type": "object" 942 "type": "object"
1753 }, 943 },
1754 "ChartSpec": { 944 "ChartSpec": {
1755 "description": "The specifications of a chart.", 945 "description": "The specifications of a chart.",
1756 "id": "ChartSpec", 946 "id": "ChartSpec",
1757 "properties": { 947 "properties": {
948 "histogramChart": {
949 "$ref": "HistogramChartSpec",
950 "description": "A histogram chart specification."
951 },
952 "candlestickChart": {
953 "$ref": "CandlestickChartSpec",
954 "description": "A candlestick chart specification."
955 },
956 "bubbleChart": {
957 "$ref": "BubbleChartSpec",
958 "description": "A bubble chart specification."
959 },
960 "fontName": {
961 "description": "The name of the font to use by default for a ll chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
962 "type": "string"
963 },
964 "maximized": {
965 "description": "True to make a chart fill the entire space i n which it's rendered with\nminimum padding. False to use the default padding.\ n(Not applicable to Geo and Org charts.)",
966 "type": "boolean"
967 },
1758 "hiddenDimensionStrategy": { 968 "hiddenDimensionStrategy": {
1759 "description": "Determines how the charts will use hidden ro ws or columns.", 969 "description": "Determines how the charts will use hidden ro ws or columns.",
1760 "enum": [ 970 "enum": [
1761 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED", 971 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
1762 "SKIP_HIDDEN_ROWS_AND_COLUMNS", 972 "SKIP_HIDDEN_ROWS_AND_COLUMNS",
1763 "SKIP_HIDDEN_ROWS", 973 "SKIP_HIDDEN_ROWS",
1764 "SKIP_HIDDEN_COLUMNS", 974 "SKIP_HIDDEN_COLUMNS",
1765 "SHOW_ALL" 975 "SHOW_ALL"
1766 ], 976 ],
1767 "enumDescriptions": [ 977 "enumDescriptions": [
1768 "Default value, do not use.", 978 "Default value, do not use.",
1769 "Charts will skip hidden rows and columns.", 979 "Charts will skip hidden rows and columns.",
1770 "Charts will skip hidden rows only.", 980 "Charts will skip hidden rows only.",
1771 "Charts will skip hidden columns only.", 981 "Charts will skip hidden columns only.",
1772 "Charts will not skip any hidden rows or columns." 982 "Charts will not skip any hidden rows or columns."
1773 ], 983 ],
1774 "type": "string" 984 "type": "string"
1775 }, 985 },
1776 "title": { 986 "backgroundColor": {
1777 "description": "The title of the chart.", 987 "$ref": "Color",
1778 "type": "string" 988 "description": "The background color of the entire chart.\nN ot applicable to Org charts."
989 },
990 "basicChart": {
991 "$ref": "BasicChartSpec",
992 "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."
993 },
994 "orgChart": {
995 "$ref": "OrgChartSpec",
996 "description": "An org chart specification."
1779 }, 997 },
1780 "pieChart": { 998 "pieChart": {
1781 "$ref": "PieChartSpec", 999 "$ref": "PieChartSpec",
1782 "description": "A pie chart specification." 1000 "description": "A pie chart specification."
1783 }, 1001 },
1784 "basicChart": { 1002 "titleTextFormat": {
1785 "$ref": "BasicChartSpec", 1003 "$ref": "TextFormat",
1786 "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." 1004 "description": "The title text format.\nStrikethrough and un derline are not supported."
1005 },
1006 "title": {
1007 "description": "The title of the chart.",
1008 "type": "string"
1787 } 1009 }
1788 }, 1010 },
1789 "type": "object" 1011 "type": "object"
1790 }, 1012 },
1791 "NumberFormat": { 1013 "NumberFormat": {
1792 "description": "The number format of a cell.", 1014 "description": "The number format of a cell.",
1793 "id": "NumberFormat", 1015 "id": "NumberFormat",
1794 "properties": { 1016 "properties": {
1795 "type": { 1017 "type": {
1796 "description": "The type of the number format.\nWhen writing , this field must be set.", 1018 "description": "The type of the number format.\nWhen writing , this field must be set.",
(...skipping 21 matching lines...) Expand all
1818 ], 1040 ],
1819 "type": "string" 1041 "type": "string"
1820 }, 1042 },
1821 "pattern": { 1043 "pattern": {
1822 "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.", 1044 "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.",
1823 "type": "string" 1045 "type": "string"
1824 } 1046 }
1825 }, 1047 },
1826 "type": "object" 1048 "type": "object"
1827 }, 1049 },
1050 "CandlestickDomain": {
1051 "description": "The domain of a CandlestickChart.",
1052 "id": "CandlestickDomain",
1053 "properties": {
1054 "data": {
1055 "$ref": "ChartData",
1056 "description": "The data of the CandlestickDomain."
1057 }
1058 },
1059 "type": "object"
1060 },
1828 "SheetProperties": { 1061 "SheetProperties": {
1829 "description": "Properties of a sheet.", 1062 "description": "Properties of a sheet.",
1830 "id": "SheetProperties", 1063 "id": "SheetProperties",
1831 "properties": { 1064 "properties": {
1832 "title": {
1833 "description": "The name of the sheet.",
1834 "type": "string"
1835 },
1836 "tabColor": { 1065 "tabColor": {
1837 "$ref": "Color", 1066 "$ref": "Color",
1838 "description": "The color of the tab in the UI." 1067 "description": "The color of the tab in the UI."
1839 }, 1068 },
1840 "index": { 1069 "index": {
1841 "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.", 1070 "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.",
1842 "format": "int32", 1071 "format": "int32",
1843 "type": "integer" 1072 "type": "integer"
1844 }, 1073 },
1845 "sheetId": { 1074 "sheetId": {
(...skipping 19 matching lines...) Expand all
1865 "SHEET_TYPE_UNSPECIFIED", 1094 "SHEET_TYPE_UNSPECIFIED",
1866 "GRID", 1095 "GRID",
1867 "OBJECT" 1096 "OBJECT"
1868 ], 1097 ],
1869 "enumDescriptions": [ 1098 "enumDescriptions": [
1870 "Default value, do not use.", 1099 "Default value, do not use.",
1871 "The sheet is a grid.", 1100 "The sheet is a grid.",
1872 "The sheet has no grid and instead has an object like a chart or image." 1101 "The sheet has no grid and instead has an object like a chart or image."
1873 ], 1102 ],
1874 "type": "string" 1103 "type": "string"
1104 },
1105 "title": {
1106 "description": "The name of the sheet.",
1107 "type": "string"
1875 } 1108 }
1876 }, 1109 },
1877 "type": "object" 1110 "type": "object"
1878 }, 1111 },
1879 "UpdateDimensionPropertiesRequest": { 1112 "UpdateDimensionPropertiesRequest": {
1880 "description": "Updates properties of dimensions within the specifie d range.", 1113 "description": "Updates properties of dimensions within the specifie d range.",
1881 "id": "UpdateDimensionPropertiesRequest", 1114 "id": "UpdateDimensionPropertiesRequest",
1882 "properties": { 1115 "properties": {
1116 "properties": {
1117 "$ref": "DimensionProperties",
1118 "description": "Properties to update."
1119 },
1883 "range": { 1120 "range": {
1884 "$ref": "DimensionRange", 1121 "$ref": "DimensionRange",
1885 "description": "The rows or columns to update." 1122 "description": "The rows or columns to update."
1886 }, 1123 },
1887 "fields": { 1124 "fields": {
1888 "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 .", 1125 "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 .",
1889 "format": "google-fieldmask", 1126 "format": "google-fieldmask",
1890 "type": "string" 1127 "type": "string"
1891 },
1892 "properties": {
1893 "$ref": "DimensionProperties",
1894 "description": "Properties to update."
1895 } 1128 }
1896 }, 1129 },
1897 "type": "object" 1130 "type": "object"
1898 }, 1131 },
1899 "SourceAndDestination": { 1132 "SourceAndDestination": {
1900 "description": "A combination of a source range and how to extend th at source.", 1133 "description": "A combination of a source range and how to extend th at source.",
1901 "id": "SourceAndDestination", 1134 "id": "SourceAndDestination",
1902 "properties": { 1135 "properties": {
1136 "dimension": {
1137 "description": "The dimension that data should be filled int o.",
1138 "enum": [
1139 "DIMENSION_UNSPECIFIED",
1140 "ROWS",
1141 "COLUMNS"
1142 ],
1143 "enumDescriptions": [
1144 "The default value, do not use.",
1145 "Operates on the rows of a sheet.",
1146 "Operates on the columns of a sheet."
1147 ],
1148 "type": "string"
1149 },
1150 "fillLength": {
1151 "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.",
1152 "format": "int32",
1153 "type": "integer"
1154 },
1903 "source": { 1155 "source": {
1904 "$ref": "GridRange", 1156 "$ref": "GridRange",
1905 "description": "The location of the data to use as the sourc e of the autofill." 1157 "description": "The location of the data to use as the sourc e of the autofill."
1906 },
1907 "dimension": {
1908 "description": "The dimension that data should be filled int o.",
1909 "enum": [
1910 "DIMENSION_UNSPECIFIED",
1911 "ROWS",
1912 "COLUMNS"
1913 ],
1914 "enumDescriptions": [
1915 "The default value, do not use.",
1916 "Operates on the rows of a sheet.",
1917 "Operates on the columns of a sheet."
1918 ],
1919 "type": "string"
1920 },
1921 "fillLength": {
1922 "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.",
1923 "format": "int32",
1924 "type": "integer"
1925 } 1158 }
1926 }, 1159 },
1927 "type": "object" 1160 "type": "object"
1928 }, 1161 },
1929 "FilterView": { 1162 "FilterView": {
1930 "description": "A filter view.", 1163 "description": "A filter view.",
1931 "id": "FilterView", 1164 "id": "FilterView",
1932 "properties": { 1165 "properties": {
1166 "filterViewId": {
1167 "description": "The ID of the filter view.",
1168 "format": "int32",
1169 "type": "integer"
1170 },
1933 "criteria": { 1171 "criteria": {
1934 "additionalProperties": { 1172 "additionalProperties": {
1935 "$ref": "FilterCriteria" 1173 "$ref": "FilterCriteria"
1936 }, 1174 },
1937 "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.", 1175 "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.",
1938 "type": "object" 1176 "type": "object"
1939 }, 1177 },
1940 "title": { 1178 "title": {
1941 "description": "The name of the filter view.", 1179 "description": "The name of the filter view.",
1942 "type": "string" 1180 "type": "string"
1943 }, 1181 },
1944 "range": { 1182 "range": {
1945 "$ref": "GridRange", 1183 "$ref": "GridRange",
1946 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or named_range_id\nmay be set." 1184 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or named_range_id\nmay be set."
1947 }, 1185 },
1948 "sortSpecs": { 1186 "sortSpecs": {
1949 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 1187 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
1950 "items": { 1188 "items": {
1951 "$ref": "SortSpec" 1189 "$ref": "SortSpec"
1952 }, 1190 },
1953 "type": "array" 1191 "type": "array"
1954 }, 1192 },
1955 "namedRangeId": { 1193 "namedRangeId": {
1956 "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.", 1194 "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.",
1957 "type": "string" 1195 "type": "string"
1958 }, 1196 }
1959 "filterViewId": { 1197 },
1960 "description": "The ID of the filter view.", 1198 "type": "object"
1961 "format": "int32", 1199 },
1962 "type": "integer" 1200 "OrgChartSpec": {
1201 "description": "An <a href=\"/chart/interactive/docs/gallery/orgchar t\">org chart</a>.\nOrg charts require a unique set of labels in labels and may\ noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also r eporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_ labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"Presi dent\", \"VP Sales\".",
1202 "id": "OrgChartSpec",
1203 "properties": {
1204 "tooltips": {
1205 "$ref": "ChartData",
1206 "description": "The data containing the tooltip for the corr esponding node. A blank value\nresults in no tooltip being displayed for the no de.\nThis field is optional."
1207 },
1208 "selectedNodeColor": {
1209 "$ref": "Color",
1210 "description": "The color of the selected org chart nodes."
1211 },
1212 "parentLabels": {
1213 "$ref": "ChartData",
1214 "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
1215 },
1216 "nodeSize": {
1217 "description": "The size of the org chart nodes.",
1218 "enum": [
1219 "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
1220 "SMALL",
1221 "MEDIUM",
1222 "LARGE"
1223 ],
1224 "enumDescriptions": [
1225 "Default value, do not use.",
1226 "The small org chart node size.",
1227 "The medium org chart node size.",
1228 "The large org chart node size."
1229 ],
1230 "type": "string"
1231 },
1232 "labels": {
1233 "$ref": "ChartData",
1234 "description": "The data containing the labels for all the n odes in the chart. Labels\nmust be unique."
1235 },
1236 "nodeColor": {
1237 "$ref": "Color",
1238 "description": "The color of the org chart nodes."
1963 } 1239 }
1964 }, 1240 },
1965 "type": "object" 1241 "type": "object"
1966 }, 1242 },
1967 "BandingProperties": { 1243 "BandingProperties": {
1968 "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.", 1244 "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.",
1969 "id": "BandingProperties", 1245 "id": "BandingProperties",
1970 "properties": { 1246 "properties": {
1247 "secondBandColor": {
1248 "$ref": "Color",
1249 "description": "The second color that is alternating. (Requi red)"
1250 },
1971 "footerColor": { 1251 "footerColor": {
1972 "$ref": "Color", 1252 "$ref": "Color",
1973 "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." 1253 "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."
1974 }, 1254 },
1975 "headerColor": { 1255 "headerColor": {
1976 "$ref": "Color", 1256 "$ref": "Color",
1977 "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." 1257 "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."
1978 }, 1258 },
1979 "firstBandColor": { 1259 "firstBandColor": {
1980 "$ref": "Color", 1260 "$ref": "Color",
1981 "description": "The first color that is alternating. (Requir ed)" 1261 "description": "The first color that is alternating. (Requir ed)"
1982 },
1983 "secondBandColor": {
1984 "$ref": "Color",
1985 "description": "The second color that is alternating. (Requi red)"
1986 } 1262 }
1987 }, 1263 },
1988 "type": "object" 1264 "type": "object"
1989 }, 1265 },
1990 "AddProtectedRangeResponse": { 1266 "AddProtectedRangeResponse": {
1991 "description": "The result of adding a new protected range.", 1267 "description": "The result of adding a new protected range.",
1992 "id": "AddProtectedRangeResponse", 1268 "id": "AddProtectedRangeResponse",
1993 "properties": { 1269 "properties": {
1994 "protectedRange": { 1270 "protectedRange": {
1995 "$ref": "ProtectedRange", 1271 "$ref": "ProtectedRange",
1996 "description": "The newly added protected range." 1272 "description": "The newly added protected range."
1997 } 1273 }
1998 }, 1274 },
1999 "type": "object" 1275 "type": "object"
2000 }, 1276 },
2001 "BasicFilter": { 1277 "BasicFilter": {
2002 "description": "The default filter associated with a sheet.", 1278 "description": "The default filter associated with a sheet.",
2003 "id": "BasicFilter", 1279 "id": "BasicFilter",
2004 "properties": { 1280 "properties": {
2005 "range": {
2006 "$ref": "GridRange",
2007 "description": "The range the filter covers."
2008 },
2009 "criteria": {
2010 "additionalProperties": {
2011 "$ref": "FilterCriteria"
2012 },
2013 "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.",
2014 "type": "object"
2015 },
2016 "sortSpecs": { 1281 "sortSpecs": {
2017 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 1282 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
2018 "items": { 1283 "items": {
2019 "$ref": "SortSpec" 1284 "$ref": "SortSpec"
2020 }, 1285 },
2021 "type": "array" 1286 "type": "array"
1287 },
1288 "range": {
1289 "$ref": "GridRange",
1290 "description": "The range the filter covers."
1291 },
1292 "criteria": {
1293 "additionalProperties": {
1294 "$ref": "FilterCriteria"
1295 },
1296 "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.",
1297 "type": "object"
1298 }
1299 },
1300 "type": "object"
1301 },
1302 "CandlestickSeries": {
1303 "description": "The series of a CandlestickData.",
1304 "id": "CandlestickSeries",
1305 "properties": {
1306 "data": {
1307 "$ref": "ChartData",
1308 "description": "The data of the CandlestickSeries."
1309 }
1310 },
1311 "type": "object"
1312 },
1313 "HistogramChartSpec": {
1314 "description": "A <a href=\"/chart/interactive/docs/gallery/histogra m\">histogram chart</a>.\nA histogram chart groups data items into bins, display ing each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\ nexplicitly.",
1315 "id": "HistogramChartSpec",
1316 "properties": {
1317 "legendPosition": {
1318 "description": "The position of the chart legend.",
1319 "enum": [
1320 "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
1321 "BOTTOM_LEGEND",
1322 "LEFT_LEGEND",
1323 "RIGHT_LEGEND",
1324 "TOP_LEGEND",
1325 "NO_LEGEND",
1326 "INSIDE_LEGEND"
1327 ],
1328 "enumDescriptions": [
1329 "Default value, do not use.",
1330 "The legend is rendered on the bottom of the chart.",
1331 "The legend is rendered on the left of the chart.",
1332 "The legend is rendered on the right of the chart.",
1333 "The legend is rendered on the top of the chart.",
1334 "No legend is rendered.",
1335 "The legend is rendered inside the chart area."
1336 ],
1337 "type": "string"
1338 },
1339 "bucketSize": {
1340 "description": "By default the bucket size (the range of val ues stacked in a single\ncolumn) is chosen automatically, but it may be overridd en here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
1341 "format": "double",
1342 "type": "number"
1343 },
1344 "outlierPercentile": {
1345 "description": "The outlier percentile is used to ensure tha t outliers do not adversely\naffect the calculation of bucket sizes. For exampl e, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% o f values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\ nMust be between 0.0 and 0.5.",
1346 "format": "double",
1347 "type": "number"
1348 },
1349 "showItemDividers": {
1350 "description": "Whether horizontal divider lines should be d isplayed between items in each\ncolumn.",
1351 "type": "boolean"
1352 },
1353 "series": {
1354 "description": "The series for a histogram may be either a s ingle series of values to be\nbucketed or multiple series, each of the same leng th, containing the name\nof the series followed by the values to be bucketed for that series.",
1355 "items": {
1356 "$ref": "HistogramSeries"
1357 },
1358 "type": "array"
2022 } 1359 }
2023 }, 1360 },
2024 "type": "object" 1361 "type": "object"
2025 }, 1362 },
2026 "UpdateValuesResponse": { 1363 "UpdateValuesResponse": {
2027 "description": "The response when updating a range of values in a sp readsheet.", 1364 "description": "The response when updating a range of values in a sp readsheet.",
2028 "id": "UpdateValuesResponse", 1365 "id": "UpdateValuesResponse",
2029 "properties": { 1366 "properties": {
1367 "spreadsheetId": {
1368 "description": "The spreadsheet the updates were applied to. ",
1369 "type": "string"
1370 },
1371 "updatedRange": {
1372 "description": "The range (in A1 notation) that updates were applied to.",
1373 "type": "string"
1374 },
1375 "updatedCells": {
1376 "description": "The number of cells updated.",
1377 "format": "int32",
1378 "type": "integer"
1379 },
2030 "updatedData": { 1380 "updatedData": {
2031 "$ref": "ValueRange", 1381 "$ref": "ValueRange",
2032 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`." 1382 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`."
2033 }, 1383 },
2034 "updatedRows": { 1384 "updatedRows": {
2035 "description": "The number of rows where at least one cell i n the row was updated.", 1385 "description": "The number of rows where at least one cell i n the row was updated.",
2036 "format": "int32", 1386 "format": "int32",
2037 "type": "integer" 1387 "type": "integer"
2038 }, 1388 },
2039 "updatedColumns": { 1389 "updatedColumns": {
2040 "description": "The number of columns where at least one cel l in the column was updated.", 1390 "description": "The number of columns where at least one cel l in the column was updated.",
2041 "format": "int32", 1391 "format": "int32",
2042 "type": "integer" 1392 "type": "integer"
2043 },
2044 "spreadsheetId": {
2045 "description": "The spreadsheet the updates were applied to. ",
2046 "type": "string"
2047 },
2048 "updatedRange": {
2049 "description": "The range (in A1 notation) that updates were applied to.",
2050 "type": "string"
2051 },
2052 "updatedCells": {
2053 "description": "The number of cells updated.",
2054 "format": "int32",
2055 "type": "integer"
2056 } 1393 }
2057 }, 1394 },
2058 "type": "object" 1395 "type": "object"
2059 }, 1396 },
2060 "PivotValue": { 1397 "PivotValue": {
2061 "description": "The definition of how a value in a pivot table shoul d be calculated.", 1398 "description": "The definition of how a value in a pivot table shoul d be calculated.",
2062 "id": "PivotValue", 1399 "id": "PivotValue",
2063 "properties": { 1400 "properties": {
2064 "sourceColumnOffset": { 1401 "sourceColumnOffset": {
2065 "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`.", 1402 "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`.",
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
2112 ], 1449 ],
2113 "type": "string" 1450 "type": "string"
2114 } 1451 }
2115 }, 1452 },
2116 "type": "object" 1453 "type": "object"
2117 }, 1454 },
2118 "ErrorValue": { 1455 "ErrorValue": {
2119 "description": "An error in a cell.", 1456 "description": "An error in a cell.",
2120 "id": "ErrorValue", 1457 "id": "ErrorValue",
2121 "properties": { 1458 "properties": {
1459 "message": {
1460 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
1461 "type": "string"
1462 },
2122 "type": { 1463 "type": {
2123 "description": "The type of error.", 1464 "description": "The type of error.",
2124 "enum": [ 1465 "enum": [
2125 "ERROR_TYPE_UNSPECIFIED", 1466 "ERROR_TYPE_UNSPECIFIED",
2126 "ERROR", 1467 "ERROR",
2127 "NULL_VALUE", 1468 "NULL_VALUE",
2128 "DIVIDE_BY_ZERO", 1469 "DIVIDE_BY_ZERO",
2129 "VALUE", 1470 "VALUE",
2130 "REF", 1471 "REF",
2131 "NAME", 1472 "NAME",
2132 "NUM", 1473 "NUM",
2133 "N_A", 1474 "N_A",
2134 "LOADING" 1475 "LOADING"
2135 ], 1476 ],
2136 "enumDescriptions": [ 1477 "enumDescriptions": [
2137 "The default error type, do not use this.", 1478 "The default error type, do not use this.",
2138 "Corresponds to the `#ERROR!` error.", 1479 "Corresponds to the `#ERROR!` error.",
2139 "Corresponds to the `#NULL!` error.", 1480 "Corresponds to the `#NULL!` error.",
2140 "Corresponds to the `#DIV/0` error.", 1481 "Corresponds to the `#DIV/0` error.",
2141 "Corresponds to the `#VALUE!` error.", 1482 "Corresponds to the `#VALUE!` error.",
2142 "Corresponds to the `#REF!` error.", 1483 "Corresponds to the `#REF!` error.",
2143 "Corresponds to the `#NAME?` error.", 1484 "Corresponds to the `#NAME?` error.",
2144 "Corresponds to the `#NUM`! error.", 1485 "Corresponds to the `#NUM`! error.",
2145 "Corresponds to the `#N/A` error.", 1486 "Corresponds to the `#N/A` error.",
2146 "Corresponds to the `Loading...` state." 1487 "Corresponds to the `Loading...` state."
2147 ], 1488 ],
2148 "type": "string" 1489 "type": "string"
2149 },
2150 "message": {
2151 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
2152 "type": "string"
2153 } 1490 }
2154 }, 1491 },
2155 "type": "object" 1492 "type": "object"
2156 }, 1493 },
2157 "CopySheetToAnotherSpreadsheetRequest": { 1494 "CopySheetToAnotherSpreadsheetRequest": {
2158 "description": "The request to copy a sheet across spreadsheets.", 1495 "description": "The request to copy a sheet across spreadsheets.",
2159 "id": "CopySheetToAnotherSpreadsheetRequest", 1496 "id": "CopySheetToAnotherSpreadsheetRequest",
2160 "properties": { 1497 "properties": {
2161 "destinationSpreadsheetId": { 1498 "destinationSpreadsheetId": {
2162 "description": "The ID of the spreadsheet to copy the sheet to.", 1499 "description": "The ID of the spreadsheet to copy the sheet to.",
(...skipping 14 matching lines...) Expand all
2177 "type": "array" 1514 "type": "array"
2178 }, 1515 },
2179 "valuesIndex": { 1516 "valuesIndex": {
2180 "description": "The offset in the PivotTable.values list whi ch the values in this\ngrouping should be sorted by.", 1517 "description": "The offset in the PivotTable.values list whi ch the values in this\ngrouping should be sorted by.",
2181 "format": "int32", 1518 "format": "int32",
2182 "type": "integer" 1519 "type": "integer"
2183 } 1520 }
2184 }, 1521 },
2185 "type": "object" 1522 "type": "object"
2186 }, 1523 },
1524 "CandlestickChartSpec": {
1525 "description": "A <a href=\"/chart/interactive/docs/gallery/candlest ickchart\">candlestick chart</a>.",
1526 "id": "CandlestickChartSpec",
1527 "properties": {
1528 "domain": {
1529 "$ref": "CandlestickDomain",
1530 "description": "The domain data (horizontal axis) for the ca ndlestick chart. String data\nwill be treated as discrete labels, other data wi ll be treated as continous\nvalues."
1531 },
1532 "data": {
1533 "description": "The Candlestick chart data.\nOnly one Candle stickData is supported.",
1534 "items": {
1535 "$ref": "CandlestickData"
1536 },
1537 "type": "array"
1538 }
1539 },
1540 "type": "object"
1541 },
1542 "CandlestickData": {
1543 "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
1544 "id": "CandlestickData",
1545 "properties": {
1546 "openSeries": {
1547 "$ref": "CandlestickSeries",
1548 "description": "The range data (vertical axis) for the open/ initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be h ollow."
1549 },
1550 "highSeries": {
1551 "$ref": "CandlestickSeries",
1552 "description": "The range data (vertical axis) for the high/ maximum value for each\ncandle. This is the top of the candle's center line."
1553 },
1554 "lowSeries": {
1555 "$ref": "CandlestickSeries",
1556 "description": "The range data (vertical axis) for the low/m inimum value for each candle.\nThis is the bottom of the candle's center line."
1557 },
1558 "closeSeries": {
1559 "$ref": "CandlestickSeries",
1560 "description": "The range data (vertical axis) for the close /final value for each candle.\nThis is the top of the candle body. If greater t han the open value the\ncandle will be filled. Otherwise the candle will be hol low."
1561 }
1562 },
1563 "type": "object"
1564 },
2187 "EmbeddedObjectPosition": { 1565 "EmbeddedObjectPosition": {
2188 "description": "The position of an embedded object such as a chart." , 1566 "description": "The position of an embedded object such as a chart." ,
2189 "id": "EmbeddedObjectPosition", 1567 "id": "EmbeddedObjectPosition",
2190 "properties": { 1568 "properties": {
2191 "newSheet": { 1569 "newSheet": {
2192 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.", 1570 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
2193 "type": "boolean" 1571 "type": "boolean"
2194 }, 1572 },
2195 "sheetId": { 1573 "sheetId": {
2196 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.", 1574 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.",
(...skipping 16 matching lines...) Expand all
2213 "format": "int32", 1591 "format": "int32",
2214 "type": "integer" 1592 "type": "integer"
2215 } 1593 }
2216 }, 1594 },
2217 "type": "object" 1595 "type": "object"
2218 }, 1596 },
2219 "AutoFillRequest": { 1597 "AutoFillRequest": {
2220 "description": "Fills in more data based on existing data.", 1598 "description": "Fills in more data based on existing data.",
2221 "id": "AutoFillRequest", 1599 "id": "AutoFillRequest",
2222 "properties": { 1600 "properties": {
1601 "sourceAndDestination": {
1602 "$ref": "SourceAndDestination",
1603 "description": "The source and destination areas to autofill .\nThis explicitly lists the source of the autofill and where to\nextend that da ta."
1604 },
2223 "range": { 1605 "range": {
2224 "$ref": "GridRange", 1606 "$ref": "GridRange",
2225 "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." 1607 "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."
2226 }, 1608 },
2227 "useAlternateSeries": { 1609 "useAlternateSeries": {
2228 "description": "True if we should generate data with the \"a lternate\" series.\nThis differs based on the type and amount of source data.", 1610 "description": "True if we should generate data with the \"a lternate\" series.\nThis differs based on the type and amount of source data.",
2229 "type": "boolean" 1611 "type": "boolean"
2230 },
2231 "sourceAndDestination": {
2232 "$ref": "SourceAndDestination",
2233 "description": "The source and destination areas to autofill .\nThis explicitly lists the source of the autofill and where to\nextend that da ta."
2234 } 1612 }
2235 }, 1613 },
2236 "type": "object" 1614 "type": "object"
2237 }, 1615 },
2238 "GradientRule": { 1616 "GradientRule": {
2239 "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.", 1617 "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.",
2240 "id": "GradientRule", 1618 "id": "GradientRule",
2241 "properties": { 1619 "properties": {
2242 "minpoint": { 1620 "minpoint": {
2243 "$ref": "InterpolationPoint", 1621 "$ref": "InterpolationPoint",
2244 "description": "The starting interpolation point." 1622 "description": "The starting interpolation point."
2245 }, 1623 },
2246 "maxpoint": { 1624 "maxpoint": {
2247 "$ref": "InterpolationPoint", 1625 "$ref": "InterpolationPoint",
2248 "description": "The final interpolation point." 1626 "description": "The final interpolation point."
2249 }, 1627 },
2250 "midpoint": { 1628 "midpoint": {
2251 "$ref": "InterpolationPoint", 1629 "$ref": "InterpolationPoint",
2252 "description": "An optional midway interpolation point." 1630 "description": "An optional midway interpolation point."
2253 } 1631 }
2254 }, 1632 },
2255 "type": "object" 1633 "type": "object"
2256 }, 1634 },
1635 "SetBasicFilterRequest": {
1636 "description": "Sets the basic filter associated with a sheet.",
1637 "id": "SetBasicFilterRequest",
1638 "properties": {
1639 "filter": {
1640 "$ref": "BasicFilter",
1641 "description": "The filter to set."
1642 }
1643 },
1644 "type": "object"
1645 },
2257 "ClearValuesRequest": { 1646 "ClearValuesRequest": {
2258 "description": "The request for clearing a range of values in a spre adsheet.", 1647 "description": "The request for clearing a range of values in a spre adsheet.",
2259 "id": "ClearValuesRequest", 1648 "id": "ClearValuesRequest",
2260 "properties": {}, 1649 "properties": {},
2261 "type": "object" 1650 "type": "object"
2262 }, 1651 },
2263 "SetBasicFilterRequest": {
2264 "description": "Sets the basic filter associated with a sheet.",
2265 "id": "SetBasicFilterRequest",
2266 "properties": {
2267 "filter": {
2268 "$ref": "BasicFilter",
2269 "description": "The filter to set."
2270 }
2271 },
2272 "type": "object"
2273 },
2274 "InterpolationPoint": { 1652 "InterpolationPoint": {
2275 "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.", 1653 "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.",
2276 "id": "InterpolationPoint", 1654 "id": "InterpolationPoint",
2277 "properties": { 1655 "properties": {
1656 "value": {
1657 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
1658 "type": "string"
1659 },
2278 "color": { 1660 "color": {
2279 "$ref": "Color", 1661 "$ref": "Color",
2280 "description": "The color this interpolation point should us e." 1662 "description": "The color this interpolation point should us e."
2281 }, 1663 },
2282 "type": { 1664 "type": {
2283 "description": "How the value should be interpreted.", 1665 "description": "How the value should be interpreted.",
2284 "enum": [ 1666 "enum": [
2285 "INTERPOLATION_POINT_TYPE_UNSPECIFIED", 1667 "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
2286 "MIN", 1668 "MIN",
2287 "MAX", 1669 "MAX",
2288 "NUMBER", 1670 "NUMBER",
2289 "PERCENT", 1671 "PERCENT",
2290 "PERCENTILE" 1672 "PERCENTILE"
2291 ], 1673 ],
2292 "enumDescriptions": [ 1674 "enumDescriptions": [
2293 "The default value, do not use.", 1675 "The default value, do not use.",
2294 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.", 1676 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.",
2295 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.", 1677 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.",
2296 "The interpolation point will use exactly the value in\n InterpolationPoint.value.", 1678 "The interpolation point will use exactly the value in\n InterpolationPoint.value.",
2297 "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).", 1679 "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).",
2298 "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)." 1680 "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)."
2299 ], 1681 ],
2300 "type": "string" 1682 "type": "string"
2301 },
2302 "value": {
2303 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
2304 "type": "string"
2305 } 1683 }
2306 }, 1684 },
2307 "type": "object" 1685 "type": "object"
2308 }, 1686 },
2309 "DeleteEmbeddedObjectRequest": { 1687 "DeleteEmbeddedObjectRequest": {
2310 "description": "Deletes the embedded object with the given ID.", 1688 "description": "Deletes the embedded object with the given ID.",
2311 "id": "DeleteEmbeddedObjectRequest", 1689 "id": "DeleteEmbeddedObjectRequest",
2312 "properties": { 1690 "properties": {
2313 "objectId": { 1691 "objectId": {
2314 "description": "The ID of the embedded object to delete.", 1692 "description": "The ID of the embedded object to delete.",
2315 "format": "int32", 1693 "format": "int32",
2316 "type": "integer" 1694 "type": "integer"
2317 } 1695 }
2318 }, 1696 },
2319 "type": "object" 1697 "type": "object"
2320 }, 1698 },
2321 "FindReplaceResponse": { 1699 "FindReplaceResponse": {
2322 "description": "The result of the find/replace.", 1700 "description": "The result of the find/replace.",
2323 "id": "FindReplaceResponse", 1701 "id": "FindReplaceResponse",
2324 "properties": { 1702 "properties": {
1703 "valuesChanged": {
1704 "description": "The number of non-formula cells changed.",
1705 "format": "int32",
1706 "type": "integer"
1707 },
2325 "occurrencesChanged": { 1708 "occurrencesChanged": {
2326 "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\"`.", 1709 "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\"`.",
2327 "format": "int32", 1710 "format": "int32",
2328 "type": "integer" 1711 "type": "integer"
2329 }, 1712 },
2330 "rowsChanged": { 1713 "rowsChanged": {
2331 "description": "The number of rows changed.", 1714 "description": "The number of rows changed.",
2332 "format": "int32", 1715 "format": "int32",
2333 "type": "integer" 1716 "type": "integer"
2334 }, 1717 },
2335 "sheetsChanged": { 1718 "sheetsChanged": {
2336 "description": "The number of sheets changed.", 1719 "description": "The number of sheets changed.",
2337 "format": "int32", 1720 "format": "int32",
2338 "type": "integer" 1721 "type": "integer"
2339 }, 1722 },
2340 "formulasChanged": { 1723 "formulasChanged": {
2341 "description": "The number of formula cells changed.", 1724 "description": "The number of formula cells changed.",
2342 "format": "int32", 1725 "format": "int32",
2343 "type": "integer" 1726 "type": "integer"
2344 }, 1727 }
2345 "valuesChanged": { 1728 },
2346 "description": "The number of non-formula cells changed.", 1729 "type": "object"
1730 },
1731 "DeleteSheetRequest": {
1732 "description": "Deletes the requested sheet.",
1733 "id": "DeleteSheetRequest",
1734 "properties": {
1735 "sheetId": {
1736 "description": "The ID of the sheet to delete.",
2347 "format": "int32", 1737 "format": "int32",
2348 "type": "integer" 1738 "type": "integer"
2349 } 1739 }
2350 }, 1740 },
2351 "type": "object" 1741 "type": "object"
2352 }, 1742 },
2353 "DuplicateFilterViewRequest": { 1743 "DuplicateFilterViewRequest": {
2354 "description": "Duplicates a particular filter view.", 1744 "description": "Duplicates a particular filter view.",
2355 "id": "DuplicateFilterViewRequest", 1745 "id": "DuplicateFilterViewRequest",
2356 "properties": { 1746 "properties": {
2357 "filterId": { 1747 "filterId": {
2358 "description": "The ID of the filter being duplicated.", 1748 "description": "The ID of the filter being duplicated.",
2359 "format": "int32", 1749 "format": "int32",
2360 "type": "integer" 1750 "type": "integer"
2361 } 1751 }
2362 }, 1752 },
2363 "type": "object" 1753 "type": "object"
2364 }, 1754 },
2365 "DeleteSheetRequest": {
2366 "description": "Deletes the requested sheet.",
2367 "id": "DeleteSheetRequest",
2368 "properties": {
2369 "sheetId": {
2370 "description": "The ID of the sheet to delete.",
2371 "format": "int32",
2372 "type": "integer"
2373 }
2374 },
2375 "type": "object"
2376 },
2377 "UpdateConditionalFormatRuleResponse": { 1755 "UpdateConditionalFormatRuleResponse": {
2378 "description": "The result of updating a conditional format rule.", 1756 "description": "The result of updating a conditional format rule.",
2379 "id": "UpdateConditionalFormatRuleResponse", 1757 "id": "UpdateConditionalFormatRuleResponse",
2380 "properties": { 1758 "properties": {
1759 "newIndex": {
1760 "description": "The index of the new rule.",
1761 "format": "int32",
1762 "type": "integer"
1763 },
1764 "oldIndex": {
1765 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
1766 "format": "int32",
1767 "type": "integer"
1768 },
1769 "newRule": {
1770 "$ref": "ConditionalFormatRule",
1771 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
1772 },
2381 "oldRule": { 1773 "oldRule": {
2382 "$ref": "ConditionalFormatRule", 1774 "$ref": "ConditionalFormatRule",
2383 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)." 1775 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)."
2384 },
2385 "newIndex": {
2386 "description": "The index of the new rule.",
2387 "format": "int32",
2388 "type": "integer"
2389 },
2390 "oldIndex": {
2391 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
2392 "format": "int32",
2393 "type": "integer"
2394 },
2395 "newRule": {
2396 "$ref": "ConditionalFormatRule",
2397 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
2398 }
2399 },
2400 "type": "object"
2401 },
2402 "DuplicateSheetRequest": {
2403 "description": "Duplicates the contents of a sheet.",
2404 "id": "DuplicateSheetRequest",
2405 "properties": {
2406 "newSheetName": {
2407 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
2408 "type": "string"
2409 },
2410 "sourceSheetId": {
2411 "description": "The sheet to duplicate.",
2412 "format": "int32",
2413 "type": "integer"
2414 },
2415 "newSheetId": {
2416 "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.",
2417 "format": "int32",
2418 "type": "integer"
2419 },
2420 "insertSheetIndex": {
2421 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
2422 "format": "int32",
2423 "type": "integer"
2424 } 1776 }
2425 }, 1777 },
2426 "type": "object" 1778 "type": "object"
2427 }, 1779 },
2428 "ConditionValue": { 1780 "ConditionValue": {
2429 "description": "The value of the condition.", 1781 "description": "The value of the condition.",
2430 "id": "ConditionValue", 1782 "id": "ConditionValue",
2431 "properties": { 1783 "properties": {
2432 "relativeDate": { 1784 "relativeDate": {
2433 "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.", 1785 "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.",
(...skipping 17 matching lines...) Expand all
2451 ], 1803 ],
2452 "type": "string" 1804 "type": "string"
2453 }, 1805 },
2454 "userEnteredValue": { 1806 "userEnteredValue": {
2455 "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 `=`).", 1807 "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 `=`).",
2456 "type": "string" 1808 "type": "string"
2457 } 1809 }
2458 }, 1810 },
2459 "type": "object" 1811 "type": "object"
2460 }, 1812 },
1813 "DuplicateSheetRequest": {
1814 "description": "Duplicates the contents of a sheet.",
1815 "id": "DuplicateSheetRequest",
1816 "properties": {
1817 "newSheetName": {
1818 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
1819 "type": "string"
1820 },
1821 "sourceSheetId": {
1822 "description": "The sheet to duplicate.",
1823 "format": "int32",
1824 "type": "integer"
1825 },
1826 "newSheetId": {
1827 "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.",
1828 "format": "int32",
1829 "type": "integer"
1830 },
1831 "insertSheetIndex": {
1832 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
1833 "format": "int32",
1834 "type": "integer"
1835 }
1836 },
1837 "type": "object"
1838 },
2461 "ExtendedValue": { 1839 "ExtendedValue": {
2462 "description": "The kinds of value that a cell in a spreadsheet can have.", 1840 "description": "The kinds of value that a cell in a spreadsheet can have.",
2463 "id": "ExtendedValue", 1841 "id": "ExtendedValue",
2464 "properties": { 1842 "properties": {
1843 "errorValue": {
1844 "$ref": "ErrorValue",
1845 "description": "Represents an error.\nThis field is read-onl y."
1846 },
1847 "stringValue": {
1848 "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\"`.",
1849 "type": "string"
1850 },
1851 "boolValue": {
1852 "description": "Represents a boolean value.",
1853 "type": "boolean"
1854 },
1855 "formulaValue": {
1856 "description": "Represents a formula.",
1857 "type": "string"
1858 },
2465 "numberValue": { 1859 "numberValue": {
2466 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.", 1860 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.",
2467 "format": "double", 1861 "format": "double",
2468 "type": "number" 1862 "type": "number"
2469 },
2470 "errorValue": {
2471 "$ref": "ErrorValue",
2472 "description": "Represents an error.\nThis field is read-onl y."
2473 },
2474 "stringValue": {
2475 "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\"`.",
2476 "type": "string"
2477 },
2478 "boolValue": {
2479 "description": "Represents a boolean value.",
2480 "type": "boolean"
2481 },
2482 "formulaValue": {
2483 "description": "Represents a formula.",
2484 "type": "string"
2485 } 1863 }
2486 }, 1864 },
2487 "type": "object" 1865 "type": "object"
2488 }, 1866 },
2489 "BandedRange": { 1867 "BandedRange": {
2490 "description": "A banded (alternating colors) range in a sheet.", 1868 "description": "A banded (alternating colors) range in a sheet.",
2491 "id": "BandedRange", 1869 "id": "BandedRange",
2492 "properties": { 1870 "properties": {
2493 "bandedRangeId": { 1871 "bandedRangeId": {
2494 "description": "The id of the banded range.", 1872 "description": "The id of the banded range.",
2495 "format": "int32", 1873 "format": "int32",
2496 "type": "integer" 1874 "type": "integer"
2497 }, 1875 },
2498 "rowProperties": { 1876 "rowProperties": {
2499 "$ref": "BandingProperties", 1877 "$ref": "BandingProperties",
2500 "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." 1878 "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."
2501 }, 1879 },
2502 "columnProperties": { 1880 "columnProperties": {
2503 "$ref": "BandingProperties", 1881 "$ref": "BandingProperties",
2504 "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. " 1882 "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. "
2505 }, 1883 },
2506 "range": { 1884 "range": {
2507 "$ref": "GridRange", 1885 "$ref": "GridRange",
2508 "description": "The range over which these properties are ap plied." 1886 "description": "The range over which these properties are ap plied."
2509 } 1887 }
2510 }, 1888 },
2511 "type": "object" 1889 "type": "object"
2512 }, 1890 },
1891 "HistogramSeries": {
1892 "description": "A histogram series containing the series color and d ata.",
1893 "id": "HistogramSeries",
1894 "properties": {
1895 "barColor": {
1896 "$ref": "Color",
1897 "description": "The color of the column representing this se ries in each bucket.\nThis field is optional."
1898 },
1899 "data": {
1900 "$ref": "ChartData",
1901 "description": "The data for this histogram series."
1902 }
1903 },
1904 "type": "object"
1905 },
2513 "BatchClearValuesResponse": { 1906 "BatchClearValuesResponse": {
2514 "description": "The response when clearing a range of values in a sp readsheet.", 1907 "description": "The response when clearing a range of values in a sp readsheet.",
2515 "id": "BatchClearValuesResponse", 1908 "id": "BatchClearValuesResponse",
2516 "properties": { 1909 "properties": {
2517 "spreadsheetId": {
2518 "description": "The spreadsheet the updates were applied to. ",
2519 "type": "string"
2520 },
2521 "clearedRanges": { 1910 "clearedRanges": {
2522 "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.)", 1911 "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.)",
2523 "items": { 1912 "items": {
2524 "type": "string" 1913 "type": "string"
2525 }, 1914 },
2526 "type": "array" 1915 "type": "array"
1916 },
1917 "spreadsheetId": {
1918 "description": "The spreadsheet the updates were applied to. ",
1919 "type": "string"
2527 } 1920 }
2528 }, 1921 },
2529 "type": "object" 1922 "type": "object"
2530 }, 1923 },
2531 "Spreadsheet": { 1924 "Spreadsheet": {
2532 "description": "Resource that represents a spreadsheet.", 1925 "description": "Resource that represents a spreadsheet.",
2533 "id": "Spreadsheet", 1926 "id": "Spreadsheet",
2534 "properties": { 1927 "properties": {
2535 "properties": { 1928 "properties": {
2536 "$ref": "SpreadsheetProperties", 1929 "$ref": "SpreadsheetProperties",
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
2585 "format": "google-fieldmask", 1978 "format": "google-fieldmask",
2586 "type": "string" 1979 "type": "string"
2587 } 1980 }
2588 }, 1981 },
2589 "type": "object" 1982 "type": "object"
2590 }, 1983 },
2591 "TextFormat": { 1984 "TextFormat": {
2592 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.", 1985 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.",
2593 "id": "TextFormat", 1986 "id": "TextFormat",
2594 "properties": { 1987 "properties": {
1988 "underline": {
1989 "description": "True if the text is underlined.",
1990 "type": "boolean"
1991 },
2595 "foregroundColor": { 1992 "foregroundColor": {
2596 "$ref": "Color", 1993 "$ref": "Color",
2597 "description": "The foreground color of the text." 1994 "description": "The foreground color of the text."
2598 }, 1995 },
2599 "bold": { 1996 "bold": {
2600 "description": "True if the text is bold.", 1997 "description": "True if the text is bold.",
2601 "type": "boolean" 1998 "type": "boolean"
2602 }, 1999 },
2603 "fontFamily": { 2000 "fontFamily": {
2604 "description": "The font family.", 2001 "description": "The font family.",
2605 "type": "string" 2002 "type": "string"
2606 }, 2003 },
2607 "strikethrough": { 2004 "strikethrough": {
2608 "description": "True if the text has a strikethrough.", 2005 "description": "True if the text has a strikethrough.",
2609 "type": "boolean" 2006 "type": "boolean"
2610 }, 2007 },
2611 "italic": { 2008 "italic": {
2612 "description": "True if the text is italicized.", 2009 "description": "True if the text is italicized.",
2613 "type": "boolean" 2010 "type": "boolean"
2614 }, 2011 },
2615 "fontSize": { 2012 "fontSize": {
2616 "description": "The size of the font.", 2013 "description": "The size of the font.",
2617 "format": "int32", 2014 "format": "int32",
2618 "type": "integer" 2015 "type": "integer"
2619 },
2620 "underline": {
2621 "description": "True if the text is underlined.",
2622 "type": "boolean"
2623 } 2016 }
2624 }, 2017 },
2625 "type": "object" 2018 "type": "object"
2626 }, 2019 },
2627 "AddSheetResponse": { 2020 "AddSheetResponse": {
2628 "description": "The result of adding a sheet.", 2021 "description": "The result of adding a sheet.",
2629 "id": "AddSheetResponse", 2022 "id": "AddSheetResponse",
2630 "properties": { 2023 "properties": {
2631 "properties": { 2024 "properties": {
2632 "$ref": "SheetProperties", 2025 "$ref": "SheetProperties",
(...skipping 23 matching lines...) Expand all
2656 "type": "number" 2049 "type": "number"
2657 }, 2050 },
2658 "maxIterations": { 2051 "maxIterations": {
2659 "description": "When iterative calculation is enabled, the m aximum number of calculation\nrounds to perform.", 2052 "description": "When iterative calculation is enabled, the m aximum number of calculation\nrounds to perform.",
2660 "format": "int32", 2053 "format": "int32",
2661 "type": "integer" 2054 "type": "integer"
2662 } 2055 }
2663 }, 2056 },
2664 "type": "object" 2057 "type": "object"
2665 }, 2058 },
2059 "OverlayPosition": {
2060 "description": "The location an object is overlaid on top of a grid. ",
2061 "id": "OverlayPosition",
2062 "properties": {
2063 "offsetXPixels": {
2064 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.",
2065 "format": "int32",
2066 "type": "integer"
2067 },
2068 "anchorCell": {
2069 "$ref": "GridCoordinate",
2070 "description": "The cell the object is anchored to."
2071 },
2072 "offsetYPixels": {
2073 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
2074 "format": "int32",
2075 "type": "integer"
2076 },
2077 "heightPixels": {
2078 "description": "The height of the object, in pixels. Default s to 371.",
2079 "format": "int32",
2080 "type": "integer"
2081 },
2082 "widthPixels": {
2083 "description": "The width of the object, in pixels. Defaults to 600.",
2084 "format": "int32",
2085 "type": "integer"
2086 }
2087 },
2088 "type": "object"
2089 },
2666 "SpreadsheetProperties": { 2090 "SpreadsheetProperties": {
2667 "description": "Properties of a spreadsheet.", 2091 "description": "Properties of a spreadsheet.",
2668 "id": "SpreadsheetProperties", 2092 "id": "SpreadsheetProperties",
2669 "properties": { 2093 "properties": {
2094 "iterativeCalculationSettings": {
2095 "$ref": "IterativeCalculationSettings",
2096 "description": "Determines whether and how circular referenc es are resolved with iterative\ncalculation. Absence of this field means that c ircular references will\nresult in calculation errors."
2097 },
2098 "defaultFormat": {
2099 "$ref": "CellFormat",
2100 "description": "The default format of all cells in the sprea dsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
2101 },
2670 "autoRecalc": { 2102 "autoRecalc": {
2671 "description": "The amount of time to wait before volatile f unctions are recalculated.", 2103 "description": "The amount of time to wait before volatile f unctions are recalculated.",
2672 "enum": [ 2104 "enum": [
2673 "RECALCULATION_INTERVAL_UNSPECIFIED", 2105 "RECALCULATION_INTERVAL_UNSPECIFIED",
2674 "ON_CHANGE", 2106 "ON_CHANGE",
2675 "MINUTE", 2107 "MINUTE",
2676 "HOUR" 2108 "HOUR"
2677 ], 2109 ],
2678 "enumDescriptions": [ 2110 "enumDescriptions": [
2679 "Default value. This value must not be used.", 2111 "Default value. This value must not be used.",
2680 "Volatile functions are updated on every change.", 2112 "Volatile functions are updated on every change.",
2681 "Volatile functions are updated on every change and ever y minute.", 2113 "Volatile functions are updated on every change and ever y minute.",
2682 "Volatile functions are updated on every change and hour ly." 2114 "Volatile functions are updated on every change and hour ly."
2683 ], 2115 ],
2684 "type": "string" 2116 "type": "string"
2685 }, 2117 },
2686 "defaultFormat": {
2687 "$ref": "CellFormat",
2688 "description": "The default format of all cells in the sprea dsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
2689 },
2690 "title": { 2118 "title": {
2691 "description": "The title of the spreadsheet.", 2119 "description": "The title of the spreadsheet.",
2692 "type": "string" 2120 "type": "string"
2693 }, 2121 },
2694 "timeZone": { 2122 "timeZone": {
2695 "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`.", 2123 "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`.",
2696 "type": "string" 2124 "type": "string"
2697 }, 2125 },
2698 "locale": { 2126 "locale": {
2699 "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.", 2127 "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.",
2700 "type": "string" 2128 "type": "string"
2701 },
2702 "iterativeCalculationSettings": {
2703 "$ref": "IterativeCalculationSettings",
2704 "description": "Determines whether and how circular referenc es are resolved with iterative\ncalculation. Absence of this field means that c ircular references will\nresult in calculation errors."
2705 }
2706 },
2707 "type": "object"
2708 },
2709 "OverlayPosition": {
2710 "description": "The location an object is overlaid on top of a grid. ",
2711 "id": "OverlayPosition",
2712 "properties": {
2713 "widthPixels": {
2714 "description": "The width of the object, in pixels. Defaults to 600.",
2715 "format": "int32",
2716 "type": "integer"
2717 },
2718 "offsetXPixels": {
2719 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.",
2720 "format": "int32",
2721 "type": "integer"
2722 },
2723 "anchorCell": {
2724 "$ref": "GridCoordinate",
2725 "description": "The cell the object is anchored to."
2726 },
2727 "offsetYPixels": {
2728 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
2729 "format": "int32",
2730 "type": "integer"
2731 },
2732 "heightPixels": {
2733 "description": "The height of the object, in pixels. Default s to 371.",
2734 "format": "int32",
2735 "type": "integer"
2736 } 2129 }
2737 }, 2130 },
2738 "type": "object" 2131 "type": "object"
2739 }, 2132 },
2740 "RepeatCellRequest": { 2133 "RepeatCellRequest": {
2741 "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. ", 2134 "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. ",
2742 "id": "RepeatCellRequest", 2135 "id": "RepeatCellRequest",
2743 "properties": { 2136 "properties": {
2744 "range": { 2137 "range": {
2745 "$ref": "GridRange", 2138 "$ref": "GridRange",
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
2792 "description": "The properties to update." 2185 "description": "The properties to update."
2793 }, 2186 },
2794 "fields": { 2187 "fields": {
2795 "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 .", 2188 "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 .",
2796 "format": "google-fieldmask", 2189 "format": "google-fieldmask",
2797 "type": "string" 2190 "type": "string"
2798 } 2191 }
2799 }, 2192 },
2800 "type": "object" 2193 "type": "object"
2801 }, 2194 },
2195 "ProtectedRange": {
2196 "description": "A protected range.",
2197 "id": "ProtectedRange",
2198 "properties": {
2199 "warningOnly": {
2200 "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.",
2201 "type": "boolean"
2202 },
2203 "requestingUserCanEdit": {
2204 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
2205 "type": "boolean"
2206 },
2207 "editors": {
2208 "$ref": "Editors",
2209 "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."
2210 },
2211 "range": {
2212 "$ref": "GridRange",
2213 "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."
2214 },
2215 "description": {
2216 "description": "The description of this protected range.",
2217 "type": "string"
2218 },
2219 "unprotectedRanges": {
2220 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.",
2221 "items": {
2222 "$ref": "GridRange"
2223 },
2224 "type": "array"
2225 },
2226 "namedRangeId": {
2227 "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. ",
2228 "type": "string"
2229 },
2230 "protectedRangeId": {
2231 "description": "The ID of the protected range.\nThis field i s read-only.",
2232 "format": "int32",
2233 "type": "integer"
2234 }
2235 },
2236 "type": "object"
2237 },
2802 "BatchUpdateValuesRequest": { 2238 "BatchUpdateValuesRequest": {
2803 "description": "The request for updating more than one range of valu es in a spreadsheet.", 2239 "description": "The request for updating more than one range of valu es in a spreadsheet.",
2804 "id": "BatchUpdateValuesRequest", 2240 "id": "BatchUpdateValuesRequest",
2805 "properties": { 2241 "properties": {
2806 "responseValueRenderOption": { 2242 "responseValueRenderOption": {
2807 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", 2243 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
2808 "enum": [ 2244 "enum": [
2809 "FORMATTED_VALUE", 2245 "FORMATTED_VALUE",
2810 "UNFORMATTED_VALUE", 2246 "UNFORMATTED_VALUE",
2811 "FORMULA" 2247 "FORMULA"
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
2850 ], 2286 ],
2851 "enumDescriptions": [ 2287 "enumDescriptions": [
2852 "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.", 2288 "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.",
2853 "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)." 2289 "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)."
2854 ], 2290 ],
2855 "type": "string" 2291 "type": "string"
2856 } 2292 }
2857 }, 2293 },
2858 "type": "object" 2294 "type": "object"
2859 }, 2295 },
2860 "ProtectedRange": {
2861 "description": "A protected range.",
2862 "id": "ProtectedRange",
2863 "properties": {
2864 "warningOnly": {
2865 "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.",
2866 "type": "boolean"
2867 },
2868 "requestingUserCanEdit": {
2869 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
2870 "type": "boolean"
2871 },
2872 "range": {
2873 "$ref": "GridRange",
2874 "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."
2875 },
2876 "editors": {
2877 "$ref": "Editors",
2878 "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."
2879 },
2880 "description": {
2881 "description": "The description of this protected range.",
2882 "type": "string"
2883 },
2884 "unprotectedRanges": {
2885 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.",
2886 "items": {
2887 "$ref": "GridRange"
2888 },
2889 "type": "array"
2890 },
2891 "namedRangeId": {
2892 "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. ",
2893 "type": "string"
2894 },
2895 "protectedRangeId": {
2896 "description": "The ID of the protected range.\nThis field i s read-only.",
2897 "format": "int32",
2898 "type": "integer"
2899 }
2900 },
2901 "type": "object"
2902 },
2903 "DimensionProperties": { 2296 "DimensionProperties": {
2904 "description": "Properties about a dimension.", 2297 "description": "Properties about a dimension.",
2905 "id": "DimensionProperties", 2298 "id": "DimensionProperties",
2906 "properties": { 2299 "properties": {
2907 "pixelSize": { 2300 "pixelSize": {
2908 "description": "The height (if a row) or width (if a column) of the dimension in pixels.", 2301 "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
2909 "format": "int32", 2302 "format": "int32",
2910 "type": "integer" 2303 "type": "integer"
2911 }, 2304 },
2912 "hiddenByFilter": { 2305 "hiddenByFilter": {
2913 "description": "True if this dimension is being filtered.\nT his field is read-only.", 2306 "description": "True if this dimension is being filtered.\nT his field is read-only.",
2914 "type": "boolean" 2307 "type": "boolean"
2915 }, 2308 },
2916 "hiddenByUser": { 2309 "hiddenByUser": {
2917 "description": "True if this dimension is explicitly hidden. ", 2310 "description": "True if this dimension is explicitly hidden. ",
2918 "type": "boolean" 2311 "type": "boolean"
2919 } 2312 }
2920 }, 2313 },
2921 "type": "object" 2314 "type": "object"
2922 }, 2315 },
2316 "DimensionRange": {
2317 "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.",
2318 "id": "DimensionRange",
2319 "properties": {
2320 "dimension": {
2321 "description": "The dimension of the span.",
2322 "enum": [
2323 "DIMENSION_UNSPECIFIED",
2324 "ROWS",
2325 "COLUMNS"
2326 ],
2327 "enumDescriptions": [
2328 "The default value, do not use.",
2329 "Operates on the rows of a sheet.",
2330 "Operates on the columns of a sheet."
2331 ],
2332 "type": "string"
2333 },
2334 "startIndex": {
2335 "description": "The start (inclusive) of the span, or not se t if unbounded.",
2336 "format": "int32",
2337 "type": "integer"
2338 },
2339 "endIndex": {
2340 "description": "The end (exclusive) of the span, or not set if unbounded.",
2341 "format": "int32",
2342 "type": "integer"
2343 },
2344 "sheetId": {
2345 "description": "The sheet this span is on.",
2346 "format": "int32",
2347 "type": "integer"
2348 }
2349 },
2350 "type": "object"
2351 },
2923 "NamedRange": { 2352 "NamedRange": {
2924 "description": "A named range.", 2353 "description": "A named range.",
2925 "id": "NamedRange", 2354 "id": "NamedRange",
2926 "properties": { 2355 "properties": {
2927 "namedRangeId": { 2356 "namedRangeId": {
2928 "description": "The ID of the named range.", 2357 "description": "The ID of the named range.",
2929 "type": "string" 2358 "type": "string"
2930 }, 2359 },
2931 "range": { 2360 "range": {
2932 "$ref": "GridRange", 2361 "$ref": "GridRange",
2933 "description": "The range this represents." 2362 "description": "The range this represents."
2934 }, 2363 },
2935 "name": { 2364 "name": {
2936 "description": "The name of the named range.", 2365 "description": "The name of the named range.",
2937 "type": "string" 2366 "type": "string"
2938 } 2367 }
2939 }, 2368 },
2940 "type": "object" 2369 "type": "object"
2941 }, 2370 },
2942 "DimensionRange": { 2371 "CutPasteRequest": {
2943 "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.", 2372 "description": "Moves data from the source to the destination.",
2944 "id": "DimensionRange", 2373 "id": "CutPasteRequest",
2945 "properties": { 2374 "properties": {
2946 "dimension": { 2375 "source": {
2947 "description": "The dimension of the span.", 2376 "$ref": "GridRange",
2377 "description": "The source data to cut."
2378 },
2379 "pasteType": {
2380 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
2381 "enum": [
2382 "PASTE_NORMAL",
2383 "PASTE_VALUES",
2384 "PASTE_FORMAT",
2385 "PASTE_NO_BORDERS",
2386 "PASTE_FORMULA",
2387 "PASTE_DATA_VALIDATION",
2388 "PASTE_CONDITIONAL_FORMATTING"
2389 ],
2390 "enumDescriptions": [
2391 "Paste values, formulas, formats, and merges.",
2392 "Paste the values ONLY without formats, formulas, or mer ges.",
2393 "Paste the format and data validation only.",
2394 "Like PASTE_NORMAL but without borders.",
2395 "Paste the formulas only.",
2396 "Paste the data validation only.",
2397 "Paste the conditional formatting rules only."
2398 ],
2399 "type": "string"
2400 },
2401 "destination": {
2402 "$ref": "GridCoordinate",
2403 "description": "The top-left coordinate where the data shoul d be pasted."
2404 }
2405 },
2406 "type": "object"
2407 },
2408 "BasicChartSeries": {
2409 "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\".",
2410 "id": "BasicChartSeries",
2411 "properties": {
2412 "targetAxis": {
2413 "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.",
2414 "enum": [
2415 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
2416 "BOTTOM_AXIS",
2417 "LEFT_AXIS",
2418 "RIGHT_AXIS"
2419 ],
2420 "enumDescriptions": [
2421 "Default value, do not use.",
2422 "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.",
2423 "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.",
2424 "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."
2425 ],
2426 "type": "string"
2427 },
2428 "series": {
2429 "$ref": "ChartData",
2430 "description": "The data being visualized in this chart seri es."
2431 },
2432 "type": {
2433 "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.",
2434 "enum": [
2435 "BASIC_CHART_TYPE_UNSPECIFIED",
2436 "BAR",
2437 "LINE",
2438 "AREA",
2439 "COLUMN",
2440 "SCATTER",
2441 "COMBO",
2442 "STEPPED_AREA"
2443 ],
2444 "enumDescriptions": [
2445 "Default value, do not use.",
2446 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
2447 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
2448 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
2449 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
2450 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
2451 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
2452 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
2453 ],
2454 "type": "string"
2455 }
2456 },
2457 "type": "object"
2458 },
2459 "Borders": {
2460 "description": "The borders of the cell.",
2461 "id": "Borders",
2462 "properties": {
2463 "right": {
2464 "$ref": "Border",
2465 "description": "The right border of the cell."
2466 },
2467 "bottom": {
2468 "$ref": "Border",
2469 "description": "The bottom border of the cell."
2470 },
2471 "top": {
2472 "$ref": "Border",
2473 "description": "The top border of the cell."
2474 },
2475 "left": {
2476 "$ref": "Border",
2477 "description": "The left border of the cell."
2478 }
2479 },
2480 "type": "object"
2481 },
2482 "AutoResizeDimensionsRequest": {
2483 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
2484 "id": "AutoResizeDimensionsRequest",
2485 "properties": {
2486 "dimensions": {
2487 "$ref": "DimensionRange",
2488 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
2489 }
2490 },
2491 "type": "object"
2492 },
2493 "UpdateBordersRequest": {
2494 "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.",
2495 "id": "UpdateBordersRequest",
2496 "properties": {
2497 "right": {
2498 "$ref": "Border",
2499 "description": "The border to put at the right of the range. "
2500 },
2501 "range": {
2502 "$ref": "GridRange",
2503 "description": "The range whose borders should be updated."
2504 },
2505 "innerHorizontal": {
2506 "$ref": "Border",
2507 "description": "The horizontal border to put within the rang e."
2508 },
2509 "top": {
2510 "$ref": "Border",
2511 "description": "The border to put at the top of the range."
2512 },
2513 "left": {
2514 "$ref": "Border",
2515 "description": "The border to put at the left of the range."
2516 },
2517 "bottom": {
2518 "$ref": "Border",
2519 "description": "The border to put at the bottom of the range ."
2520 },
2521 "innerVertical": {
2522 "$ref": "Border",
2523 "description": "The vertical border to put within the range. "
2524 }
2525 },
2526 "type": "object"
2527 },
2528 "CellFormat": {
2529 "description": "The format of a cell.",
2530 "id": "CellFormat",
2531 "properties": {
2532 "numberFormat": {
2533 "$ref": "NumberFormat",
2534 "description": "A format describing how number values should be represented to the user."
2535 },
2536 "hyperlinkDisplayType": {
2537 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
2538 "enum": [
2539 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
2540 "LINKED",
2541 "PLAIN_TEXT"
2542 ],
2543 "enumDescriptions": [
2544 "The default value: the hyperlink is rendered. Do not us e this.",
2545 "A hyperlink should be explicitly rendered.",
2546 "A hyperlink should not be rendered."
2547 ],
2548 "type": "string"
2549 },
2550 "horizontalAlignment": {
2551 "description": "The horizontal alignment of the value in the cell.",
2552 "enum": [
2553 "HORIZONTAL_ALIGN_UNSPECIFIED",
2554 "LEFT",
2555 "CENTER",
2556 "RIGHT"
2557 ],
2558 "enumDescriptions": [
2559 "The horizontal alignment is not specified. Do not use t his.",
2560 "The text is explicitly aligned to the left of the cell. ",
2561 "The text is explicitly aligned to the center of the cel l.",
2562 "The text is explicitly aligned to the right of the cell ."
2563 ],
2564 "type": "string"
2565 },
2566 "textFormat": {
2567 "$ref": "TextFormat",
2568 "description": "The format of the text in the cell (unless o verridden by a format run)."
2569 },
2570 "backgroundColor": {
2571 "$ref": "Color",
2572 "description": "The background color of the cell."
2573 },
2574 "verticalAlignment": {
2575 "description": "The vertical alignment of the value in the c ell.",
2576 "enum": [
2577 "VERTICAL_ALIGN_UNSPECIFIED",
2578 "TOP",
2579 "MIDDLE",
2580 "BOTTOM"
2581 ],
2582 "enumDescriptions": [
2583 "The vertical alignment is not specified. Do not use th is.",
2584 "The text is explicitly aligned to the top of the cell." ,
2585 "The text is explicitly aligned to the middle of the cel l.",
2586 "The text is explicitly aligned to the bottom of the cel l."
2587 ],
2588 "type": "string"
2589 },
2590 "padding": {
2591 "$ref": "Padding",
2592 "description": "The padding of the cell."
2593 },
2594 "borders": {
2595 "$ref": "Borders",
2596 "description": "The borders of the cell."
2597 },
2598 "textDirection": {
2599 "description": "The direction of the text in the cell.",
2600 "enum": [
2601 "TEXT_DIRECTION_UNSPECIFIED",
2602 "LEFT_TO_RIGHT",
2603 "RIGHT_TO_LEFT"
2604 ],
2605 "enumDescriptions": [
2606 "The text direction is not specified. Do not use this.",
2607 "The text direction of left-to-right was set by the user .",
2608 "The text direction of right-to-left was set by the user ."
2609 ],
2610 "type": "string"
2611 },
2612 "textRotation": {
2613 "$ref": "TextRotation",
2614 "description": "The rotation applied to text in a cell"
2615 },
2616 "wrapStrategy": {
2617 "description": "The wrap strategy for the value in the cell. ",
2618 "enum": [
2619 "WRAP_STRATEGY_UNSPECIFIED",
2620 "OVERFLOW_CELL",
2621 "LEGACY_WRAP",
2622 "CLIP",
2623 "WRAP"
2624 ],
2625 "enumDescriptions": [
2626 "The default value, do not use.",
2627 "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. |",
2628 "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. |",
2629 "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. |",
2630 "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. |"
2631 ],
2632 "type": "string"
2633 }
2634 },
2635 "type": "object"
2636 },
2637 "ClearValuesResponse": {
2638 "description": "The response when clearing a range of values in a sp readsheet.",
2639 "id": "ClearValuesResponse",
2640 "properties": {
2641 "spreadsheetId": {
2642 "description": "The spreadsheet the updates were applied to. ",
2643 "type": "string"
2644 },
2645 "clearedRange": {
2646 "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.)",
2647 "type": "string"
2648 }
2649 },
2650 "type": "object"
2651 },
2652 "DeleteConditionalFormatRuleRequest": {
2653 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
2654 "id": "DeleteConditionalFormatRuleRequest",
2655 "properties": {
2656 "index": {
2657 "description": "The zero-based index of the rule to be delet ed.",
2658 "format": "int32",
2659 "type": "integer"
2660 },
2661 "sheetId": {
2662 "description": "The sheet the rule is being deleted from.",
2663 "format": "int32",
2664 "type": "integer"
2665 }
2666 },
2667 "type": "object"
2668 },
2669 "AddBandingResponse": {
2670 "description": "The result of adding a banded range.",
2671 "id": "AddBandingResponse",
2672 "properties": {
2673 "bandedRange": {
2674 "$ref": "BandedRange",
2675 "description": "The banded range that was added."
2676 }
2677 },
2678 "type": "object"
2679 },
2680 "DeleteNamedRangeRequest": {
2681 "description": "Removes the named range with the given ID from the s preadsheet.",
2682 "id": "DeleteNamedRangeRequest",
2683 "properties": {
2684 "namedRangeId": {
2685 "description": "The ID of the named range to delete.",
2686 "type": "string"
2687 }
2688 },
2689 "type": "object"
2690 },
2691 "ChartData": {
2692 "description": "The data included in a domain or series.",
2693 "id": "ChartData",
2694 "properties": {
2695 "sourceRange": {
2696 "$ref": "ChartSourceRange",
2697 "description": "The source ranges of the data."
2698 }
2699 },
2700 "type": "object"
2701 },
2702 "BatchGetValuesResponse": {
2703 "description": "The response when retrieving more than one range of values in a spreadsheet.",
2704 "id": "BatchGetValuesResponse",
2705 "properties": {
2706 "spreadsheetId": {
2707 "description": "The ID of the spreadsheet the data was retri eved from.",
2708 "type": "string"
2709 },
2710 "valueRanges": {
2711 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
2712 "items": {
2713 "$ref": "ValueRange"
2714 },
2715 "type": "array"
2716 }
2717 },
2718 "type": "object"
2719 },
2720 "UpdateBandingRequest": {
2721 "description": "Updates properties of the supplied banded range.",
2722 "id": "UpdateBandingRequest",
2723 "properties": {
2724 "fields": {
2725 "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.",
2726 "format": "google-fieldmask",
2727 "type": "string"
2728 },
2729 "bandedRange": {
2730 "$ref": "BandedRange",
2731 "description": "The banded range to update with the new prop erties."
2732 }
2733 },
2734 "type": "object"
2735 },
2736 "Color": {
2737 "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 // ...",
2738 "id": "Color",
2739 "properties": {
2740 "red": {
2741 "description": "The amount of red in the color as a value in the interval [0, 1].",
2742 "format": "float",
2743 "type": "number"
2744 },
2745 "green": {
2746 "description": "The amount of green in the color as a value in the interval [0, 1].",
2747 "format": "float",
2748 "type": "number"
2749 },
2750 "blue": {
2751 "description": "The amount of blue in the color as a value i n the interval [0, 1].",
2752 "format": "float",
2753 "type": "number"
2754 },
2755 "alpha": {
2756 "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).",
2757 "format": "float",
2758 "type": "number"
2759 }
2760 },
2761 "type": "object"
2762 },
2763 "PivotGroup": {
2764 "description": "A single grouping (either row or column) in a pivot table.",
2765 "id": "PivotGroup",
2766 "properties": {
2767 "sourceColumnOffset": {
2768 "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`.",
2769 "format": "int32",
2770 "type": "integer"
2771 },
2772 "showTotals": {
2773 "description": "True if the pivot table should include the t otals for this grouping.",
2774 "type": "boolean"
2775 },
2776 "valueMetadata": {
2777 "description": "Metadata about values in the grouping.",
2778 "items": {
2779 "$ref": "PivotGroupValueMetadata"
2780 },
2781 "type": "array"
2782 },
2783 "sortOrder": {
2784 "description": "The order the values in this group should be sorted.",
2785 "enum": [
2786 "SORT_ORDER_UNSPECIFIED",
2787 "ASCENDING",
2788 "DESCENDING"
2789 ],
2790 "enumDescriptions": [
2791 "Default value, do not use this.",
2792 "Sort ascending.",
2793 "Sort descending."
2794 ],
2795 "type": "string"
2796 },
2797 "valueBucket": {
2798 "$ref": "PivotGroupSortValueBucket",
2799 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
2800 }
2801 },
2802 "type": "object"
2803 },
2804 "PivotTable": {
2805 "description": "A pivot table.",
2806 "id": "PivotTable",
2807 "properties": {
2808 "criteria": {
2809 "additionalProperties": {
2810 "$ref": "PivotFilterCriteria"
2811 },
2812 "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`.",
2813 "type": "object"
2814 },
2815 "rows": {
2816 "description": "Each row grouping in the pivot table.",
2817 "items": {
2818 "$ref": "PivotGroup"
2819 },
2820 "type": "array"
2821 },
2822 "valueLayout": {
2823 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
2824 "enum": [
2825 "HORIZONTAL",
2826 "VERTICAL"
2827 ],
2828 "enumDescriptions": [
2829 "Values are laid out horizontally (as columns).",
2830 "Values are laid out vertically (as rows)."
2831 ],
2832 "type": "string"
2833 },
2834 "values": {
2835 "description": "A list of values to include in the pivot tab le.",
2836 "items": {
2837 "$ref": "PivotValue"
2838 },
2839 "type": "array"
2840 },
2841 "source": {
2842 "$ref": "GridRange",
2843 "description": "The range the pivot table is reading data fr om."
2844 },
2845 "columns": {
2846 "description": "Each column grouping in the pivot table.",
2847 "items": {
2848 "$ref": "PivotGroup"
2849 },
2850 "type": "array"
2851 }
2852 },
2853 "type": "object"
2854 },
2855 "ChartSourceRange": {
2856 "description": "Source ranges for a chart.",
2857 "id": "ChartSourceRange",
2858 "properties": {
2859 "sources": {
2860 "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",
2861 "items": {
2862 "$ref": "GridRange"
2863 },
2864 "type": "array"
2865 }
2866 },
2867 "type": "object"
2868 },
2869 "AppendCellsRequest": {
2870 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
2871 "id": "AppendCellsRequest",
2872 "properties": {
2873 "rows": {
2874 "description": "The data to append.",
2875 "items": {
2876 "$ref": "RowData"
2877 },
2878 "type": "array"
2879 },
2880 "fields": {
2881 "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.",
2882 "format": "google-fieldmask",
2883 "type": "string"
2884 },
2885 "sheetId": {
2886 "description": "The sheet ID to append the data to.",
2887 "format": "int32",
2888 "type": "integer"
2889 }
2890 },
2891 "type": "object"
2892 },
2893 "ValueRange": {
2894 "description": "Data within a range of the spreadsheet.",
2895 "id": "ValueRange",
2896 "properties": {
2897 "range": {
2898 "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.",
2899 "type": "string"
2900 },
2901 "majorDimension": {
2902 "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.",
2948 "enum": [ 2903 "enum": [
2949 "DIMENSION_UNSPECIFIED", 2904 "DIMENSION_UNSPECIFIED",
2950 "ROWS", 2905 "ROWS",
2906 "COLUMNS"
2907 ],
2908 "enumDescriptions": [
2909 "The default value, do not use.",
2910 "Operates on the rows of a sheet.",
2911 "Operates on the columns of a sheet."
2912 ],
2913 "type": "string"
2914 },
2915 "values": {
2916 "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.",
2917 "items": {
2918 "items": {
2919 "type": "any"
2920 },
2921 "type": "array"
2922 },
2923 "type": "array"
2924 }
2925 },
2926 "type": "object"
2927 },
2928 "AddBandingRequest": {
2929 "description": "Adds a new banded range to the spreadsheet.",
2930 "id": "AddBandingRequest",
2931 "properties": {
2932 "bandedRange": {
2933 "$ref": "BandedRange",
2934 "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.)"
2935 }
2936 },
2937 "type": "object"
2938 },
2939 "Response": {
2940 "description": "A single response from an update.",
2941 "id": "Response",
2942 "properties": {
2943 "addFilterView": {
2944 "$ref": "AddFilterViewResponse",
2945 "description": "A reply from adding a filter view."
2946 },
2947 "addBanding": {
2948 "$ref": "AddBandingResponse",
2949 "description": "A reply from adding a banded range."
2950 },
2951 "addProtectedRange": {
2952 "$ref": "AddProtectedRangeResponse",
2953 "description": "A reply from adding a protected range."
2954 },
2955 "duplicateSheet": {
2956 "$ref": "DuplicateSheetResponse",
2957 "description": "A reply from duplicating a sheet."
2958 },
2959 "deleteConditionalFormatRule": {
2960 "$ref": "DeleteConditionalFormatRuleResponse",
2961 "description": "A reply from deleting a conditional format r ule."
2962 },
2963 "updateEmbeddedObjectPosition": {
2964 "$ref": "UpdateEmbeddedObjectPositionResponse",
2965 "description": "A reply from updating an embedded object's p osition."
2966 },
2967 "duplicateFilterView": {
2968 "$ref": "DuplicateFilterViewResponse",
2969 "description": "A reply from duplicating a filter view."
2970 },
2971 "addChart": {
2972 "$ref": "AddChartResponse",
2973 "description": "A reply from adding a chart."
2974 },
2975 "findReplace": {
2976 "$ref": "FindReplaceResponse",
2977 "description": "A reply from doing a find/replace."
2978 },
2979 "addSheet": {
2980 "$ref": "AddSheetResponse",
2981 "description": "A reply from adding a sheet."
2982 },
2983 "updateConditionalFormatRule": {
2984 "$ref": "UpdateConditionalFormatRuleResponse",
2985 "description": "A reply from updating a conditional format r ule."
2986 },
2987 "addNamedRange": {
2988 "$ref": "AddNamedRangeResponse",
2989 "description": "A reply from adding a named range."
2990 }
2991 },
2992 "type": "object"
2993 },
2994 "EmbeddedChart": {
2995 "description": "A chart embedded in a sheet.",
2996 "id": "EmbeddedChart",
2997 "properties": {
2998 "spec": {
2999 "$ref": "ChartSpec",
3000 "description": "The specification of the chart."
3001 },
3002 "chartId": {
3003 "description": "The ID of the chart.",
3004 "format": "int32",
3005 "type": "integer"
3006 },
3007 "position": {
3008 "$ref": "EmbeddedObjectPosition",
3009 "description": "The position of the chart."
3010 }
3011 },
3012 "type": "object"
3013 },
3014 "TextFormatRun": {
3015 "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.",
3016 "id": "TextFormatRun",
3017 "properties": {
3018 "format": {
3019 "$ref": "TextFormat",
3020 "description": "The format of this run. Absent values inher it the cell's format."
3021 },
3022 "startIndex": {
3023 "description": "The character index where this run starts.",
3024 "format": "int32",
3025 "type": "integer"
3026 }
3027 },
3028 "type": "object"
3029 },
3030 "InsertRangeRequest": {
3031 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
3032 "id": "InsertRangeRequest",
3033 "properties": {
3034 "shiftDimension": {
3035 "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.",
3036 "enum": [
3037 "DIMENSION_UNSPECIFIED",
3038 "ROWS",
2951 "COLUMNS" 3039 "COLUMNS"
2952 ], 3040 ],
2953 "enumDescriptions": [ 3041 "enumDescriptions": [
2954 "The default value, do not use.", 3042 "The default value, do not use.",
2955 "Operates on the rows of a sheet.", 3043 "Operates on the rows of a sheet.",
2956 "Operates on the columns of a sheet." 3044 "Operates on the columns of a sheet."
2957 ], 3045 ],
2958 "type": "string" 3046 "type": "string"
2959 }, 3047 },
2960 "startIndex": { 3048 "range": {
2961 "description": "The start (inclusive) of the span, or not se t if unbounded.", 3049 "$ref": "GridRange",
2962 "format": "int32", 3050 "description": "The range to insert new cells into."
2963 "type": "integer" 3051 }
2964 }, 3052 },
2965 "endIndex": { 3053 "type": "object"
2966 "description": "The end (exclusive) of the span, or not set if unbounded.", 3054 },
2967 "format": "int32", 3055 "AddNamedRangeResponse": {
2968 "type": "integer" 3056 "description": "The result of adding a named range.",
3057 "id": "AddNamedRangeResponse",
3058 "properties": {
3059 "namedRange": {
3060 "$ref": "NamedRange",
3061 "description": "The named range to add."
3062 }
3063 },
3064 "type": "object"
3065 },
3066 "RowData": {
3067 "description": "Data about each cell in a row.",
3068 "id": "RowData",
3069 "properties": {
3070 "values": {
3071 "description": "The values in the row, one per column.",
3072 "items": {
3073 "$ref": "CellData"
3074 },
3075 "type": "array"
3076 }
3077 },
3078 "type": "object"
3079 },
3080 "Border": {
3081 "description": "A border along a cell.",
3082 "id": "Border",
3083 "properties": {
3084 "width": {
3085 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.",
3086 "format": "int32",
3087 "type": "integer"
3088 },
3089 "style": {
3090 "description": "The style of the border.",
3091 "enum": [
3092 "STYLE_UNSPECIFIED",
3093 "DOTTED",
3094 "DASHED",
3095 "SOLID",
3096 "SOLID_MEDIUM",
3097 "SOLID_THICK",
3098 "NONE",
3099 "DOUBLE"
3100 ],
3101 "enumDescriptions": [
3102 "The style is not specified. Do not use this.",
3103 "The border is dotted.",
3104 "The border is dashed.",
3105 "The border is a thin solid line.",
3106 "The border is a medium solid line.",
3107 "The border is a thick solid line.",
3108 "No border.\nUsed only when updating a border in order t o erase it.",
3109 "The border is two solid lines."
3110 ],
3111 "type": "string"
3112 },
3113 "color": {
3114 "$ref": "Color",
3115 "description": "The color of the border."
3116 }
3117 },
3118 "type": "object"
3119 },
3120 "GridData": {
3121 "description": "Data in the grid, as well as metadata about the dime nsions.",
3122 "id": "GridData",
3123 "properties": {
3124 "rowData": {
3125 "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.",
3126 "items": {
3127 "$ref": "RowData"
3128 },
3129 "type": "array"
3130 },
3131 "startRow": {
3132 "description": "The first row this GridData refers to, zero- based.",
3133 "format": "int32",
3134 "type": "integer"
3135 },
3136 "columnMetadata": {
3137 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
3138 "items": {
3139 "$ref": "DimensionProperties"
3140 },
3141 "type": "array"
3142 },
3143 "startColumn": {
3144 "description": "The first column this GridData refers to, ze ro-based.",
3145 "format": "int32",
3146 "type": "integer"
3147 },
3148 "rowMetadata": {
3149 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
3150 "items": {
3151 "$ref": "DimensionProperties"
3152 },
3153 "type": "array"
3154 }
3155 },
3156 "type": "object"
3157 },
3158 "FindReplaceRequest": {
3159 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
3160 "id": "FindReplaceRequest",
3161 "properties": {
3162 "replacement": {
3163 "description": "The value to use as the replacement.",
3164 "type": "string"
3165 },
3166 "range": {
3167 "$ref": "GridRange",
3168 "description": "The range to find/replace over."
2969 }, 3169 },
2970 "sheetId": { 3170 "sheetId": {
2971 "description": "The sheet this span is on.", 3171 "description": "The sheet to find/replace over.",
2972 "format": "int32", 3172 "format": "int32",
2973 "type": "integer" 3173 "type": "integer"
2974 } 3174 },
2975 }, 3175 "matchCase": {
2976 "type": "object" 3176 "description": "True if the search is case sensitive.",
2977 }, 3177 "type": "boolean"
2978 "CutPasteRequest": { 3178 },
2979 "description": "Moves data from the source to the destination.", 3179 "allSheets": {
2980 "id": "CutPasteRequest", 3180 "description": "True to find/replace over all sheets.",
2981 "properties": { 3181 "type": "boolean"
2982 "source": { 3182 },
3183 "includeFormulas": {
3184 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
3185 "type": "boolean"
3186 },
3187 "matchEntireCell": {
3188 "description": "True if the find value should match the enti re cell.",
3189 "type": "boolean"
3190 },
3191 "find": {
3192 "description": "The value to search.",
3193 "type": "string"
3194 },
3195 "searchByRegex": {
3196 "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.",
3197 "type": "boolean"
3198 }
3199 },
3200 "type": "object"
3201 },
3202 "UpdateNamedRangeRequest": {
3203 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
3204 "id": "UpdateNamedRangeRequest",
3205 "properties": {
3206 "namedRange": {
3207 "$ref": "NamedRange",
3208 "description": "The named range to update with the new prope rties."
3209 },
3210 "fields": {
3211 "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 .",
3212 "format": "google-fieldmask",
3213 "type": "string"
3214 }
3215 },
3216 "type": "object"
3217 },
3218 "AddSheetRequest": {
3219 "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.",
3220 "id": "AddSheetRequest",
3221 "properties": {
3222 "properties": {
3223 "$ref": "SheetProperties",
3224 "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.)"
3225 }
3226 },
3227 "type": "object"
3228 },
3229 "UpdateCellsRequest": {
3230 "description": "Updates all cells in a range with new data.",
3231 "id": "UpdateCellsRequest",
3232 "properties": {
3233 "start": {
3234 "$ref": "GridCoordinate",
3235 "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."
3236 },
3237 "range": {
2983 "$ref": "GridRange", 3238 "$ref": "GridRange",
2984 "description": "The source data to cut." 3239 "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."
2985 }, 3240 },
2986 "pasteType": { 3241 "rows": {
2987 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.", 3242 "description": "The data to write.",
3243 "items": {
3244 "$ref": "RowData"
3245 },
3246 "type": "array"
3247 },
3248 "fields": {
3249 "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.",
3250 "format": "google-fieldmask",
3251 "type": "string"
3252 }
3253 },
3254 "type": "object"
3255 },
3256 "DeleteConditionalFormatRuleResponse": {
3257 "description": "The result of deleting a conditional format rule.",
3258 "id": "DeleteConditionalFormatRuleResponse",
3259 "properties": {
3260 "rule": {
3261 "$ref": "ConditionalFormatRule",
3262 "description": "The rule that was deleted."
3263 }
3264 },
3265 "type": "object"
3266 },
3267 "DeleteRangeRequest": {
3268 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
3269 "id": "DeleteRangeRequest",
3270 "properties": {
3271 "shiftDimension": {
3272 "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.",
3273 "enum": [
3274 "DIMENSION_UNSPECIFIED",
3275 "ROWS",
3276 "COLUMNS"
3277 ],
3278 "enumDescriptions": [
3279 "The default value, do not use.",
3280 "Operates on the rows of a sheet.",
3281 "Operates on the columns of a sheet."
3282 ],
3283 "type": "string"
3284 },
3285 "range": {
3286 "$ref": "GridRange",
3287 "description": "The range of cells to delete."
3288 }
3289 },
3290 "type": "object"
3291 },
3292 "GridCoordinate": {
3293 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
3294 "id": "GridCoordinate",
3295 "properties": {
3296 "rowIndex": {
3297 "description": "The row index of the coordinate.",
3298 "format": "int32",
3299 "type": "integer"
3300 },
3301 "columnIndex": {
3302 "description": "The column index of the coordinate.",
3303 "format": "int32",
3304 "type": "integer"
3305 },
3306 "sheetId": {
3307 "description": "The sheet this coordinate is on.",
3308 "format": "int32",
3309 "type": "integer"
3310 }
3311 },
3312 "type": "object"
3313 },
3314 "UpdateSheetPropertiesRequest": {
3315 "description": "Updates properties of the sheet with the specified\n sheetId.",
3316 "id": "UpdateSheetPropertiesRequest",
3317 "properties": {
3318 "fields": {
3319 "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 .",
3320 "format": "google-fieldmask",
3321 "type": "string"
3322 },
3323 "properties": {
3324 "$ref": "SheetProperties",
3325 "description": "The properties to update."
3326 }
3327 },
3328 "type": "object"
3329 },
3330 "GridProperties": {
3331 "description": "Properties of a grid.",
3332 "id": "GridProperties",
3333 "properties": {
3334 "rowCount": {
3335 "description": "The number of rows in the grid.",
3336 "format": "int32",
3337 "type": "integer"
3338 },
3339 "frozenRowCount": {
3340 "description": "The number of rows that are frozen in the gr id.",
3341 "format": "int32",
3342 "type": "integer"
3343 },
3344 "hideGridlines": {
3345 "description": "True if the grid isn't showing gridlines in the UI.",
3346 "type": "boolean"
3347 },
3348 "columnCount": {
3349 "description": "The number of columns in the grid.",
3350 "format": "int32",
3351 "type": "integer"
3352 },
3353 "frozenColumnCount": {
3354 "description": "The number of columns that are frozen in the grid.",
3355 "format": "int32",
3356 "type": "integer"
3357 }
3358 },
3359 "type": "object"
3360 },
3361 "UnmergeCellsRequest": {
3362 "description": "Unmerges cells in the given range.",
3363 "id": "UnmergeCellsRequest",
3364 "properties": {
3365 "range": {
3366 "$ref": "GridRange",
3367 "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."
3368 }
3369 },
3370 "type": "object"
3371 },
3372 "UpdateEmbeddedObjectPositionResponse": {
3373 "description": "The result of updating an embedded object's position .",
3374 "id": "UpdateEmbeddedObjectPositionResponse",
3375 "properties": {
3376 "position": {
3377 "$ref": "EmbeddedObjectPosition",
3378 "description": "The new position of the embedded object."
3379 }
3380 },
3381 "type": "object"
3382 },
3383 "SortSpec": {
3384 "description": "A sort order associated with a specific column or ro w.",
3385 "id": "SortSpec",
3386 "properties": {
3387 "dimensionIndex": {
3388 "description": "The dimension the sort should be applied to. ",
3389 "format": "int32",
3390 "type": "integer"
3391 },
3392 "sortOrder": {
3393 "description": "The order data should be sorted.",
3394 "enum": [
3395 "SORT_ORDER_UNSPECIFIED",
3396 "ASCENDING",
3397 "DESCENDING"
3398 ],
3399 "enumDescriptions": [
3400 "Default value, do not use this.",
3401 "Sort ascending.",
3402 "Sort descending."
3403 ],
3404 "type": "string"
3405 }
3406 },
3407 "type": "object"
3408 },
3409 "Sheet": {
3410 "description": "A sheet in a spreadsheet.",
3411 "id": "Sheet",
3412 "properties": {
3413 "data": {
3414 "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).",
3415 "items": {
3416 "$ref": "GridData"
3417 },
3418 "type": "array"
3419 },
3420 "bandedRanges": {
3421 "description": "The banded (i.e. alternating colors) ranges on this sheet.",
3422 "items": {
3423 "$ref": "BandedRange"
3424 },
3425 "type": "array"
3426 },
3427 "properties": {
3428 "$ref": "SheetProperties",
3429 "description": "The properties of the sheet."
3430 },
3431 "charts": {
3432 "description": "The specifications of every chart on this sh eet.",
3433 "items": {
3434 "$ref": "EmbeddedChart"
3435 },
3436 "type": "array"
3437 },
3438 "filterViews": {
3439 "description": "The filter views in this sheet.",
3440 "items": {
3441 "$ref": "FilterView"
3442 },
3443 "type": "array"
3444 },
3445 "protectedRanges": {
3446 "description": "The protected ranges in this sheet.",
3447 "items": {
3448 "$ref": "ProtectedRange"
3449 },
3450 "type": "array"
3451 },
3452 "conditionalFormats": {
3453 "description": "The conditional format rules in this sheet." ,
3454 "items": {
3455 "$ref": "ConditionalFormatRule"
3456 },
3457 "type": "array"
3458 },
3459 "basicFilter": {
3460 "$ref": "BasicFilter",
3461 "description": "The filter on this sheet, if any."
3462 },
3463 "merges": {
3464 "description": "The ranges that are merged together.",
3465 "items": {
3466 "$ref": "GridRange"
3467 },
3468 "type": "array"
3469 }
3470 },
3471 "type": "object"
3472 },
3473 "BooleanRule": {
3474 "description": "A rule that may or may not match, depending on the c ondition.",
3475 "id": "BooleanRule",
3476 "properties": {
3477 "format": {
3478 "$ref": "CellFormat",
3479 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color."
3480 },
3481 "condition": {
3482 "$ref": "BooleanCondition",
3483 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
3484 }
3485 },
3486 "type": "object"
3487 },
3488 "PivotGroupValueMetadata": {
3489 "description": "Metadata about a value in a pivot grouping.",
3490 "id": "PivotGroupValueMetadata",
3491 "properties": {
3492 "value": {
3493 "$ref": "ExtendedValue",
3494 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
3495 },
3496 "collapsed": {
3497 "description": "True if the data corresponding to the value is collapsed.",
3498 "type": "boolean"
3499 }
3500 },
3501 "type": "object"
3502 },
3503 "FilterCriteria": {
3504 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
3505 "id": "FilterCriteria",
3506 "properties": {
3507 "hiddenValues": {
3508 "description": "Values that should be hidden.",
3509 "items": {
3510 "type": "string"
3511 },
3512 "type": "array"
3513 },
3514 "condition": {
3515 "$ref": "BooleanCondition",
3516 "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.)"
3517 }
3518 },
3519 "type": "object"
3520 },
3521 "Editors": {
3522 "description": "The editors of a protected range.",
3523 "id": "Editors",
3524 "properties": {
3525 "users": {
3526 "description": "The email addresses of users with edit acces s to the protected range.",
3527 "items": {
3528 "type": "string"
3529 },
3530 "type": "array"
3531 },
3532 "groups": {
3533 "description": "The email addresses of groups with edit acce ss to the protected range.",
3534 "items": {
3535 "type": "string"
3536 },
3537 "type": "array"
3538 },
3539 "domainUsersCanEdit": {
3540 "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.",
3541 "type": "boolean"
3542 }
3543 },
3544 "type": "object"
3545 },
3546 "UpdateConditionalFormatRuleRequest": {
3547 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
3548 "id": "UpdateConditionalFormatRuleRequest",
3549 "properties": {
3550 "rule": {
3551 "$ref": "ConditionalFormatRule",
3552 "description": "The rule that should replace the rule at the given index."
3553 },
3554 "index": {
3555 "description": "The zero-based index of the rule that should be replaced or moved.",
3556 "format": "int32",
3557 "type": "integer"
3558 },
3559 "sheetId": {
3560 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
3561 "format": "int32",
3562 "type": "integer"
3563 },
3564 "newIndex": {
3565 "description": "The zero-based new index the rule should end up at.",
3566 "format": "int32",
3567 "type": "integer"
3568 }
3569 },
3570 "type": "object"
3571 },
3572 "DataValidationRule": {
3573 "description": "A data validation rule.",
3574 "id": "DataValidationRule",
3575 "properties": {
3576 "condition": {
3577 "$ref": "BooleanCondition",
3578 "description": "The condition that data in the cell must mat ch."
3579 },
3580 "showCustomUi": {
3581 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
3582 "type": "boolean"
3583 },
3584 "strict": {
3585 "description": "True if invalid data should be rejected.",
3586 "type": "boolean"
3587 },
3588 "inputMessage": {
3589 "description": "A message to show the user when adding data to the cell.",
3590 "type": "string"
3591 }
3592 },
3593 "type": "object"
3594 },
3595 "BasicChartDomain": {
3596 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
3597 "id": "BasicChartDomain",
3598 "properties": {
3599 "domain": {
3600 "$ref": "ChartData",
3601 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
3602 },
3603 "reversed": {
3604 "description": "True to reverse the order of the domain valu es (horizontal axis).\nNot applicable to Gauge, Geo, Histogram, Org, Pie, Radar, and Treemap\ncharts.",
3605 "type": "boolean"
3606 }
3607 },
3608 "type": "object"
3609 },
3610 "PasteDataRequest": {
3611 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
3612 "id": "PasteDataRequest",
3613 "properties": {
3614 "data": {
3615 "description": "The data to insert.",
3616 "type": "string"
3617 },
3618 "delimiter": {
3619 "description": "The delimiter in the data.",
3620 "type": "string"
3621 },
3622 "type": {
3623 "description": "How the data should be pasted.",
2988 "enum": [ 3624 "enum": [
2989 "PASTE_NORMAL", 3625 "PASTE_NORMAL",
2990 "PASTE_VALUES", 3626 "PASTE_VALUES",
2991 "PASTE_FORMAT", 3627 "PASTE_FORMAT",
2992 "PASTE_NO_BORDERS", 3628 "PASTE_NO_BORDERS",
2993 "PASTE_FORMULA", 3629 "PASTE_FORMULA",
2994 "PASTE_DATA_VALIDATION", 3630 "PASTE_DATA_VALIDATION",
2995 "PASTE_CONDITIONAL_FORMATTING" 3631 "PASTE_CONDITIONAL_FORMATTING"
2996 ], 3632 ],
2997 "enumDescriptions": [ 3633 "enumDescriptions": [
2998 "Paste values, formulas, formats, and merges.", 3634 "Paste values, formulas, formats, and merges.",
2999 "Paste the values ONLY without formats, formulas, or mer ges.", 3635 "Paste the values ONLY without formats, formulas, or mer ges.",
3000 "Paste the format and data validation only.", 3636 "Paste the format and data validation only.",
3001 "Like PASTE_NORMAL but without borders.", 3637 "Like PASTE_NORMAL but without borders.",
3002 "Paste the formulas only.", 3638 "Paste the formulas only.",
3003 "Paste the data validation only.", 3639 "Paste the data validation only.",
3004 "Paste the conditional formatting rules only." 3640 "Paste the conditional formatting rules only."
3005 ], 3641 ],
3006 "type": "string" 3642 "type": "string"
3007 }, 3643 },
3008 "destination": { 3644 "html": {
3645 "description": "True if the data is HTML.",
3646 "type": "boolean"
3647 },
3648 "coordinate": {
3009 "$ref": "GridCoordinate", 3649 "$ref": "GridCoordinate",
3010 "description": "The top-left coordinate where the data shoul d be pasted." 3650 "description": "The coordinate at which the data should star t being inserted."
3011 } 3651 }
3012 }, 3652 },
3013 "type": "object" 3653 "type": "object"
3014 }, 3654 },
3015 "BasicChartSeries": { 3655 "AppendDimensionRequest": {
3016 "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\".", 3656 "description": "Appends rows or columns to the end of a sheet.",
3017 "id": "BasicChartSeries", 3657 "id": "AppendDimensionRequest",
3018 "properties": { 3658 "properties": {
3019 "series": {
3020 "$ref": "ChartData",
3021 "description": "The data being visualized in this chart seri es."
3022 },
3023 "type": {
3024 "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.",
3025 "enum": [
3026 "BASIC_CHART_TYPE_UNSPECIFIED",
3027 "BAR",
3028 "LINE",
3029 "AREA",
3030 "COLUMN",
3031 "SCATTER",
3032 "COMBO"
3033 ],
3034 "enumDescriptions": [
3035 "Default value, do not use.",
3036 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
3037 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
3038 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
3039 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
3040 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
3041 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
3042 ],
3043 "type": "string"
3044 },
3045 "targetAxis": {
3046 "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.",
3047 "enum": [
3048 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
3049 "BOTTOM_AXIS",
3050 "LEFT_AXIS",
3051 "RIGHT_AXIS"
3052 ],
3053 "enumDescriptions": [
3054 "Default value, do not use.",
3055 "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.",
3056 "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.",
3057 "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."
3058 ],
3059 "type": "string"
3060 }
3061 },
3062 "type": "object"
3063 },
3064 "Borders": {
3065 "description": "The borders of the cell.",
3066 "id": "Borders",
3067 "properties": {
3068 "bottom": {
3069 "$ref": "Border",
3070 "description": "The bottom border of the cell."
3071 },
3072 "top": {
3073 "$ref": "Border",
3074 "description": "The top border of the cell."
3075 },
3076 "left": {
3077 "$ref": "Border",
3078 "description": "The left border of the cell."
3079 },
3080 "right": {
3081 "$ref": "Border",
3082 "description": "The right border of the cell."
3083 }
3084 },
3085 "type": "object"
3086 },
3087 "AutoResizeDimensionsRequest": {
3088 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
3089 "id": "AutoResizeDimensionsRequest",
3090 "properties": {
3091 "dimensions": {
3092 "$ref": "DimensionRange",
3093 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
3094 }
3095 },
3096 "type": "object"
3097 },
3098 "UpdateBordersRequest": {
3099 "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.",
3100 "id": "UpdateBordersRequest",
3101 "properties": {
3102 "innerHorizontal": {
3103 "$ref": "Border",
3104 "description": "The horizontal border to put within the rang e."
3105 },
3106 "top": {
3107 "$ref": "Border",
3108 "description": "The border to put at the top of the range."
3109 },
3110 "left": {
3111 "$ref": "Border",
3112 "description": "The border to put at the left of the range."
3113 },
3114 "bottom": {
3115 "$ref": "Border",
3116 "description": "The border to put at the bottom of the range ."
3117 },
3118 "innerVertical": {
3119 "$ref": "Border",
3120 "description": "The vertical border to put within the range. "
3121 },
3122 "right": {
3123 "$ref": "Border",
3124 "description": "The border to put at the right of the range. "
3125 },
3126 "range": {
3127 "$ref": "GridRange",
3128 "description": "The range whose borders should be updated."
3129 }
3130 },
3131 "type": "object"
3132 },
3133 "CellFormat": {
3134 "description": "The format of a cell.",
3135 "id": "CellFormat",
3136 "properties": {
3137 "backgroundColor": {
3138 "$ref": "Color",
3139 "description": "The background color of the cell."
3140 },
3141 "padding": {
3142 "$ref": "Padding",
3143 "description": "The padding of the cell."
3144 },
3145 "verticalAlignment": {
3146 "description": "The vertical alignment of the value in the c ell.",
3147 "enum": [
3148 "VERTICAL_ALIGN_UNSPECIFIED",
3149 "TOP",
3150 "MIDDLE",
3151 "BOTTOM"
3152 ],
3153 "enumDescriptions": [
3154 "The vertical alignment is not specified. Do not use th is.",
3155 "The text is explicitly aligned to the top of the cell." ,
3156 "The text is explicitly aligned to the middle of the cel l.",
3157 "The text is explicitly aligned to the bottom of the cel l."
3158 ],
3159 "type": "string"
3160 },
3161 "borders": {
3162 "$ref": "Borders",
3163 "description": "The borders of the cell."
3164 },
3165 "textDirection": {
3166 "description": "The direction of the text in the cell.",
3167 "enum": [
3168 "TEXT_DIRECTION_UNSPECIFIED",
3169 "LEFT_TO_RIGHT",
3170 "RIGHT_TO_LEFT"
3171 ],
3172 "enumDescriptions": [
3173 "The text direction is not specified. Do not use this.",
3174 "The text direction of left-to-right was set by the user .",
3175 "The text direction of right-to-left was set by the user ."
3176 ],
3177 "type": "string"
3178 },
3179 "textRotation": {
3180 "$ref": "TextRotation",
3181 "description": "The rotation applied to text in a cell"
3182 },
3183 "wrapStrategy": {
3184 "description": "The wrap strategy for the value in the cell. ",
3185 "enum": [
3186 "WRAP_STRATEGY_UNSPECIFIED",
3187 "OVERFLOW_CELL",
3188 "LEGACY_WRAP",
3189 "CLIP",
3190 "WRAP"
3191 ],
3192 "enumDescriptions": [
3193 "The default value, do not use.",
3194 "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. |",
3195 "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. |",
3196 "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. |",
3197 "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. |"
3198 ],
3199 "type": "string"
3200 },
3201 "numberFormat": {
3202 "$ref": "NumberFormat",
3203 "description": "A format describing how number values should be represented to the user."
3204 },
3205 "hyperlinkDisplayType": {
3206 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
3207 "enum": [
3208 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
3209 "LINKED",
3210 "PLAIN_TEXT"
3211 ],
3212 "enumDescriptions": [
3213 "The default value: the hyperlink is rendered. Do not us e this.",
3214 "A hyperlink should be explicitly rendered.",
3215 "A hyperlink should not be rendered."
3216 ],
3217 "type": "string"
3218 },
3219 "horizontalAlignment": {
3220 "description": "The horizontal alignment of the value in the cell.",
3221 "enum": [
3222 "HORIZONTAL_ALIGN_UNSPECIFIED",
3223 "LEFT",
3224 "CENTER",
3225 "RIGHT"
3226 ],
3227 "enumDescriptions": [
3228 "The horizontal alignment is not specified. Do not use t his.",
3229 "The text is explicitly aligned to the left of the cell. ",
3230 "The text is explicitly aligned to the center of the cel l.",
3231 "The text is explicitly aligned to the right of the cell ."
3232 ],
3233 "type": "string"
3234 },
3235 "textFormat": {
3236 "$ref": "TextFormat",
3237 "description": "The format of the text in the cell (unless o verridden by a format run)."
3238 }
3239 },
3240 "type": "object"
3241 },
3242 "ClearValuesResponse": {
3243 "description": "The response when clearing a range of values in a sp readsheet.",
3244 "id": "ClearValuesResponse",
3245 "properties": {
3246 "spreadsheetId": {
3247 "description": "The spreadsheet the updates were applied to. ",
3248 "type": "string"
3249 },
3250 "clearedRange": {
3251 "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.)",
3252 "type": "string"
3253 }
3254 },
3255 "type": "object"
3256 },
3257 "DeleteConditionalFormatRuleRequest": {
3258 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
3259 "id": "DeleteConditionalFormatRuleRequest",
3260 "properties": {
3261 "index": {
3262 "description": "The zero-based index of the rule to be delet ed.",
3263 "format": "int32",
3264 "type": "integer"
3265 },
3266 "sheetId": { 3659 "sheetId": {
3267 "description": "The sheet the rule is being deleted from.", 3660 "description": "The sheet to append rows or columns to.",
3268 "format": "int32", 3661 "format": "int32",
3269 "type": "integer" 3662 "type": "integer"
3270 } 3663 },
3271 }, 3664 "dimension": {
3272 "type": "object" 3665 "description": "Whether rows or columns should be appended." ,
3273 },
3274 "DeleteNamedRangeRequest": {
3275 "description": "Removes the named range with the given ID from the s preadsheet.",
3276 "id": "DeleteNamedRangeRequest",
3277 "properties": {
3278 "namedRangeId": {
3279 "description": "The ID of the named range to delete.",
3280 "type": "string"
3281 }
3282 },
3283 "type": "object"
3284 },
3285 "AddBandingResponse": {
3286 "description": "The result of adding a banded range.",
3287 "id": "AddBandingResponse",
3288 "properties": {
3289 "bandedRange": {
3290 "$ref": "BandedRange",
3291 "description": "The banded range that was added."
3292 }
3293 },
3294 "type": "object"
3295 },
3296 "ChartData": {
3297 "description": "The data included in a domain or series.",
3298 "id": "ChartData",
3299 "properties": {
3300 "sourceRange": {
3301 "$ref": "ChartSourceRange",
3302 "description": "The source ranges of the data."
3303 }
3304 },
3305 "type": "object"
3306 },
3307 "BatchGetValuesResponse": {
3308 "description": "The response when retrieving more than one range of values in a spreadsheet.",
3309 "id": "BatchGetValuesResponse",
3310 "properties": {
3311 "spreadsheetId": {
3312 "description": "The ID of the spreadsheet the data was retri eved from.",
3313 "type": "string"
3314 },
3315 "valueRanges": {
3316 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
3317 "items": {
3318 "$ref": "ValueRange"
3319 },
3320 "type": "array"
3321 }
3322 },
3323 "type": "object"
3324 },
3325 "UpdateBandingRequest": {
3326 "description": "Updates properties of the supplied banded range.",
3327 "id": "UpdateBandingRequest",
3328 "properties": {
3329 "fields": {
3330 "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.",
3331 "format": "google-fieldmask",
3332 "type": "string"
3333 },
3334 "bandedRange": {
3335 "$ref": "BandedRange",
3336 "description": "The banded range to update with the new prop erties."
3337 }
3338 },
3339 "type": "object"
3340 },
3341 "Color": {
3342 "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 // ...",
3343 "id": "Color",
3344 "properties": {
3345 "red": {
3346 "description": "The amount of red in the color as a value in the interval [0, 1].",
3347 "format": "float",
3348 "type": "number"
3349 },
3350 "green": {
3351 "description": "The amount of green in the color as a value in the interval [0, 1].",
3352 "format": "float",
3353 "type": "number"
3354 },
3355 "blue": {
3356 "description": "The amount of blue in the color as a value i n the interval [0, 1].",
3357 "format": "float",
3358 "type": "number"
3359 },
3360 "alpha": {
3361 "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).",
3362 "format": "float",
3363 "type": "number"
3364 }
3365 },
3366 "type": "object"
3367 },
3368 "PivotGroup": {
3369 "description": "A single grouping (either row or column) in a pivot table.",
3370 "id": "PivotGroup",
3371 "properties": {
3372 "valueBucket": {
3373 "$ref": "PivotGroupSortValueBucket",
3374 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
3375 },
3376 "sourceColumnOffset": {
3377 "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`.",
3378 "format": "int32",
3379 "type": "integer"
3380 },
3381 "showTotals": {
3382 "description": "True if the pivot table should include the t otals for this grouping.",
3383 "type": "boolean"
3384 },
3385 "valueMetadata": {
3386 "description": "Metadata about values in the grouping.",
3387 "items": {
3388 "$ref": "PivotGroupValueMetadata"
3389 },
3390 "type": "array"
3391 },
3392 "sortOrder": {
3393 "description": "The order the values in this group should be sorted.",
3394 "enum": [
3395 "SORT_ORDER_UNSPECIFIED",
3396 "ASCENDING",
3397 "DESCENDING"
3398 ],
3399 "enumDescriptions": [
3400 "Default value, do not use this.",
3401 "Sort ascending.",
3402 "Sort descending."
3403 ],
3404 "type": "string"
3405 }
3406 },
3407 "type": "object"
3408 },
3409 "PivotTable": {
3410 "description": "A pivot table.",
3411 "id": "PivotTable",
3412 "properties": {
3413 "criteria": {
3414 "additionalProperties": {
3415 "$ref": "PivotFilterCriteria"
3416 },
3417 "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`.",
3418 "type": "object"
3419 },
3420 "rows": {
3421 "description": "Each row grouping in the pivot table.",
3422 "items": {
3423 "$ref": "PivotGroup"
3424 },
3425 "type": "array"
3426 },
3427 "valueLayout": {
3428 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
3429 "enum": [
3430 "HORIZONTAL",
3431 "VERTICAL"
3432 ],
3433 "enumDescriptions": [
3434 "Values are laid out horizontally (as columns).",
3435 "Values are laid out vertically (as rows)."
3436 ],
3437 "type": "string"
3438 },
3439 "source": {
3440 "$ref": "GridRange",
3441 "description": "The range the pivot table is reading data fr om."
3442 },
3443 "columns": {
3444 "description": "Each column grouping in the pivot table.",
3445 "items": {
3446 "$ref": "PivotGroup"
3447 },
3448 "type": "array"
3449 },
3450 "values": {
3451 "description": "A list of values to include in the pivot tab le.",
3452 "items": {
3453 "$ref": "PivotValue"
3454 },
3455 "type": "array"
3456 }
3457 },
3458 "type": "object"
3459 },
3460 "ChartSourceRange": {
3461 "description": "Source ranges for a chart.",
3462 "id": "ChartSourceRange",
3463 "properties": {
3464 "sources": {
3465 "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",
3466 "items": {
3467 "$ref": "GridRange"
3468 },
3469 "type": "array"
3470 }
3471 },
3472 "type": "object"
3473 },
3474 "AppendCellsRequest": {
3475 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
3476 "id": "AppendCellsRequest",
3477 "properties": {
3478 "sheetId": {
3479 "description": "The sheet ID to append the data to.",
3480 "format": "int32",
3481 "type": "integer"
3482 },
3483 "rows": {
3484 "description": "The data to append.",
3485 "items": {
3486 "$ref": "RowData"
3487 },
3488 "type": "array"
3489 },
3490 "fields": {
3491 "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.",
3492 "format": "google-fieldmask",
3493 "type": "string"
3494 }
3495 },
3496 "type": "object"
3497 },
3498 "ValueRange": {
3499 "description": "Data within a range of the spreadsheet.",
3500 "id": "ValueRange",
3501 "properties": {
3502 "range": {
3503 "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.",
3504 "type": "string"
3505 },
3506 "majorDimension": {
3507 "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.",
3508 "enum": [ 3666 "enum": [
3509 "DIMENSION_UNSPECIFIED", 3667 "DIMENSION_UNSPECIFIED",
3510 "ROWS", 3668 "ROWS",
3511 "COLUMNS" 3669 "COLUMNS"
3512 ], 3670 ],
3513 "enumDescriptions": [ 3671 "enumDescriptions": [
3514 "The default value, do not use.", 3672 "The default value, do not use.",
3515 "Operates on the rows of a sheet.", 3673 "Operates on the rows of a sheet.",
3516 "Operates on the columns of a sheet." 3674 "Operates on the columns of a sheet."
3517 ], 3675 ],
3518 "type": "string" 3676 "type": "string"
3519 }, 3677 },
3520 "values": { 3678 "length": {
3521 "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.", 3679 "description": "The number of rows or columns to append.",
3522 "items": { 3680 "format": "int32",
3523 "items": { 3681 "type": "integer"
3524 "type": "any" 3682 }
3525 }, 3683 },
3526 "type": "array" 3684 "type": "object"
3527 }, 3685 },
3528 "type": "array" 3686 "AddNamedRangeRequest": {
3529 } 3687 "description": "Adds a named range to the spreadsheet.",
3530 }, 3688 "id": "AddNamedRangeRequest",
3531 "type": "object"
3532 },
3533 "AddBandingRequest": {
3534 "description": "Adds a new banded range to the spreadsheet.",
3535 "id": "AddBandingRequest",
3536 "properties": {
3537 "bandedRange": {
3538 "$ref": "BandedRange",
3539 "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.)"
3540 }
3541 },
3542 "type": "object"
3543 },
3544 "Response": {
3545 "description": "A single response from an update.",
3546 "id": "Response",
3547 "properties": {
3548 "addProtectedRange": {
3549 "$ref": "AddProtectedRangeResponse",
3550 "description": "A reply from adding a protected range."
3551 },
3552 "duplicateSheet": {
3553 "$ref": "DuplicateSheetResponse",
3554 "description": "A reply from duplicating a sheet."
3555 },
3556 "deleteConditionalFormatRule": {
3557 "$ref": "DeleteConditionalFormatRuleResponse",
3558 "description": "A reply from deleting a conditional format r ule."
3559 },
3560 "updateEmbeddedObjectPosition": {
3561 "$ref": "UpdateEmbeddedObjectPositionResponse",
3562 "description": "A reply from updating an embedded object's p osition."
3563 },
3564 "duplicateFilterView": {
3565 "$ref": "DuplicateFilterViewResponse",
3566 "description": "A reply from duplicating a filter view."
3567 },
3568 "addChart": {
3569 "$ref": "AddChartResponse",
3570 "description": "A reply from adding a chart."
3571 },
3572 "findReplace": {
3573 "$ref": "FindReplaceResponse",
3574 "description": "A reply from doing a find/replace."
3575 },
3576 "addSheet": {
3577 "$ref": "AddSheetResponse",
3578 "description": "A reply from adding a sheet."
3579 },
3580 "updateConditionalFormatRule": {
3581 "$ref": "UpdateConditionalFormatRuleResponse",
3582 "description": "A reply from updating a conditional format r ule."
3583 },
3584 "addNamedRange": {
3585 "$ref": "AddNamedRangeResponse",
3586 "description": "A reply from adding a named range."
3587 },
3588 "addFilterView": {
3589 "$ref": "AddFilterViewResponse",
3590 "description": "A reply from adding a filter view."
3591 },
3592 "addBanding": {
3593 "$ref": "AddBandingResponse",
3594 "description": "A reply from adding a banded range."
3595 }
3596 },
3597 "type": "object"
3598 },
3599 "EmbeddedChart": {
3600 "description": "A chart embedded in a sheet.",
3601 "id": "EmbeddedChart",
3602 "properties": {
3603 "chartId": {
3604 "description": "The ID of the chart.",
3605 "format": "int32",
3606 "type": "integer"
3607 },
3608 "position": {
3609 "$ref": "EmbeddedObjectPosition",
3610 "description": "The position of the chart."
3611 },
3612 "spec": {
3613 "$ref": "ChartSpec",
3614 "description": "The specification of the chart."
3615 }
3616 },
3617 "type": "object"
3618 },
3619 "TextFormatRun": {
3620 "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.",
3621 "id": "TextFormatRun",
3622 "properties": {
3623 "format": {
3624 "$ref": "TextFormat",
3625 "description": "The format of this run. Absent values inher it the cell's format."
3626 },
3627 "startIndex": {
3628 "description": "The character index where this run starts.",
3629 "format": "int32",
3630 "type": "integer"
3631 }
3632 },
3633 "type": "object"
3634 },
3635 "InsertRangeRequest": {
3636 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
3637 "id": "InsertRangeRequest",
3638 "properties": {
3639 "shiftDimension": {
3640 "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.",
3641 "enum": [
3642 "DIMENSION_UNSPECIFIED",
3643 "ROWS",
3644 "COLUMNS"
3645 ],
3646 "enumDescriptions": [
3647 "The default value, do not use.",
3648 "Operates on the rows of a sheet.",
3649 "Operates on the columns of a sheet."
3650 ],
3651 "type": "string"
3652 },
3653 "range": {
3654 "$ref": "GridRange",
3655 "description": "The range to insert new cells into."
3656 }
3657 },
3658 "type": "object"
3659 },
3660 "AddNamedRangeResponse": {
3661 "description": "The result of adding a named range.",
3662 "id": "AddNamedRangeResponse",
3663 "properties": { 3689 "properties": {
3664 "namedRange": { 3690 "namedRange": {
3665 "$ref": "NamedRange", 3691 "$ref": "NamedRange",
3666 "description": "The named range to add." 3692 "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.)"
3667 } 3693 }
3668 }, 3694 },
3669 "type": "object" 3695 "type": "object"
3670 }, 3696 },
3671 "RowData": { 3697 "UpdateEmbeddedObjectPositionRequest": {
3672 "description": "Data about each cell in a row.", 3698 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
3673 "id": "RowData", 3699 "id": "UpdateEmbeddedObjectPositionRequest",
3674 "properties": { 3700 "properties": {
3675 "values": { 3701 "fields": {
3676 "description": "The values in the row, one per column.", 3702 "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.",
3677 "items": { 3703 "format": "google-fieldmask",
3678 "$ref": "CellData" 3704 "type": "string"
3679 }, 3705 },
3680 "type": "array" 3706 "objectId": {
3681 } 3707 "description": "The ID of the object to moved.",
3682 }, 3708 "format": "int32",
3683 "type": "object" 3709 "type": "integer"
3684 }, 3710 },
3685 "Border": { 3711 "newPosition": {
3686 "description": "A border along a cell.", 3712 "$ref": "EmbeddedObjectPosition",
3687 "id": "Border", 3713 "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."
3688 "properties": { 3714 }
3689 "color": { 3715 },
3690 "$ref": "Color", 3716 "type": "object"
3691 "description": "The color of the border." 3717 },
3692 }, 3718 "TextRotation": {
3693 "width": { 3719 "description": "The rotation applied to text in a cell.",
3694 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.", 3720 "id": "TextRotation",
3695 "format": "int32", 3721 "properties": {
3696 "type": "integer" 3722 "angle": {
3697 }, 3723 "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",
3698 "style": { 3724 "format": "int32",
3699 "description": "The style of the border.", 3725 "type": "integer"
3726 },
3727 "vertical": {
3728 "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 |",
3729 "type": "boolean"
3730 }
3731 },
3732 "type": "object"
3733 },
3734 "PieChartSpec": {
3735 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.",
3736 "id": "PieChartSpec",
3737 "properties": {
3738 "domain": {
3739 "$ref": "ChartData",
3740 "description": "The data that covers the domain of the pie c hart."
3741 },
3742 "threeDimensional": {
3743 "description": "True if the pie is three dimensional.",
3744 "type": "boolean"
3745 },
3746 "series": {
3747 "$ref": "ChartData",
3748 "description": "The data that covers the one and only series of the pie chart."
3749 },
3750 "legendPosition": {
3751 "description": "Where the legend of the pie chart should be drawn.",
3700 "enum": [ 3752 "enum": [
3701 "STYLE_UNSPECIFIED", 3753 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
3702 "DOTTED", 3754 "BOTTOM_LEGEND",
3703 "DASHED", 3755 "LEFT_LEGEND",
3704 "SOLID", 3756 "RIGHT_LEGEND",
3705 "SOLID_MEDIUM", 3757 "TOP_LEGEND",
3706 "SOLID_THICK", 3758 "NO_LEGEND",
3707 "NONE", 3759 "LABELED_LEGEND"
3708 "DOUBLE"
3709 ], 3760 ],
3710 "enumDescriptions": [ 3761 "enumDescriptions": [
3711 "The style is not specified. Do not use this.", 3762 "Default value, do not use.",
3712 "The border is dotted.", 3763 "The legend is rendered on the bottom of the chart.",
3713 "The border is dashed.", 3764 "The legend is rendered on the left of the chart.",
3714 "The border is a thin solid line.", 3765 "The legend is rendered on the right of the chart.",
3715 "The border is a medium solid line.", 3766 "The legend is rendered on the top of the chart.",
3716 "The border is a thick solid line.", 3767 "No legend is rendered.",
3717 "No border.\nUsed only when updating a border in order t o erase it.", 3768 "Each pie slice has a label attached to it."
3718 "The border is two solid lines." 3769 ],
3719 ], 3770 "type": "string"
3720 "type": "string" 3771 },
3721 } 3772 "pieHole": {
3722 }, 3773 "description": "The size of the hole in the pie chart.",
3723 "type": "object" 3774 "format": "double",
3724 }, 3775 "type": "number"
3725 "GridData": { 3776 }
3726 "description": "Data in the grid, as well as metadata about the dime nsions.", 3777 },
3727 "id": "GridData", 3778 "type": "object"
3728 "properties": { 3779 },
3729 "columnMetadata": { 3780 "UpdateFilterViewRequest": {
3730 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.", 3781 "description": "Updates properties of the filter view.",
3731 "items": { 3782 "id": "UpdateFilterViewRequest",
3732 "$ref": "DimensionProperties" 3783 "properties": {
3733 }, 3784 "filter": {
3734 "type": "array" 3785 "$ref": "FilterView",
3735 }, 3786 "description": "The new properties of the filter view."
3736 "startColumn": {
3737 "description": "The first column this GridData refers to, ze ro-based.",
3738 "format": "int32",
3739 "type": "integer"
3740 },
3741 "rowMetadata": {
3742 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
3743 "items": {
3744 "$ref": "DimensionProperties"
3745 },
3746 "type": "array"
3747 },
3748 "rowData": {
3749 "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.",
3750 "items": {
3751 "$ref": "RowData"
3752 },
3753 "type": "array"
3754 },
3755 "startRow": {
3756 "description": "The first row this GridData refers to, zero- based.",
3757 "format": "int32",
3758 "type": "integer"
3759 }
3760 },
3761 "type": "object"
3762 },
3763 "FindReplaceRequest": {
3764 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
3765 "id": "FindReplaceRequest",
3766 "properties": {
3767 "replacement": {
3768 "description": "The value to use as the replacement.",
3769 "type": "string"
3770 },
3771 "range": {
3772 "$ref": "GridRange",
3773 "description": "The range to find/replace over."
3774 },
3775 "sheetId": {
3776 "description": "The sheet to find/replace over.",
3777 "format": "int32",
3778 "type": "integer"
3779 },
3780 "matchCase": {
3781 "description": "True if the search is case sensitive.",
3782 "type": "boolean"
3783 },
3784 "allSheets": {
3785 "description": "True to find/replace over all sheets.",
3786 "type": "boolean"
3787 },
3788 "includeFormulas": {
3789 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
3790 "type": "boolean"
3791 },
3792 "matchEntireCell": {
3793 "description": "True if the find value should match the enti re cell.",
3794 "type": "boolean"
3795 },
3796 "find": {
3797 "description": "The value to search.",
3798 "type": "string"
3799 },
3800 "searchByRegex": {
3801 "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.",
3802 "type": "boolean"
3803 }
3804 },
3805 "type": "object"
3806 },
3807 "UpdateNamedRangeRequest": {
3808 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
3809 "id": "UpdateNamedRangeRequest",
3810 "properties": {
3811 "namedRange": {
3812 "$ref": "NamedRange",
3813 "description": "The named range to update with the new prope rties."
3814 }, 3787 },
3815 "fields": { 3788 "fields": {
3816 "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 .", 3789 "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.",
3817 "format": "google-fieldmask", 3790 "format": "google-fieldmask",
3818 "type": "string" 3791 "type": "string"
3819 } 3792 }
3820 }, 3793 },
3821 "type": "object" 3794 "type": "object"
3822 }, 3795 },
3823 "AddSheetRequest": { 3796 "ConditionalFormatRule": {
3824 "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.", 3797 "description": "A rule describing a conditional format.",
3825 "id": "AddSheetRequest", 3798 "id": "ConditionalFormatRule",
3826 "properties": { 3799 "properties": {
3827 "properties": { 3800 "ranges": {
3828 "$ref": "SheetProperties", 3801 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.",
3829 "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.)"
3830 }
3831 },
3832 "type": "object"
3833 },
3834 "UpdateCellsRequest": {
3835 "description": "Updates all cells in a range with new data.",
3836 "id": "UpdateCellsRequest",
3837 "properties": {
3838 "start": {
3839 "$ref": "GridCoordinate",
3840 "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."
3841 },
3842 "range": {
3843 "$ref": "GridRange",
3844 "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."
3845 },
3846 "rows": {
3847 "description": "The data to write.",
3848 "items": {
3849 "$ref": "RowData"
3850 },
3851 "type": "array"
3852 },
3853 "fields": {
3854 "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.",
3855 "format": "google-fieldmask",
3856 "type": "string"
3857 }
3858 },
3859 "type": "object"
3860 },
3861 "DeleteConditionalFormatRuleResponse": {
3862 "description": "The result of deleting a conditional format rule.",
3863 "id": "DeleteConditionalFormatRuleResponse",
3864 "properties": {
3865 "rule": {
3866 "$ref": "ConditionalFormatRule",
3867 "description": "The rule that was deleted."
3868 }
3869 },
3870 "type": "object"
3871 },
3872 "DeleteRangeRequest": {
3873 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
3874 "id": "DeleteRangeRequest",
3875 "properties": {
3876 "shiftDimension": {
3877 "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.",
3878 "enum": [
3879 "DIMENSION_UNSPECIFIED",
3880 "ROWS",
3881 "COLUMNS"
3882 ],
3883 "enumDescriptions": [
3884 "The default value, do not use.",
3885 "Operates on the rows of a sheet.",
3886 "Operates on the columns of a sheet."
3887 ],
3888 "type": "string"
3889 },
3890 "range": {
3891 "$ref": "GridRange",
3892 "description": "The range of cells to delete."
3893 }
3894 },
3895 "type": "object"
3896 },
3897 "GridCoordinate": {
3898 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
3899 "id": "GridCoordinate",
3900 "properties": {
3901 "sheetId": {
3902 "description": "The sheet this coordinate is on.",
3903 "format": "int32",
3904 "type": "integer"
3905 },
3906 "rowIndex": {
3907 "description": "The row index of the coordinate.",
3908 "format": "int32",
3909 "type": "integer"
3910 },
3911 "columnIndex": {
3912 "description": "The column index of the coordinate.",
3913 "format": "int32",
3914 "type": "integer"
3915 }
3916 },
3917 "type": "object"
3918 },
3919 "UpdateSheetPropertiesRequest": {
3920 "description": "Updates properties of the sheet with the specified\n sheetId.",
3921 "id": "UpdateSheetPropertiesRequest",
3922 "properties": {
3923 "properties": {
3924 "$ref": "SheetProperties",
3925 "description": "The properties to update."
3926 },
3927 "fields": {
3928 "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 .",
3929 "format": "google-fieldmask",
3930 "type": "string"
3931 }
3932 },
3933 "type": "object"
3934 },
3935 "UnmergeCellsRequest": {
3936 "description": "Unmerges cells in the given range.",
3937 "id": "UnmergeCellsRequest",
3938 "properties": {
3939 "range": {
3940 "$ref": "GridRange",
3941 "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."
3942 }
3943 },
3944 "type": "object"
3945 },
3946 "GridProperties": {
3947 "description": "Properties of a grid.",
3948 "id": "GridProperties",
3949 "properties": {
3950 "rowCount": {
3951 "description": "The number of rows in the grid.",
3952 "format": "int32",
3953 "type": "integer"
3954 },
3955 "frozenRowCount": {
3956 "description": "The number of rows that are frozen in the gr id.",
3957 "format": "int32",
3958 "type": "integer"
3959 },
3960 "hideGridlines": {
3961 "description": "True if the grid isn't showing gridlines in the UI.",
3962 "type": "boolean"
3963 },
3964 "columnCount": {
3965 "description": "The number of columns in the grid.",
3966 "format": "int32",
3967 "type": "integer"
3968 },
3969 "frozenColumnCount": {
3970 "description": "The number of columns that are frozen in the grid.",
3971 "format": "int32",
3972 "type": "integer"
3973 }
3974 },
3975 "type": "object"
3976 },
3977 "Sheet": {
3978 "description": "A sheet in a spreadsheet.",
3979 "id": "Sheet",
3980 "properties": {
3981 "bandedRanges": {
3982 "description": "The banded (i.e. alternating colors) ranges on this sheet.",
3983 "items": {
3984 "$ref": "BandedRange"
3985 },
3986 "type": "array"
3987 },
3988 "charts": {
3989 "description": "The specifications of every chart on this sh eet.",
3990 "items": {
3991 "$ref": "EmbeddedChart"
3992 },
3993 "type": "array"
3994 },
3995 "properties": {
3996 "$ref": "SheetProperties",
3997 "description": "The properties of the sheet."
3998 },
3999 "filterViews": {
4000 "description": "The filter views in this sheet.",
4001 "items": {
4002 "$ref": "FilterView"
4003 },
4004 "type": "array"
4005 },
4006 "conditionalFormats": {
4007 "description": "The conditional format rules in this sheet." ,
4008 "items": {
4009 "$ref": "ConditionalFormatRule"
4010 },
4011 "type": "array"
4012 },
4013 "protectedRanges": {
4014 "description": "The protected ranges in this sheet.",
4015 "items": {
4016 "$ref": "ProtectedRange"
4017 },
4018 "type": "array"
4019 },
4020 "basicFilter": {
4021 "$ref": "BasicFilter",
4022 "description": "The filter on this sheet, if any."
4023 },
4024 "merges": {
4025 "description": "The ranges that are merged together.",
4026 "items": { 3802 "items": {
4027 "$ref": "GridRange" 3803 "$ref": "GridRange"
4028 }, 3804 },
4029 "type": "array" 3805 "type": "array"
4030 }, 3806 },
4031 "data": { 3807 "gradientRule": {
4032 "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).", 3808 "$ref": "GradientRule",
3809 "description": "The formatting will vary based on the gradie nts in the rule."
3810 },
3811 "booleanRule": {
3812 "$ref": "BooleanRule",
3813 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
3814 }
3815 },
3816 "type": "object"
3817 },
3818 "CopyPasteRequest": {
3819 "description": "Copies data from the source to the destination.",
3820 "id": "CopyPasteRequest",
3821 "properties": {
3822 "destination": {
3823 "$ref": "GridRange",
3824 "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)."
3825 },
3826 "pasteOrientation": {
3827 "description": "How that data should be oriented when pastin g.",
3828 "enum": [
3829 "NORMAL",
3830 "TRANSPOSE"
3831 ],
3832 "enumDescriptions": [
3833 "Paste normally.",
3834 "Paste transposed, where all rows become columns and vic e versa."
3835 ],
3836 "type": "string"
3837 },
3838 "source": {
3839 "$ref": "GridRange",
3840 "description": "The source range to copy."
3841 },
3842 "pasteType": {
3843 "description": "What kind of data to paste.",
3844 "enum": [
3845 "PASTE_NORMAL",
3846 "PASTE_VALUES",
3847 "PASTE_FORMAT",
3848 "PASTE_NO_BORDERS",
3849 "PASTE_FORMULA",
3850 "PASTE_DATA_VALIDATION",
3851 "PASTE_CONDITIONAL_FORMATTING"
3852 ],
3853 "enumDescriptions": [
3854 "Paste values, formulas, formats, and merges.",
3855 "Paste the values ONLY without formats, formulas, or mer ges.",
3856 "Paste the format and data validation only.",
3857 "Like PASTE_NORMAL but without borders.",
3858 "Paste the formulas only.",
3859 "Paste the data validation only.",
3860 "Paste the conditional formatting rules only."
3861 ],
3862 "type": "string"
3863 }
3864 },
3865 "type": "object"
3866 },
3867 "Request": {
3868 "description": "A single kind of update to apply to a spreadsheet.",
3869 "id": "Request",
3870 "properties": {
3871 "updateBanding": {
3872 "$ref": "UpdateBandingRequest",
3873 "description": "Updates a banded range"
3874 },
3875 "deleteNamedRange": {
3876 "$ref": "DeleteNamedRangeRequest",
3877 "description": "Deletes a named range."
3878 },
3879 "addProtectedRange": {
3880 "$ref": "AddProtectedRangeRequest",
3881 "description": "Adds a protected range."
3882 },
3883 "duplicateSheet": {
3884 "$ref": "DuplicateSheetRequest",
3885 "description": "Duplicates a sheet."
3886 },
3887 "unmergeCells": {
3888 "$ref": "UnmergeCellsRequest",
3889 "description": "Unmerges merged cells."
3890 },
3891 "deleteSheet": {
3892 "$ref": "DeleteSheetRequest",
3893 "description": "Deletes a sheet."
3894 },
3895 "updateEmbeddedObjectPosition": {
3896 "$ref": "UpdateEmbeddedObjectPositionRequest",
3897 "description": "Updates an embedded object's (e.g. chart, im age) position."
3898 },
3899 "updateDimensionProperties": {
3900 "$ref": "UpdateDimensionPropertiesRequest",
3901 "description": "Updates dimensions' properties."
3902 },
3903 "pasteData": {
3904 "$ref": "PasteDataRequest",
3905 "description": "Pastes data (HTML or delimited) into a sheet ."
3906 },
3907 "setBasicFilter": {
3908 "$ref": "SetBasicFilterRequest",
3909 "description": "Sets the basic filter on a sheet."
3910 },
3911 "addConditionalFormatRule": {
3912 "$ref": "AddConditionalFormatRuleRequest",
3913 "description": "Adds a new conditional format rule."
3914 },
3915 "updateCells": {
3916 "$ref": "UpdateCellsRequest",
3917 "description": "Updates many cells at once."
3918 },
3919 "addNamedRange": {
3920 "$ref": "AddNamedRangeRequest",
3921 "description": "Adds a named range."
3922 },
3923 "updateSpreadsheetProperties": {
3924 "$ref": "UpdateSpreadsheetPropertiesRequest",
3925 "description": "Updates the spreadsheet's properties."
3926 },
3927 "deleteEmbeddedObject": {
3928 "$ref": "DeleteEmbeddedObjectRequest",
3929 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
3930 },
3931 "updateFilterView": {
3932 "$ref": "UpdateFilterViewRequest",
3933 "description": "Updates the properties of a filter view."
3934 },
3935 "addBanding": {
3936 "$ref": "AddBandingRequest",
3937 "description": "Adds a new banded range"
3938 },
3939 "appendCells": {
3940 "$ref": "AppendCellsRequest",
3941 "description": "Appends cells after the last row with data i n a sheet."
3942 },
3943 "autoResizeDimensions": {
3944 "$ref": "AutoResizeDimensionsRequest",
3945 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
3946 },
3947 "cutPaste": {
3948 "$ref": "CutPasteRequest",
3949 "description": "Cuts data from one area and pastes it to ano ther."
3950 },
3951 "mergeCells": {
3952 "$ref": "MergeCellsRequest",
3953 "description": "Merges cells together."
3954 },
3955 "updateNamedRange": {
3956 "$ref": "UpdateNamedRangeRequest",
3957 "description": "Updates a named range."
3958 },
3959 "updateSheetProperties": {
3960 "$ref": "UpdateSheetPropertiesRequest",
3961 "description": "Updates a sheet's properties."
3962 },
3963 "autoFill": {
3964 "$ref": "AutoFillRequest",
3965 "description": "Automatically fills in more data based on ex isting data."
3966 },
3967 "deleteDimension": {
3968 "$ref": "DeleteDimensionRequest",
3969 "description": "Deletes rows or columns in a sheet."
3970 },
3971 "sortRange": {
3972 "$ref": "SortRangeRequest",
3973 "description": "Sorts data in a range."
3974 },
3975 "deleteProtectedRange": {
3976 "$ref": "DeleteProtectedRangeRequest",
3977 "description": "Deletes a protected range."
3978 },
3979 "duplicateFilterView": {
3980 "$ref": "DuplicateFilterViewRequest",
3981 "description": "Duplicates a filter view."
3982 },
3983 "addChart": {
3984 "$ref": "AddChartRequest",
3985 "description": "Adds a chart."
3986 },
3987 "findReplace": {
3988 "$ref": "FindReplaceRequest",
3989 "description": "Finds and replaces occurrences of some text with other text."
3990 },
3991 "textToColumns": {
3992 "$ref": "TextToColumnsRequest",
3993 "description": "Converts a column of text into many columns of text."
3994 },
3995 "updateChartSpec": {
3996 "$ref": "UpdateChartSpecRequest",
3997 "description": "Updates a chart's specifications."
3998 },
3999 "updateProtectedRange": {
4000 "$ref": "UpdateProtectedRangeRequest",
4001 "description": "Updates a protected range."
4002 },
4003 "addSheet": {
4004 "$ref": "AddSheetRequest",
4005 "description": "Adds a sheet."
4006 },
4007 "copyPaste": {
4008 "$ref": "CopyPasteRequest",
4009 "description": "Copies data from one area and pastes it to a nother."
4010 },
4011 "deleteFilterView": {
4012 "$ref": "DeleteFilterViewRequest",
4013 "description": "Deletes a filter view from a sheet."
4014 },
4015 "insertDimension": {
4016 "$ref": "InsertDimensionRequest",
4017 "description": "Inserts new rows or columns in a sheet."
4018 },
4019 "deleteRange": {
4020 "$ref": "DeleteRangeRequest",
4021 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
4022 },
4023 "deleteBanding": {
4024 "$ref": "DeleteBandingRequest",
4025 "description": "Removes a banded range"
4026 },
4027 "addFilterView": {
4028 "$ref": "AddFilterViewRequest",
4029 "description": "Adds a filter view."
4030 },
4031 "setDataValidation": {
4032 "$ref": "SetDataValidationRequest",
4033 "description": "Sets data validation for one or more cells."
4034 },
4035 "updateBorders": {
4036 "$ref": "UpdateBordersRequest",
4037 "description": "Updates the borders in a range of cells."
4038 },
4039 "deleteConditionalFormatRule": {
4040 "$ref": "DeleteConditionalFormatRuleRequest",
4041 "description": "Deletes an existing conditional format rule. "
4042 },
4043 "repeatCell": {
4044 "$ref": "RepeatCellRequest",
4045 "description": "Repeats a single cell across a range."
4046 },
4047 "clearBasicFilter": {
4048 "$ref": "ClearBasicFilterRequest",
4049 "description": "Clears the basic filter on a sheet."
4050 },
4051 "appendDimension": {
4052 "$ref": "AppendDimensionRequest",
4053 "description": "Appends dimensions to the end of a sheet."
4054 },
4055 "updateConditionalFormatRule": {
4056 "$ref": "UpdateConditionalFormatRuleRequest",
4057 "description": "Updates an existing conditional format rule. "
4058 },
4059 "insertRange": {
4060 "$ref": "InsertRangeRequest",
4061 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
4062 },
4063 "moveDimension": {
4064 "$ref": "MoveDimensionRequest",
4065 "description": "Moves rows or columns to another location in a sheet."
4066 }
4067 },
4068 "type": "object"
4069 },
4070 "BooleanCondition": {
4071 "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.",
4072 "id": "BooleanCondition",
4073 "properties": {
4074 "type": {
4075 "description": "The type of condition.",
4076 "enum": [
4077 "CONDITION_TYPE_UNSPECIFIED",
4078 "NUMBER_GREATER",
4079 "NUMBER_GREATER_THAN_EQ",
4080 "NUMBER_LESS",
4081 "NUMBER_LESS_THAN_EQ",
4082 "NUMBER_EQ",
4083 "NUMBER_NOT_EQ",
4084 "NUMBER_BETWEEN",
4085 "NUMBER_NOT_BETWEEN",
4086 "TEXT_CONTAINS",
4087 "TEXT_NOT_CONTAINS",
4088 "TEXT_STARTS_WITH",
4089 "TEXT_ENDS_WITH",
4090 "TEXT_EQ",
4091 "TEXT_IS_EMAIL",
4092 "TEXT_IS_URL",
4093 "DATE_EQ",
4094 "DATE_BEFORE",
4095 "DATE_AFTER",
4096 "DATE_ON_OR_BEFORE",
4097 "DATE_ON_OR_AFTER",
4098 "DATE_BETWEEN",
4099 "DATE_NOT_BETWEEN",
4100 "DATE_IS_VALID",
4101 "ONE_OF_RANGE",
4102 "ONE_OF_LIST",
4103 "BLANK",
4104 "NOT_BLANK",
4105 "CUSTOM_FORMULA"
4106 ],
4107 "enumDescriptions": [
4108 "The default value, do not use.",
4109 "The cell's value must be greater than the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
4110 "The cell's value must be greater than or equal to the c ondition's value.\nSupported by data validation, conditional formatting and filt ers.\nRequires a single ConditionValue.",
4111 "The cell's value must be less than the condition's valu e.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4112 "The cell's value must be less than or equal to the cond ition's value.\nSupported by data validation, conditional formatting and filters .\nRequires a single ConditionValue.",
4113 "The cell's value must be equal to the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4114 "The cell's value must be not equal to the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
4115 "The cell's value must be between the two condition valu es.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
4116 "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequ ires exactly two ConditionValues.",
4117 "The cell's value must contain the condition's value.\nS upported by data validation, conditional formatting and filters.\nRequires a sin gle ConditionValue.",
4118 "The cell's value must not contain the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4119 "The cell's value must start with the condition's value. \nSupported by conditional formatting and filters.\nRequires a single ConditionV alue.",
4120 "The cell's value must end with the condition's value.\n Supported by conditional formatting and filters.\nRequires a single ConditionVal ue.",
4121 "The cell's value must be exactly the condition's value. \nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4122 "The cell's value must be a valid email address.\nSuppor ted by data validation.\nRequires no ConditionValues.",
4123 "The cell's value must be a valid URL.\nSupported by dat a validation.\nRequires no ConditionValues.",
4124 "The cell's value must be the same date as the condition 's value.\nSupported by data validation, conditional formatting and filters.\nRe quires a single ConditionValue.",
4125 "The cell's value must be before the date of the conditi on's value.\nSupported by data validation, conditional formatting and filters.\n Requires a single ConditionValue\nthat may be a relative date.",
4126 "The cell's value must be after the date of the conditio n's value.\nSupported by data validation, conditional formatting and filters.\nR equires a single ConditionValue\nthat may be a relative date.",
4127 "The cell's value must be on or before the date of the c ondition's value.\nSupported by data validation.\nRequires a single ConditionVal ue\nthat may be a relative date.",
4128 "The cell's value must be on or after the date of the co ndition's value.\nSupported by data validation.\nRequires a single ConditionValu e\nthat may be a relative date.",
4129 "The cell's value must be between the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
4130 "The cell's value must be outside the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
4131 "The cell's value must be a date.\nSupported by data val idation.\nRequires no ConditionValues.",
4132 "The cell's value must be listed in the grid in conditio n value's range.\nSupported by data validation.\nRequires a single ConditionValu e,\nand the value must be a valid range in A1 notation.",
4133 "The cell's value must in the list of condition values.\ nSupported by data validation.\nSupports any number of condition values,\none pe r item in the list.\nFormulas are not supported in the values.",
4134 "The cell's value must be empty.\nSupported by condition al formatting and filters.\nRequires no ConditionValues.",
4135 "The cell's value must not be empty.\nSupported by condi tional formatting and filters.\nRequires no ConditionValues.",
4136 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue."
4137 ],
4138 "type": "string"
4139 },
4140 "values": {
4141 "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.",
4033 "items": { 4142 "items": {
4034 "$ref": "GridData" 4143 "$ref": "ConditionValue"
4035 }, 4144 },
4036 "type": "array" 4145 "type": "array"
4037 } 4146 }
4038 }, 4147 },
4039 "type": "object" 4148 "type": "object"
4040 }, 4149 },
4041 "SortSpec": { 4150 "GridRange": {
4042 "description": "A sort order associated with a specific column or ro w.", 4151 "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!`.",
4043 "id": "SortSpec", 4152 "id": "GridRange",
4044 "properties": { 4153 "properties": {
4045 "dimensionIndex": { 4154 "startColumnIndex": {
4046 "description": "The dimension the sort should be applied to. ", 4155 "description": "The start column (inclusive) of the range, o r not set if unbounded.",
4047 "format": "int32", 4156 "format": "int32",
4048 "type": "integer" 4157 "type": "integer"
4049 }, 4158 },
4050 "sortOrder": { 4159 "sheetId": {
4051 "description": "The order data should be sorted.", 4160 "description": "The sheet this range is on.",
4161 "format": "int32",
4162 "type": "integer"
4163 },
4164 "endRowIndex": {
4165 "description": "The end row (exclusive) of the range, or not set if unbounded.",
4166 "format": "int32",
4167 "type": "integer"
4168 },
4169 "endColumnIndex": {
4170 "description": "The end column (exclusive) of the range, or not set if unbounded.",
4171 "format": "int32",
4172 "type": "integer"
4173 },
4174 "startRowIndex": {
4175 "description": "The start row (inclusive) of the range, or n ot set if unbounded.",
4176 "format": "int32",
4177 "type": "integer"
4178 }
4179 },
4180 "type": "object"
4181 },
4182 "BasicChartSpec": {
4183 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.",
4184 "id": "BasicChartSpec",
4185 "properties": {
4186 "domains": {
4187 "description": "The domain of data this is charting.\nOnly a single domain is supported.",
4188 "items": {
4189 "$ref": "BasicChartDomain"
4190 },
4191 "type": "array"
4192 },
4193 "lineSmoothing": {
4194 "description": "Gets whether all lines should be rendered sm ooth or straight by default.\nApplies to Line charts.",
4195 "type": "boolean"
4196 },
4197 "headerCount": {
4198 "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.)",
4199 "format": "int32",
4200 "type": "integer"
4201 },
4202 "stackedType": {
4203 "description": "The stacked type for charts that support ver tical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
4052 "enum": [ 4204 "enum": [
4053 "SORT_ORDER_UNSPECIFIED", 4205 "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
4054 "ASCENDING", 4206 "NOT_STACKED",
4055 "DESCENDING" 4207 "STACKED",
4208 "PERCENT_STACKED"
4056 ], 4209 ],
4057 "enumDescriptions": [ 4210 "enumDescriptions": [
4058 "Default value, do not use this.", 4211 "Default value, do not use.",
4059 "Sort ascending.", 4212 "Series are not stacked.",
4060 "Sort descending." 4213 "Series values are stacked, each value is rendered verti cally beginning\nfrom the top of the value below it.",
4061 ], 4214 "Vertical stacks are stretched to reach the top of the c hart, with\nvalues laid out as percentages of each other."
4062 "type": "string" 4215 ],
4063 } 4216 "type": "string"
4064 }, 4217 },
4065 "type": "object" 4218 "axis": {
4066 }, 4219 "description": "The axis on the chart.",
4067 "UpdateEmbeddedObjectPositionResponse": { 4220 "items": {
4068 "description": "The result of updating an embedded object's position .", 4221 "$ref": "BasicChartAxis"
4069 "id": "UpdateEmbeddedObjectPositionResponse", 4222 },
4070 "properties": { 4223 "type": "array"
4071 "position": { 4224 },
4072 "$ref": "EmbeddedObjectPosition", 4225 "threeDimensional": {
4073 "description": "The new position of the embedded object." 4226 "description": "True to make the chart 3D.\nApplies to Bar a nd Column charts.",
4074 } 4227 "type": "boolean"
4075 }, 4228 },
4076 "type": "object" 4229 "chartType": {
4077 }, 4230 "description": "The type of the chart.",
4078 "BooleanRule": { 4231 "enum": [
4079 "description": "A rule that may or may not match, depending on the c ondition.", 4232 "BASIC_CHART_TYPE_UNSPECIFIED",
4080 "id": "BooleanRule", 4233 "BAR",
4081 "properties": { 4234 "LINE",
4082 "format": { 4235 "AREA",
4236 "COLUMN",
4237 "SCATTER",
4238 "COMBO",
4239 "STEPPED_AREA"
4240 ],
4241 "enumDescriptions": [
4242 "Default value, do not use.",
4243 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
4244 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
4245 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
4246 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
4247 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
4248 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
4249 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
4250 ],
4251 "type": "string"
4252 },
4253 "interpolateNulls": {
4254 "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missin g). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Comb o charts.",
4255 "type": "boolean"
4256 },
4257 "series": {
4258 "description": "The data this chart is visualizing.",
4259 "items": {
4260 "$ref": "BasicChartSeries"
4261 },
4262 "type": "array"
4263 },
4264 "legendPosition": {
4265 "description": "The position of the chart legend.",
4266 "enum": [
4267 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
4268 "BOTTOM_LEGEND",
4269 "LEFT_LEGEND",
4270 "RIGHT_LEGEND",
4271 "TOP_LEGEND",
4272 "NO_LEGEND"
4273 ],
4274 "enumDescriptions": [
4275 "Default value, do not use.",
4276 "The legend is rendered on the bottom of the chart.",
4277 "The legend is rendered on the left of the chart.",
4278 "The legend is rendered on the right of the chart.",
4279 "The legend is rendered on the top of the chart.",
4280 "No legend is rendered."
4281 ],
4282 "type": "string"
4283 }
4284 },
4285 "type": "object"
4286 },
4287 "BubbleChartSpec": {
4288 "description": "A <a href=\"/chart/interactive/docs/gallery/bubblech art\">bubble chart</a>.",
4289 "id": "BubbleChartSpec",
4290 "properties": {
4291 "bubbleOpacity": {
4292 "description": "The opacity of the bubbles between 0 and 1.0 .\n0 is fully transparent and 1 is fully opaque.",
4293 "format": "float",
4294 "type": "number"
4295 },
4296 "bubbleSizes": {
4297 "$ref": "ChartData",
4298 "description": "The data contianing the bubble sizes. Bubbl e sizes are used to draw\nthe bubbles at different sizes relative to each other. \nIf specified, group_ids must also be specified. This field is\noptional."
4299 },
4300 "domain": {
4301 "$ref": "ChartData",
4302 "description": "The data containing the bubble x-values. Th ese values locate the bubbles\nin the chart horizontally."
4303 },
4304 "bubbleTextStyle": {
4305 "$ref": "TextFormat",
4306 "description": "The format of the text inside the bubbles.\n Underline and Strikethrough are not supported."
4307 },
4308 "bubbleBorderColor": {
4309 "$ref": "Color",
4310 "description": "The bubble border color."
4311 },
4312 "groupIds": {
4313 "$ref": "ChartData",
4314 "description": "The data containing the bubble group IDs. Al l bubbles with the same group\nID will be drawn in the same color. If bubble_siz es is specified then\nthis field must also be specified but may contain blank va lues.\nThis field is optional."
4315 },
4316 "bubbleLabels": {
4317 "$ref": "ChartData",
4318 "description": "The data containing the bubble labels. Thes e do not need to be unique."
4319 },
4320 "bubbleMinRadiusSize": {
4321 "description": "The minimum radius size of the bubbles, in p ixels.\nIf specific, the field must be a positive value.",
4322 "format": "int32",
4323 "type": "integer"
4324 },
4325 "bubbleMaxRadiusSize": {
4326 "description": "The max radius size of the bubbles, in pixel s.\nIf specified, the field must be a positive value.",
4327 "format": "int32",
4328 "type": "integer"
4329 },
4330 "series": {
4331 "$ref": "ChartData",
4332 "description": "The data contianing the bubble y-values. Th ese values locate the bubbles\nin the chart vertically."
4333 },
4334 "legendPosition": {
4335 "description": "Where the legend of the chart should be draw n.",
4336 "enum": [
4337 "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
4338 "BOTTOM_LEGEND",
4339 "LEFT_LEGEND",
4340 "RIGHT_LEGEND",
4341 "TOP_LEGEND",
4342 "NO_LEGEND",
4343 "INSIDE_LEGEND"
4344 ],
4345 "enumDescriptions": [
4346 "Default value, do not use.",
4347 "The legend is rendered on the bottom of the chart.",
4348 "The legend is rendered on the left of the chart.",
4349 "The legend is rendered on the right of the chart.",
4350 "The legend is rendered on the top of the chart.",
4351 "No legend is rendered.",
4352 "The legend is rendered inside the chart area."
4353 ],
4354 "type": "string"
4355 }
4356 },
4357 "type": "object"
4358 },
4359 "SetDataValidationRequest": {
4360 "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.",
4361 "id": "SetDataValidationRequest",
4362 "properties": {
4363 "rule": {
4364 "$ref": "DataValidationRule",
4365 "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
4366 },
4367 "range": {
4368 "$ref": "GridRange",
4369 "description": "The range the data validation rule should ap ply to."
4370 }
4371 },
4372 "type": "object"
4373 },
4374 "CellData": {
4375 "description": "Data about a specific cell.",
4376 "id": "CellData",
4377 "properties": {
4378 "effectiveValue": {
4379 "$ref": "ExtendedValue",
4380 "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."
4381 },
4382 "formattedValue": {
4383 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.",
4384 "type": "string"
4385 },
4386 "textFormatRuns": {
4387 "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.",
4388 "items": {
4389 "$ref": "TextFormatRun"
4390 },
4391 "type": "array"
4392 },
4393 "hyperlink": {
4394 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnter edValue.formulaValue\nfield.)",
4395 "type": "string"
4396 },
4397 "pivotTable": {
4398 "$ref": "PivotTable",
4399 "description": "A pivot table anchored at this cell. The siz e of pivot table itself\nis computed dynamically based on its data, grouping, fi lters, values,\netc. Only the top-left cell of the pivot table contains the pivo t table\ndefinition. The other cells will contain the calculated values of the\n results of the pivot in their effective_value fields."
4400 },
4401 "userEnteredFormat": {
4083 "$ref": "CellFormat", 4402 "$ref": "CellFormat",
4084 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color." 4403 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
4085 }, 4404 },
4086 "condition": { 4405 "note": {
4087 "$ref": "BooleanCondition", 4406 "description": "Any note on the cell.",
4088 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied." 4407 "type": "string"
4089 } 4408 },
4090 }, 4409 "effectiveFormat": {
4091 "type": "object" 4410 "$ref": "CellFormat",
4092 }, 4411 "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."
4093 "FilterCriteria": { 4412 },
4094 "description": "Criteria for showing/hiding rows in a filter or filt er view.", 4413 "userEnteredValue": {
4095 "id": "FilterCriteria", 4414 "$ref": "ExtendedValue",
4096 "properties": { 4415 "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."
4097 "hiddenValues": { 4416 },
4098 "description": "Values that should be hidden.", 4417 "dataValidation": {
4418 "$ref": "DataValidationRule",
4419 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
4420 }
4421 },
4422 "type": "object"
4423 },
4424 "BatchUpdateSpreadsheetRequest": {
4425 "description": "The request for updating any aspect of a spreadsheet .",
4426 "id": "BatchUpdateSpreadsheetRequest",
4427 "properties": {
4428 "includeSpreadsheetInResponse": {
4429 "description": "Determines if the update response should inc lude the spreadsheet\nresource.",
4430 "type": "boolean"
4431 },
4432 "responseRanges": {
4433 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
4099 "items": { 4434 "items": {
4100 "type": "string" 4435 "type": "string"
4101 }, 4436 },
4102 "type": "array" 4437 "type": "array"
4103 }, 4438 },
4104 "condition": { 4439 "responseIncludeGridData": {
4105 "$ref": "BooleanCondition", 4440 "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.",
4106 "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.)"
4107 }
4108 },
4109 "type": "object"
4110 },
4111 "PivotGroupValueMetadata": {
4112 "description": "Metadata about a value in a pivot grouping.",
4113 "id": "PivotGroupValueMetadata",
4114 "properties": {
4115 "value": {
4116 "$ref": "ExtendedValue",
4117 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
4118 },
4119 "collapsed": {
4120 "description": "True if the data corresponding to the value is collapsed.",
4121 "type": "boolean" 4441 "type": "boolean"
4122 } 4442 },
4123 }, 4443 "requests": {
4124 "type": "object" 4444 "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.",
4125 },
4126 "Editors": {
4127 "description": "The editors of a protected range.",
4128 "id": "Editors",
4129 "properties": {
4130 "users": {
4131 "description": "The email addresses of users with edit acces s to the protected range.",
4132 "items": { 4445 "items": {
4133 "type": "string" 4446 "$ref": "Request"
4134 }, 4447 },
4135 "type": "array" 4448 "type": "array"
4136 }, 4449 }
4137 "groups": { 4450 },
4138 "description": "The email addresses of groups with edit acce ss to the protected range.", 4451 "type": "object"
4139 "items": { 4452 },
4140 "type": "string" 4453 "BasicChartAxis": {
4141 }, 4454 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
4142 "type": "array" 4455 "id": "BasicChartAxis",
4143 }, 4456 "properties": {
4144 "domainUsersCanEdit": { 4457 "position": {
4145 "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.", 4458 "description": "The position of this axis.",
4146 "type": "boolean" 4459 "enum": [
4147 } 4460 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
4148 }, 4461 "BOTTOM_AXIS",
4149 "type": "object" 4462 "LEFT_AXIS",
4150 }, 4463 "RIGHT_AXIS"
4151 "UpdateConditionalFormatRuleRequest": { 4464 ],
4152 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.", 4465 "enumDescriptions": [
4153 "id": "UpdateConditionalFormatRuleRequest", 4466 "Default value, do not use.",
4154 "properties": { 4467 "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.",
4155 "rule": { 4468 "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.",
4156 "$ref": "ConditionalFormatRule", 4469 "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."
4157 "description": "The rule that should replace the rule at the given index." 4470 ],
4158 }, 4471 "type": "string"
4159 "index": { 4472 },
4160 "description": "The zero-based index of the rule that should be replaced or moved.", 4473 "title": {
4161 "format": "int32", 4474 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.",
4162 "type": "integer" 4475 "type": "string"
4163 }, 4476 },
4164 "sheetId": { 4477 "format": {
4165 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.", 4478 "$ref": "TextFormat",
4166 "format": "int32", 4479 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
4167 "type": "integer" 4480 }
4168 }, 4481 },
4169 "newIndex": { 4482 "type": "object"
4170 "description": "The zero-based new index the rule should end up at.", 4483 },
4171 "format": "int32", 4484 "Padding": {
4172 "type": "integer" 4485 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
4173 } 4486 "id": "Padding",
4174 }, 4487 "properties": {
4175 "type": "object" 4488 "right": {
4176 }, 4489 "description": "The right padding of the cell.",
4177 "BasicChartDomain": { 4490 "format": "int32",
4178 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.", 4491 "type": "integer"
4179 "id": "BasicChartDomain", 4492 },
4180 "properties": { 4493 "bottom": {
4181 "domain": { 4494 "description": "The bottom padding of the cell.",
4182 "$ref": "ChartData", 4495 "format": "int32",
4183 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates." 4496 "type": "integer"
4184 } 4497 },
4185 }, 4498 "top": {
4186 "type": "object" 4499 "description": "The top padding of the cell.",
4187 }, 4500 "format": "int32",
4188 "DataValidationRule": { 4501 "type": "integer"
4189 "description": "A data validation rule.", 4502 },
4190 "id": "DataValidationRule", 4503 "left": {
4191 "properties": { 4504 "description": "The left padding of the cell.",
4192 "inputMessage": { 4505 "format": "int32",
4193 "description": "A message to show the user when adding data to the cell.", 4506 "type": "integer"
4194 "type": "string" 4507 }
4195 }, 4508 },
4196 "condition": { 4509 "type": "object"
4197 "$ref": "BooleanCondition", 4510 },
4198 "description": "The condition that data in the cell must mat ch." 4511 "DeleteDimensionRequest": {
4199 }, 4512 "description": "Deletes the dimensions from the sheet.",
4200 "showCustomUi": { 4513 "id": "DeleteDimensionRequest",
4201 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", 4514 "properties": {
4202 "type": "boolean" 4515 "range": {
4203 }, 4516 "$ref": "DimensionRange",
4204 "strict": { 4517 "description": "The dimensions to delete from the sheet."
4205 "description": "True if invalid data should be rejected.", 4518 }
4206 "type": "boolean" 4519 },
4207 } 4520 "type": "object"
4208 },
4209 "type": "object"
4210 } 4521 }
4211 }, 4522 },
4212 "servicePath": "", 4523 "servicePath": "",
4213 "title": "Google Sheets API", 4524 "title": "Google Sheets API",
4214 "version": "v4" 4525 "version": "v4"
4215 } 4526 }
OLDNEW
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/slides__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698