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