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

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

Issue 2039113004: Api-roll 37: 2016-06-06 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/safebrowsing__v4.json ('k') | discovery/googleapis/youtube__v3.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/drive.readonly": { 5 "https://www.googleapis.com/auth/drive.readonly": {
6 "description": "View the files in your Google Drive" 6 "description": "View the files in your Google Drive"
7 }, 7 },
8 "https://www.googleapis.com/auth/spreadsheets.readonly": { 8 "https://www.googleapis.com/auth/spreadsheets.readonly": {
9 "description": "View your Google Spreadsheets" 9 "description": "View your Google Spreadsheets"
10 }, 10 },
11 "https://www.googleapis.com/auth/drive": { 11 "https://www.googleapis.com/auth/drive": {
12 "description": "View and manage the files in your Google Dri ve" 12 "description": "View and manage the files in your Google Dri ve"
13 }, 13 },
14 "https://www.googleapis.com/auth/spreadsheets": { 14 "https://www.googleapis.com/auth/spreadsheets": {
15 "description": "View and manage your spreadsheets in Google Drive" 15 "description": "View and manage your spreadsheets in Google Drive"
16 } 16 }
17 } 17 }
18 } 18 }
19 }, 19 },
20 "basePath": "", 20 "basePath": "",
21 "baseUrl": "https://sheets.googleapis.com/", 21 "baseUrl": "https://sheets.googleapis.com/",
22 "batchPath": "batch", 22 "batchPath": "batch",
23 "canonicalName": "Sheets", 23 "canonicalName": "Sheets",
24 "description": "An API for reading and modifying Google Sheets.", 24 "description": "Reads and writes Google Sheets.",
25 "discoveryVersion": "v1", 25 "discoveryVersion": "v1",
26 "documentationLink": "https://developers.google.com/sheets/", 26 "documentationLink": "https://developers.google.com/sheets/",
27 "icons": { 27 "icons": {
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", 28 "x16": "http://www.google.com/images/icons/product/search-16.gif",
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" 29 "x32": "http://www.google.com/images/icons/product/search-32.gif"
30 }, 30 },
31 "id": "sheets:v4", 31 "id": "sheets:v4",
32 "kind": "discovery#restDescription", 32 "kind": "discovery#restDescription",
33 "name": "sheets", 33 "name": "sheets",
34 "ownerDomain": "google.com", 34 "ownerDomain": "google.com",
(...skipping 102 matching lines...) Expand 10 before | Expand all | Expand 10 after
137 }, 137 },
138 "response": { 138 "response": {
139 "$ref": "Spreadsheet" 139 "$ref": "Spreadsheet"
140 }, 140 },
141 "scopes": [ 141 "scopes": [
142 "https://www.googleapis.com/auth/drive", 142 "https://www.googleapis.com/auth/drive",
143 "https://www.googleapis.com/auth/spreadsheets" 143 "https://www.googleapis.com/auth/spreadsheets"
144 ] 144 ]
145 }, 145 },
146 "get": { 146 "get": {
147 "description": "Returns the spreadsheet at the given id.\nTh e caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways: specify a field mas k listing\nyour desired fields (using the `fields` URL parameter in HTTP,\nor `F ieldMaskContext.response_mask` in the request extensions in an RPC),\nor by sett ing the\nincludeGridData URL parameter\nto true. If a field mask is set, the `i ncludeGridData` parameter is\nignored.\n\nFor large spreadsheets, it is recommen ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult iple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified u sing A1 notation.", 147 "description": "Returns the spreadsheet at the given ID.\nTh e caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a fiel d mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n * Set the includeGridData\nURL parameter to true. If a field mask is set, the ` includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommen ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult iple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified u sing A1 notation.",
148 "httpMethod": "GET", 148 "httpMethod": "GET",
149 "id": "sheets.spreadsheets.get", 149 "id": "sheets.spreadsheets.get",
150 "parameterOrder": [ 150 "parameterOrder": [
151 "spreadsheetId" 151 "spreadsheetId"
152 ], 152 ],
153 "parameters": { 153 "parameters": {
154 "spreadsheetId": { 154 "spreadsheetId": {
155 "description": "The spreadsheet to request.", 155 "description": "The spreadsheet to request.",
156 "location": "path", 156 "location": "path",
157 "required": true, 157 "required": true,
(...skipping 16 matching lines...) Expand all
174 "$ref": "Spreadsheet" 174 "$ref": "Spreadsheet"
175 }, 175 },
176 "scopes": [ 176 "scopes": [
177 "https://www.googleapis.com/auth/drive", 177 "https://www.googleapis.com/auth/drive",
178 "https://www.googleapis.com/auth/drive.readonly", 178 "https://www.googleapis.com/auth/drive.readonly",
179 "https://www.googleapis.com/auth/spreadsheets", 179 "https://www.googleapis.com/auth/spreadsheets",
180 "https://www.googleapis.com/auth/spreadsheets.readonly" 180 "https://www.googleapis.com/auth/spreadsheets.readonly"
181 ] 181 ]
182 }, 182 },
183 "batchUpdate": { 183 "batchUpdate": {
184 "description": "Applies one or more updates to the spreadshe et.\n\nEach request is validated before\nbeing applied. If any request is not va lid then the entire request will\nfail and nothing will be applied.\n\nSome requ ests have replies to\ngive you some information about how\nthey applied. The rep lies will mirror the requests. For example,\nif you applied 4 updates and the 3 rd one had a reply, then the\nresponse will have 2 empty replies, the actual rep ly, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that all the updat es in the request will be\napplied atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet \nshould reflect your changes.", 184 "description": "Applies one or more updates to the spreadshe et.\n\nEach request is validated before\nbeing applied. If any request is not va lid then the entire request will\nfail and nothing will be applied.\n\nSome requ ests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and t he 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nat ure of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exa ctly your changes after this completes,\nhowever it is guaranteed that the updat es in the request will be\napplied together atomically. Your changes may be alte red with respect to\ncollaborator changes. If there are no collaborators, the sp readsheet\nshould reflect your changes.",
185 "httpMethod": "POST", 185 "httpMethod": "POST",
186 "id": "sheets.spreadsheets.batchUpdate", 186 "id": "sheets.spreadsheets.batchUpdate",
187 "parameterOrder": [ 187 "parameterOrder": [
188 "spreadsheetId" 188 "spreadsheetId"
189 ], 189 ],
190 "parameters": { 190 "parameters": {
191 "spreadsheetId": { 191 "spreadsheetId": {
192 "description": "The spreadsheet to apply the updates to.", 192 "description": "The spreadsheet to apply the updates to.",
193 "location": "path", 193 "location": "path",
194 "required": true, 194 "required": true,
(...skipping 29 matching lines...) Expand all
224 "description": "How the input data should be interpreted.", 224 "description": "How the input data should be interpreted.",
225 "enum": [ 225 "enum": [
226 "INPUT_VALUE_OPTION_UNSPECIFIED", 226 "INPUT_VALUE_OPTION_UNSPECIFIED",
227 "RAW", 227 "RAW",
228 "USER_ENTERED" 228 "USER_ENTERED"
229 ], 229 ],
230 "location": "query", 230 "location": "query",
231 "type": "string" 231 "type": "string"
232 }, 232 },
233 "spreadsheetId": { 233 "spreadsheetId": {
234 "description": "The id of the spreadsheet to update.", 234 "description": "The ID of the spreadsheet to update.",
235 "location": "path", 235 "location": "path",
236 "required": true, 236 "required": true,
237 "type": "string" 237 "type": "string"
238 }, 238 },
239 "range": { 239 "range": {
240 "description": "The A1 notation of the value s to update.", 240 "description": "The A1 notation of the value s to update.",
241 "location": "path", 241 "location": "path",
242 "required": true, 242 "required": true,
243 "type": "string" 243 "type": "string"
244 } 244 }
(...skipping 13 matching lines...) Expand all
258 "get": { 258 "get": {
259 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.", 259 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.",
260 "httpMethod": "GET", 260 "httpMethod": "GET",
261 "id": "sheets.spreadsheets.values.get", 261 "id": "sheets.spreadsheets.values.get",
262 "parameterOrder": [ 262 "parameterOrder": [
263 "spreadsheetId", 263 "spreadsheetId",
264 "range" 264 "range"
265 ], 265 ],
266 "parameters": { 266 "parameters": {
267 "spreadsheetId": { 267 "spreadsheetId": {
268 "description": "The id of the spreadsheet to retrieve data from.", 268 "description": "The ID of the spreadsheet to retrieve data from.",
269 "location": "path", 269 "location": "path",
270 "required": true, 270 "required": true,
271 "type": "string" 271 "type": "string"
272 }, 272 },
273 "valueRenderOption": { 273 "valueRenderOption": {
274 "description": "How values should be represe nted in the output.", 274 "description": "How values should be represe nted in the output.",
275 "enum": [ 275 "enum": [
276 "FORMATTED_VALUE", 276 "FORMATTED_VALUE",
277 "UNFORMATTED_VALUE", 277 "UNFORMATTED_VALUE",
278 "FORMULA" 278 "FORMULA"
279 ], 279 ],
280 "location": "query", 280 "location": "query",
281 "type": "string" 281 "type": "string"
282 }, 282 },
283 "dateTimeRenderOption": { 283 "dateTimeRenderOption": {
284 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if the ValueRenderOpti on option is\nFORMATTED_VALUE.", 284 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.",
285 "enum": [ 285 "enum": [
286 "SERIAL_NUMBER", 286 "SERIAL_NUMBER",
287 "FORMATTED_STRING" 287 "FORMATTED_STRING"
288 ], 288 ],
289 "location": "query", 289 "location": "query",
290 "type": "string" 290 "type": "string"
291 }, 291 },
292 "range": { 292 "range": {
293 "description": "The A1 notation of the value s to retrieve.", 293 "description": "The A1 notation of the value s to retrieve.",
294 "location": "path", 294 "location": "path",
(...skipping 24 matching lines...) Expand all
319 }, 319 },
320 "batchGet": { 320 "batchGet": {
321 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.", 321 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
322 "httpMethod": "GET", 322 "httpMethod": "GET",
323 "id": "sheets.spreadsheets.values.batchGet", 323 "id": "sheets.spreadsheets.values.batchGet",
324 "parameterOrder": [ 324 "parameterOrder": [
325 "spreadsheetId" 325 "spreadsheetId"
326 ], 326 ],
327 "parameters": { 327 "parameters": {
328 "spreadsheetId": { 328 "spreadsheetId": {
329 "description": "The id of the spreadsheet to retrieve data from.", 329 "description": "The ID of the spreadsheet to retrieve data from.",
330 "location": "path", 330 "location": "path",
331 "required": true, 331 "required": true,
332 "type": "string" 332 "type": "string"
333 }, 333 },
334 "ranges": { 334 "ranges": {
335 "description": "The A1 notation of the value s to retrieve.", 335 "description": "The A1 notation of the value s to retrieve.",
336 "location": "query", 336 "location": "query",
337 "repeated": true, 337 "repeated": true,
338 "type": "string" 338 "type": "string"
339 }, 339 },
340 "valueRenderOption": { 340 "valueRenderOption": {
341 "description": "How values should be represe nted in the output.", 341 "description": "How values should be represe nted in the output.",
342 "enum": [ 342 "enum": [
343 "FORMATTED_VALUE", 343 "FORMATTED_VALUE",
344 "UNFORMATTED_VALUE", 344 "UNFORMATTED_VALUE",
345 "FORMULA" 345 "FORMULA"
346 ], 346 ],
347 "location": "query", 347 "location": "query",
348 "type": "string" 348 "type": "string"
349 }, 349 },
350 "dateTimeRenderOption": { 350 "dateTimeRenderOption": {
351 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if ValueRenderOption o ption is\nFORMATTED_VALUE.", 351 "description": "How dates, times, and durati ons should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.",
352 "enum": [ 352 "enum": [
353 "SERIAL_NUMBER", 353 "SERIAL_NUMBER",
354 "FORMATTED_STRING" 354 "FORMATTED_STRING"
355 ], 355 ],
356 "location": "query", 356 "location": "query",
357 "type": "string" 357 "type": "string"
358 }, 358 },
359 "majorDimension": { 359 "majorDimension": {
360 "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]]`.", 360 "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]]`.",
361 "enum": [ 361 "enum": [
(...skipping 10 matching lines...) Expand all
372 "$ref": "BatchGetValuesResponse" 372 "$ref": "BatchGetValuesResponse"
373 }, 373 },
374 "scopes": [ 374 "scopes": [
375 "https://www.googleapis.com/auth/drive", 375 "https://www.googleapis.com/auth/drive",
376 "https://www.googleapis.com/auth/drive.readonly" , 376 "https://www.googleapis.com/auth/drive.readonly" ,
377 "https://www.googleapis.com/auth/spreadsheets", 377 "https://www.googleapis.com/auth/spreadsheets",
378 "https://www.googleapis.com/auth/spreadsheets.re adonly" 378 "https://www.googleapis.com/auth/spreadsheets.re adonly"
379 ] 379 ]
380 }, 380 },
381 "batchUpdate": { 381 "batchUpdate": {
382 "description": "Sets values in a range of a spreadsh eet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one o r more\nValueRanges.", 382 "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption , and one or more\nValueRanges.",
383 "httpMethod": "POST", 383 "httpMethod": "POST",
384 "id": "sheets.spreadsheets.values.batchUpdate", 384 "id": "sheets.spreadsheets.values.batchUpdate",
385 "parameterOrder": [ 385 "parameterOrder": [
386 "spreadsheetId" 386 "spreadsheetId"
387 ], 387 ],
388 "parameters": { 388 "parameters": {
389 "spreadsheetId": { 389 "spreadsheetId": {
390 "description": "The id of the spreadsheet to update.", 390 "description": "The ID of the spreadsheet to update.",
391 "location": "path", 391 "location": "path",
392 "required": true, 392 "required": true,
393 "type": "string" 393 "type": "string"
394 } 394 }
395 }, 395 },
396 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hUpdate", 396 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hUpdate",
397 "request": { 397 "request": {
398 "$ref": "BatchUpdateValuesRequest" 398 "$ref": "BatchUpdateValuesRequest"
399 }, 399 },
400 "response": { 400 "response": {
(...skipping 18 matching lines...) Expand all
419 ], 419 ],
420 "parameters": { 420 "parameters": {
421 "sheetId": { 421 "sheetId": {
422 "description": "The ID of the sheet to copy. ", 422 "description": "The ID of the sheet to copy. ",
423 "format": "int32", 423 "format": "int32",
424 "location": "path", 424 "location": "path",
425 "required": true, 425 "required": true,
426 "type": "integer" 426 "type": "integer"
427 }, 427 },
428 "spreadsheetId": { 428 "spreadsheetId": {
429 "description": "The id of the spreadsheet co ntaining the sheet to copy.", 429 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
430 "location": "path", 430 "location": "path",
431 "required": true, 431 "required": true,
432 "type": "string" 432 "type": "string"
433 } 433 }
434 }, 434 },
435 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo", 435 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo",
436 "request": { 436 "request": {
437 "$ref": "CopySheetToAnotherSpreadsheetRequest" 437 "$ref": "CopySheetToAnotherSpreadsheetRequest"
438 }, 438 },
439 "response": { 439 "response": {
440 "$ref": "SheetProperties" 440 "$ref": "SheetProperties"
441 }, 441 },
442 "scopes": [ 442 "scopes": [
443 "https://www.googleapis.com/auth/drive", 443 "https://www.googleapis.com/auth/drive",
444 "https://www.googleapis.com/auth/spreadsheets" 444 "https://www.googleapis.com/auth/spreadsheets"
445 ] 445 ]
446 } 446 }
447 } 447 }
448 } 448 }
449 } 449 }
450 } 450 }
451 }, 451 },
452 "revision": "20160511", 452 "revision": "20160525",
453 "rootUrl": "https://sheets.googleapis.com/", 453 "rootUrl": "https://sheets.googleapis.com/",
454 "schemas": { 454 "schemas": {
455 "AddNamedRangeResponse": { 455 "AddNamedRangeResponse": {
456 "description": "The result of adding a named range.", 456 "description": "The result of adding a named range.",
457 "id": "AddNamedRangeResponse", 457 "id": "AddNamedRangeResponse",
458 "properties": { 458 "properties": {
459 "namedRange": { 459 "namedRange": {
460 "$ref": "NamedRange", 460 "$ref": "NamedRange",
461 "description": "The named range to add." 461 "description": "The named range to add."
462 } 462 }
(...skipping 103 matching lines...) Expand 10 before | Expand all | Expand 10 after
566 "description": "The new position of the embedded object." 566 "description": "The new position of the embedded object."
567 } 567 }
568 }, 568 },
569 "type": "object" 569 "type": "object"
570 }, 570 },
571 "UpdateConditionalFormatRuleRequest": { 571 "UpdateConditionalFormatRuleRequest": {
572 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.", 572 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
573 "id": "UpdateConditionalFormatRuleRequest", 573 "id": "UpdateConditionalFormatRuleRequest",
574 "properties": { 574 "properties": {
575 "sheetId": { 575 "sheetId": {
576 "description": "The sheet of the rule to move. Required if newIndex is set,\nunused otherwise.", 576 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
577 "format": "int32", 577 "format": "int32",
578 "type": "integer" 578 "type": "integer"
579 }, 579 },
580 "rule": { 580 "rule": {
581 "$ref": "ConditionalFormatRule", 581 "$ref": "ConditionalFormatRule",
582 "description": "The rule that should replace the rule at the given index." 582 "description": "The rule that should replace the rule at the given index."
583 }, 583 },
584 "index": { 584 "index": {
585 "description": "The zero-based index of the rule that should be replaced or moved.", 585 "description": "The zero-based index of the rule that should be replaced or moved.",
586 "format": "int32", 586 "format": "int32",
(...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after
712 }, 712 },
713 "totalUpdatedRows": { 713 "totalUpdatedRows": {
714 "description": "The total number of rows where at least one cell in the row was updated.", 714 "description": "The total number of rows where at least one cell in the row was updated.",
715 "format": "int32", 715 "format": "int32",
716 "type": "integer" 716 "type": "integer"
717 } 717 }
718 }, 718 },
719 "type": "object" 719 "type": "object"
720 }, 720 },
721 "UpdateNamedRangeRequest": { 721 "UpdateNamedRangeRequest": {
722 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.\nIt is an error to specify read only fields in the field mas k.", 722 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
723 "id": "UpdateNamedRangeRequest", 723 "id": "UpdateNamedRangeRequest",
724 "properties": { 724 "properties": {
725 "fields": { 725 "fields": {
726 "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 .", 726 "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 .",
727 "format": "google-fieldmask", 727 "format": "google-fieldmask",
728 "type": "string" 728 "type": "string"
729 }, 729 },
730 "namedRange": { 730 "namedRange": {
731 "$ref": "NamedRange", 731 "$ref": "NamedRange",
732 "description": "The named range to update with the new prope rties." 732 "description": "The named range to update with the new prope rties."
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
782 ], 782 ],
783 "enumDescriptions": [ 783 "enumDescriptions": [
784 "Default value. This value must not be used.", 784 "Default value. This value must not be used.",
785 "Volatile functions are updated on every change.", 785 "Volatile functions are updated on every change.",
786 "Volatile functions are updated on every change and ever y minute.", 786 "Volatile functions are updated on every change and ever y minute.",
787 "Volatile functions are updated on every change and hour ly." 787 "Volatile functions are updated on every change and hour ly."
788 ], 788 ],
789 "type": "string" 789 "type": "string"
790 }, 790 },
791 "locale": { 791 "locale": {
792 "description": "The locale of the spreadsheet in one of the following formats:\n* an ISO 639-1 language code such as `en`\n* an ISO 639-2 la nguage code such as `fil`, if no 639-1 code exists\n* a combination of the ISO l anguage code and country code, such as `en_US`\nNote: when updating this field, not all locales/languages are supported.", 792 "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.",
793 "type": "string" 793 "type": "string"
794 }, 794 },
795 "title": { 795 "title": {
796 "description": "The title of the spreadsheet.", 796 "description": "The title of the spreadsheet.",
797 "type": "string" 797 "type": "string"
798 }, 798 },
799 "defaultFormat": { 799 "defaultFormat": {
800 "$ref": "CellFormat", 800 "$ref": "CellFormat",
801 "description": "The default format of all cells in the sprea dsheet.\nCellData.effectiveFormat will not be set if the cell's format is equal\ nto this default format.\nThis field is read-only." 801 "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."
802 } 802 }
803 }, 803 },
804 "type": "object" 804 "type": "object"
805 }, 805 },
806 "CellData": { 806 "CellData": {
807 "description": "Data about a specific cell.", 807 "description": "Data about a specific cell.",
808 "id": "CellData", 808 "id": "CellData",
809 "properties": { 809 "properties": {
810 "hyperlink": { 810 "hyperlink": {
811 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula.)", 811 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula.)",
(...skipping 18 matching lines...) Expand all
830 "dataValidation": { 830 "dataValidation": {
831 "$ref": "DataValidationRule", 831 "$ref": "DataValidationRule",
832 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule." 832 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
833 }, 833 },
834 "userEnteredFormat": { 834 "userEnteredFormat": {
835 "$ref": "CellFormat", 835 "$ref": "CellFormat",
836 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format." 836 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
837 }, 837 },
838 "pivotTable": { 838 "pivotTable": {
839 "$ref": "PivotTable", 839 "$ref": "PivotTable",
840 "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 pi vot table\ndefinition. The other cells will contain the calculated values of the \nresults of the pivot in their effectiveValue fields." 840 "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."
841 }, 841 },
842 "textFormatRuns": { 842 "textFormatRuns": {
843 "description": "Runs of rich text applied to subsections of the cell.\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.", 843 "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.",
844 "items": { 844 "items": {
845 "$ref": "TextFormatRun" 845 "$ref": "TextFormatRun"
846 }, 846 },
847 "type": "array" 847 "type": "array"
848 }, 848 },
849 "effectiveValue": { 849 "effectiveValue": {
850 "$ref": "ExtendedValue", 850 "$ref": "ExtendedValue",
851 "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." 851 "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."
852 } 852 }
853 }, 853 },
(...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after
984 "The cell's value must be empty.\nSupported by data vali dation, conditional formatting and filters.\nRequires no ConditionValues.", 984 "The cell's value must be empty.\nSupported by data vali dation, conditional formatting and filters.\nRequires no ConditionValues.",
985 "The cell's value must not be empty.\nSupported by data validation, conditional formatting and filters.\nRequires no ConditionValues.", 985 "The cell's value must not be empty.\nSupported by data validation, conditional formatting and filters.\nRequires no ConditionValues.",
986 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue." 986 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue."
987 ], 987 ],
988 "type": "string" 988 "type": "string"
989 } 989 }
990 }, 990 },
991 "type": "object" 991 "type": "object"
992 }, 992 },
993 "DeleteProtectedRangeRequest": { 993 "DeleteProtectedRangeRequest": {
994 "description": "Deletes the protected range with the given id.", 994 "description": "Deletes the protected range with the given ID.",
995 "id": "DeleteProtectedRangeRequest", 995 "id": "DeleteProtectedRangeRequest",
996 "properties": { 996 "properties": {
997 "protectedRangeId": { 997 "protectedRangeId": {
998 "description": "The ID of the protected range to delete.", 998 "description": "The ID of the protected range to delete.",
999 "format": "int32", 999 "format": "int32",
1000 "type": "integer" 1000 "type": "integer"
1001 } 1001 }
1002 }, 1002 },
1003 "type": "object" 1003 "type": "object"
1004 }, 1004 },
1005 "BasicChartDomain": { 1005 "BasicChartDomain": {
1006 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.", 1006 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
1007 "id": "BasicChartDomain", 1007 "id": "BasicChartDomain",
1008 "properties": { 1008 "properties": {
1009 "domain": { 1009 "domain": {
1010 "$ref": "ChartData", 1010 "$ref": "ChartData",
1011 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis be the data representing the dates." 1011 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
1012 } 1012 }
1013 }, 1013 },
1014 "type": "object" 1014 "type": "object"
1015 }, 1015 },
1016 "DimensionRange": { 1016 "DimensionRange": {
1017 "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.", 1017 "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.",
1018 "id": "DimensionRange", 1018 "id": "DimensionRange",
1019 "properties": { 1019 "properties": {
1020 "sheetId": { 1020 "sheetId": {
1021 "description": "The sheet this span is on.", 1021 "description": "The sheet this span is on.",
(...skipping 96 matching lines...) Expand 10 before | Expand all | Expand 10 after
1118 }, 1118 },
1119 "FilterView": { 1119 "FilterView": {
1120 "description": "A filter view.", 1120 "description": "A filter view.",
1121 "id": "FilterView", 1121 "id": "FilterView",
1122 "properties": { 1122 "properties": {
1123 "title": { 1123 "title": {
1124 "description": "The name of the filter view.", 1124 "description": "The name of the filter view.",
1125 "type": "string" 1125 "type": "string"
1126 }, 1126 },
1127 "namedRangeId": { 1127 "namedRangeId": {
1128 "description": "The named range this filter view is backed b y, if any.\n\nWhen writing, only one of range or namedRangeId\nmay be set.", 1128 "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.",
1129 "type": "string" 1129 "type": "string"
1130 }, 1130 },
1131 "sortSpecs": { 1131 "sortSpecs": {
1132 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 1132 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
1133 "items": { 1133 "items": {
1134 "$ref": "SortSpec" 1134 "$ref": "SortSpec"
1135 }, 1135 },
1136 "type": "array" 1136 "type": "array"
1137 }, 1137 },
1138 "range": { 1138 "range": {
1139 "$ref": "GridRange", 1139 "$ref": "GridRange",
1140 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or namedRangeId\nmay be set." 1140 "description": "The range this filter view covers.\n\nWhen w riting, only one of range or named_range_id\nmay be set."
1141 }, 1141 },
1142 "criteria": { 1142 "criteria": {
1143 "additionalProperties": { 1143 "additionalProperties": {
1144 "$ref": "FilterCriteria" 1144 "$ref": "FilterCriteria"
1145 }, 1145 },
1146 "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.", 1146 "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.",
1147 "type": "object" 1147 "type": "object"
1148 }, 1148 },
1149 "filterViewId": { 1149 "filterViewId": {
1150 "description": "The ID of the filter view.", 1150 "description": "The ID of the filter view.",
(...skipping 15 matching lines...) Expand all
1166 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.", 1166 "description": "The sort order per column. Later specificati ons are used when values\nare equal in the earlier specifications.",
1167 "items": { 1167 "items": {
1168 "$ref": "SortSpec" 1168 "$ref": "SortSpec"
1169 }, 1169 },
1170 "type": "array" 1170 "type": "array"
1171 } 1171 }
1172 }, 1172 },
1173 "type": "object" 1173 "type": "object"
1174 }, 1174 },
1175 "TextFormatRun": { 1175 "TextFormatRun": {
1176 "description": "A run of a text format. The format of this run conti nues until explicitly\noverridden in the next run.\nWhen updating, all fields mu st be set.", 1176 "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.",
1177 "id": "TextFormatRun", 1177 "id": "TextFormatRun",
1178 "properties": { 1178 "properties": {
1179 "startIndex": { 1179 "startIndex": {
1180 "description": "The character index where this run starts.", 1180 "description": "The character index where this run starts.",
1181 "format": "int32", 1181 "format": "int32",
1182 "type": "integer" 1182 "type": "integer"
1183 }, 1183 },
1184 "format": { 1184 "format": {
1185 "$ref": "TextFormat", 1185 "$ref": "TextFormat",
1186 "description": "The format of this run. Absent values inher it the cell's format." 1186 "description": "The format of this run. Absent values inher it the cell's format."
(...skipping 15 matching lines...) Expand all
1202 "type": "string" 1202 "type": "string"
1203 } 1203 }
1204 }, 1204 },
1205 "type": "object" 1205 "type": "object"
1206 }, 1206 },
1207 "UpdateConditionalFormatRuleResponse": { 1207 "UpdateConditionalFormatRuleResponse": {
1208 "description": "The result of updating a conditional format rule.", 1208 "description": "The result of updating a conditional format rule.",
1209 "id": "UpdateConditionalFormatRuleResponse", 1209 "id": "UpdateConditionalFormatRuleResponse",
1210 "properties": { 1210 "properties": {
1211 "oldIndex": { 1211 "oldIndex": {
1212 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as newIndex).", 1212 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
1213 "format": "int32", 1213 "format": "int32",
1214 "type": "integer" 1214 "type": "integer"
1215 }, 1215 },
1216 "newRule": { 1216 "newRule": {
1217 "$ref": "ConditionalFormatRule", 1217 "$ref": "ConditionalFormatRule",
1218 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)" 1218 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
1219 }, 1219 },
1220 "oldRule": { 1220 "oldRule": {
1221 "$ref": "ConditionalFormatRule", 1221 "$ref": "ConditionalFormatRule",
1222 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as newRule)." 1222 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)."
1223 }, 1223 },
1224 "newIndex": { 1224 "newIndex": {
1225 "description": "The index of the new rule.", 1225 "description": "The index of the new rule.",
1226 "format": "int32", 1226 "format": "int32",
1227 "type": "integer" 1227 "type": "integer"
1228 } 1228 }
1229 }, 1229 },
1230 "type": "object" 1230 "type": "object"
1231 }, 1231 },
1232 "FilterCriteria": { 1232 "FilterCriteria": {
1233 "description": "Criteria for showing/hiding rows in a filter, filter view.", 1233 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
1234 "id": "FilterCriteria", 1234 "id": "FilterCriteria",
1235 "properties": { 1235 "properties": {
1236 "condition": { 1236 "condition": {
1237 "$ref": "BooleanCondition", 1237 "$ref": "BooleanCondition",
1238 "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.)" 1238 "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.)"
1239 }, 1239 },
1240 "hiddenValues": { 1240 "hiddenValues": {
1241 "description": "Values that should be hidden.", 1241 "description": "Values that should be hidden.",
1242 "items": { 1242 "items": {
1243 "type": "string" 1243 "type": "string"
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
1296 "description": "A list of values to include in the pivot tab le.", 1296 "description": "A list of values to include in the pivot tab le.",
1297 "items": { 1297 "items": {
1298 "$ref": "PivotValue" 1298 "$ref": "PivotValue"
1299 }, 1299 },
1300 "type": "array" 1300 "type": "array"
1301 }, 1301 },
1302 "criteria": { 1302 "criteria": {
1303 "additionalProperties": { 1303 "additionalProperties": {
1304 "$ref": "PivotFilterCriteria" 1304 "$ref": "PivotFilterCriteria"
1305 }, 1305 },
1306 "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`.", 1306 "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`.",
1307 "type": "object" 1307 "type": "object"
1308 } 1308 }
1309 }, 1309 },
1310 "type": "object" 1310 "type": "object"
1311 }, 1311 },
1312 "DataValidationRule": { 1312 "DataValidationRule": {
1313 "description": "A data validation rule.", 1313 "description": "A data validation rule.",
1314 "id": "DataValidationRule", 1314 "id": "DataValidationRule",
1315 "properties": { 1315 "properties": {
1316 "condition": { 1316 "condition": {
1317 "$ref": "BooleanCondition", 1317 "$ref": "BooleanCondition",
1318 "description": "The condition that data in the cell must mat ch." 1318 "description": "The condition that data in the cell must mat ch."
1319 }, 1319 },
1320 "inputMessage": { 1320 "inputMessage": {
1321 "description": "A message to show the user when adding data to the cell.", 1321 "description": "A message to show the user when adding data to the cell.",
1322 "type": "string" 1322 "type": "string"
1323 }, 1323 },
1324 "showCustomUi": { 1324 "showCustomUi": {
1325 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", 1325 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
1326 "type": "boolean" 1326 "type": "boolean"
1327 }, 1327 },
1328 "strict": { 1328 "strict": {
1329 "description": "True if invalid data should be rejected.", 1329 "description": "True if invalid data should be rejected.",
1330 "type": "boolean" 1330 "type": "boolean"
1331 } 1331 }
1332 }, 1332 },
1333 "type": "object" 1333 "type": "object"
1334 }, 1334 },
1335 "UpdateSpreadsheetPropertiesRequest": { 1335 "UpdateSpreadsheetPropertiesRequest": {
1336 "description": "Updates properties of a spreadsheet.\nIt is an error to specify read only fields in the field mask.", 1336 "description": "Updates properties of a spreadsheet.",
1337 "id": "UpdateSpreadsheetPropertiesRequest", 1337 "id": "UpdateSpreadsheetPropertiesRequest",
1338 "properties": { 1338 "properties": {
1339 "fields": { 1339 "fields": {
1340 "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 .", 1340 "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 .",
1341 "format": "google-fieldmask", 1341 "format": "google-fieldmask",
1342 "type": "string" 1342 "type": "string"
1343 }, 1343 },
1344 "properties": { 1344 "properties": {
1345 "$ref": "SpreadsheetProperties", 1345 "$ref": "SpreadsheetProperties",
1346 "description": "The properties to update." 1346 "description": "The properties to update."
(...skipping 21 matching lines...) Expand all
1368 "properties": { 1368 "properties": {
1369 "valueInputOption": { 1369 "valueInputOption": {
1370 "description": "How the input data should be interpreted.", 1370 "description": "How the input data should be interpreted.",
1371 "enum": [ 1371 "enum": [
1372 "INPUT_VALUE_OPTION_UNSPECIFIED", 1372 "INPUT_VALUE_OPTION_UNSPECIFIED",
1373 "RAW", 1373 "RAW",
1374 "USER_ENTERED" 1374 "USER_ENTERED"
1375 ], 1375 ],
1376 "enumDescriptions": [ 1376 "enumDescriptions": [
1377 "Default input value. This value must not be used.", 1377 "Default input value. This value must not be used.",
1378 "The values the user is entered will not be parsed and w ill be stored\nas-is.", 1378 "The values the user has entered will not be parsed and will be stored\nas-is.",
1379 "The values will be parsed as if the user typed them int o the UI.\nNumbers will stay as numbers, but strings may be converted to numbers ,\ndates, etc.. following the same rules that are applied when entering\ntext in to a cell via the Google Sheets UI." 1379 "The values will be parsed as if the user typed them int o the UI.\nNumbers will stay as numbers, but strings may be converted to numbers ,\ndates, etc. following the same rules that are applied when entering\ntext int o a cell via the Google Sheets UI."
1380 ], 1380 ],
1381 "type": "string" 1381 "type": "string"
1382 }, 1382 },
1383 "data": { 1383 "data": {
1384 "description": "The new values to apply to the spreadsheet." , 1384 "description": "The new values to apply to the spreadsheet." ,
1385 "items": { 1385 "items": {
1386 "$ref": "ValueRange" 1386 "$ref": "ValueRange"
1387 }, 1387 },
1388 "type": "array" 1388 "type": "array"
1389 } 1389 }
(...skipping 147 matching lines...) Expand 10 before | Expand all | Expand 10 after
1537 }, 1537 },
1538 "alpha": { 1538 "alpha": {
1539 "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).", 1539 "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).",
1540 "format": "float", 1540 "format": "float",
1541 "type": "number" 1541 "type": "number"
1542 } 1542 }
1543 }, 1543 },
1544 "type": "object" 1544 "type": "object"
1545 }, 1545 },
1546 "AddSheetRequest": { 1546 "AddSheetRequest": {
1547 "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.", 1547 "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.",
1548 "id": "AddSheetRequest", 1548 "id": "AddSheetRequest",
1549 "properties": { 1549 "properties": {
1550 "properties": { 1550 "properties": {
1551 "$ref": "SheetProperties", 1551 "$ref": "SheetProperties",
1552 "description": "The properties the new sheet should have.\nA ll properties are optional.\nIf a sheetId\nis specified, the sheet will use that ID.\n(It is an error to specify the ID of a sheet that already exists.)" 1552 "description": "The properties the new sheet should have.\nA ll properties are optional.\nIf a sheetId\nis specified, the sheet will use that ID.\n(It is an error to specify the ID of a sheet that already exists.)"
1553 } 1553 }
1554 }, 1554 },
1555 "type": "object" 1555 "type": "object"
1556 }, 1556 },
1557 "AddProtectedRangeRequest": { 1557 "AddProtectedRangeRequest": {
1558 "description": "Adds a new protected range.", 1558 "description": "Adds a new protected range.",
1559 "id": "AddProtectedRangeRequest", 1559 "id": "AddProtectedRangeRequest",
1560 "properties": { 1560 "properties": {
1561 "protectedRange": { 1561 "protectedRange": {
1562 "$ref": "ProtectedRange", 1562 "$ref": "ProtectedRange",
1563 "description": "The protected range to be added." 1563 "description": "The protected range to be added."
1564 } 1564 }
1565 }, 1565 },
1566 "type": "object" 1566 "type": "object"
1567 }, 1567 },
1568 "ValueRange": { 1568 "ValueRange": {
1569 "description": "Data within a range of the spreadsheet.", 1569 "description": "Data within a range of the spreadsheet.",
1570 "id": "ValueRange", 1570 "id": "ValueRange",
1571 "properties": { 1571 "properties": {
1572 "values": { 1572 "values": {
1573 "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 and empty values will be skipped.\nTo set a cell to an empty value, set the st ring value to an empty string.", 1573 "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.",
1574 "items": { 1574 "items": {
1575 "items": { 1575 "items": {
1576 "type": "any" 1576 "type": "any"
1577 }, 1577 },
1578 "type": "array" 1578 "type": "array"
1579 }, 1579 },
1580 "type": "array" 1580 "type": "array"
1581 }, 1581 },
1582 "range": { 1582 "range": {
1583 "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.", 1583 "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.",
1584 "type": "string" 1584 "type": "string"
1585 }, 1585 },
1586 "majorDimension": { 1586 "majorDimension": {
1587 "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 [[1,2],[3,4]],\nwhereas requesting range=A1: B2,majorDimension=COLUMNS will return\n[[1,3],[2,4]].\n\nFor input, with range=A 1: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,B 2=4.\n\nWhen writing, if this field is not set, it defaults to ROWS.", 1587 "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.",
1588 "enum": [ 1588 "enum": [
1589 "DIMENSION_UNSPECIFIED", 1589 "DIMENSION_UNSPECIFIED",
1590 "ROWS", 1590 "ROWS",
1591 "COLUMNS" 1591 "COLUMNS"
1592 ], 1592 ],
1593 "enumDescriptions": [ 1593 "enumDescriptions": [
1594 "The default value, do not use.", 1594 "The default value, do not use.",
1595 "Operates on the rows of a sheet.", 1595 "Operates on the rows of a sheet.",
1596 "Operates on the columns of a sheet." 1596 "Operates on the columns of a sheet."
1597 ], 1597 ],
(...skipping 10 matching lines...) Expand all
1608 "description": "The number of non-formula cells changed.", 1608 "description": "The number of non-formula cells changed.",
1609 "format": "int32", 1609 "format": "int32",
1610 "type": "integer" 1610 "type": "integer"
1611 }, 1611 },
1612 "rowsChanged": { 1612 "rowsChanged": {
1613 "description": "The number of rows changed.", 1613 "description": "The number of rows changed.",
1614 "format": "int32", 1614 "format": "int32",
1615 "type": "integer" 1615 "type": "integer"
1616 }, 1616 },
1617 "occurrencesChanged": { 1617 "occurrencesChanged": {
1618 "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`\".", 1618 "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\"`.",
1619 "format": "int32", 1619 "format": "int32",
1620 "type": "integer" 1620 "type": "integer"
1621 }, 1621 },
1622 "formulasChanged": { 1622 "formulasChanged": {
1623 "description": "The number of formula cells changed.", 1623 "description": "The number of formula cells changed.",
1624 "format": "int32", 1624 "format": "int32",
1625 "type": "integer" 1625 "type": "integer"
1626 }, 1626 },
1627 "sheetsChanged": { 1627 "sheetsChanged": {
1628 "description": "The number of sheets changed.", 1628 "description": "The number of sheets changed.",
1629 "format": "int32", 1629 "format": "int32",
1630 "type": "integer" 1630 "type": "integer"
1631 } 1631 }
1632 }, 1632 },
1633 "type": "object" 1633 "type": "object"
1634 }, 1634 },
1635 "CellFormat": { 1635 "CellFormat": {
1636 "description": "The format of a cell.", 1636 "description": "The format of a cell.",
1637 "id": "CellFormat", 1637 "id": "CellFormat",
1638 "properties": { 1638 "properties": {
1639 "horizontalAlignment": { 1639 "horizontalAlignment": {
1640 "description": "The horizontal alignment of the value in cel l.", 1640 "description": "The horizontal alignment of the value in the cell.",
1641 "enum": [ 1641 "enum": [
1642 "HORIZONTAL_ALIGN_UNSPECIFIED", 1642 "HORIZONTAL_ALIGN_UNSPECIFIED",
1643 "LEFT", 1643 "LEFT",
1644 "CENTER", 1644 "CENTER",
1645 "RIGHT" 1645 "RIGHT"
1646 ], 1646 ],
1647 "enumDescriptions": [ 1647 "enumDescriptions": [
1648 "The horizontal alignment is not specified. Do not use t his.", 1648 "The horizontal alignment is not specified. Do not use t his.",
1649 "The text is explicitly aligned to the left of the cell. ", 1649 "The text is explicitly aligned to the left of the cell. ",
1650 "The text is explicitly aligned to the center of the cel l.", 1650 "The text is explicitly aligned to the center of the cel l.",
1651 "The text is explicitly aligned to the right of the cell ." 1651 "The text is explicitly aligned to the right of the cell ."
1652 ], 1652 ],
1653 "type": "string" 1653 "type": "string"
1654 }, 1654 },
1655 "hyperlinkDisplayType": { 1655 "hyperlinkDisplayType": {
1656 "description": "How a hyperlink, if it exists, should be dis played in the cell.", 1656 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
1657 "enum": [ 1657 "enum": [
1658 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED", 1658 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
1659 "LINKED", 1659 "LINKED",
1660 "PLAIN_TEXT" 1660 "PLAIN_TEXT"
1661 ], 1661 ],
1662 "enumDescriptions": [ 1662 "enumDescriptions": [
1663 "The default value: the hyperlink is clickable. Do not u se this.", 1663 "The default value: the hyperlink is rendered. Do not us e this.",
1664 "A hyperlink should be explicitly rendered.", 1664 "A hyperlink should be explicitly rendered.",
1665 "A hyperlink should not be rendered." 1665 "A hyperlink should not be rendered."
1666 ], 1666 ],
1667 "type": "string" 1667 "type": "string"
1668 }, 1668 },
1669 "borders": { 1669 "borders": {
1670 "$ref": "Borders", 1670 "$ref": "Borders",
1671 "description": "The borders of the cell." 1671 "description": "The borders of the cell."
1672 }, 1672 },
1673 "textDirection": { 1673 "textDirection": {
(...skipping 27 matching lines...) Expand all
1701 "enum": [ 1701 "enum": [
1702 "WRAP_STRATEGY_UNSPECIFIED", 1702 "WRAP_STRATEGY_UNSPECIFIED",
1703 "OVERFLOW_CELL", 1703 "OVERFLOW_CELL",
1704 "LEGACY_WRAP", 1704 "LEGACY_WRAP",
1705 "CLIP", 1705 "CLIP",
1706 "WRAP" 1706 "WRAP"
1707 ], 1707 ],
1708 "enumDescriptions": [ 1708 "enumDescriptions": [
1709 "The default value, do not use.", 1709 "The default value, do not use.",
1710 "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. |", 1710 "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. |",
1711 "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|ong <- Word is clipped.\n | word. |", 1711 "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. |",
1712 "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. |", 1712 "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. |",
1713 "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. |" 1713 "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. |"
1714 ], 1714 ],
1715 "type": "string" 1715 "type": "string"
1716 }, 1716 },
1717 "backgroundColor": { 1717 "backgroundColor": {
1718 "$ref": "Color", 1718 "$ref": "Color",
1719 "description": "The background color of the cell." 1719 "description": "The background color of the cell."
1720 }, 1720 },
1721 "verticalAlignment": { 1721 "verticalAlignment": {
1722 "description": "The vertical alignment of the value in cell. ", 1722 "description": "The vertical alignment of the value in the c ell.",
1723 "enum": [ 1723 "enum": [
1724 "VERTICAL_ALIGN_UNSPECIFIED", 1724 "VERTICAL_ALIGN_UNSPECIFIED",
1725 "TOP", 1725 "TOP",
1726 "MIDDLE", 1726 "MIDDLE",
1727 "BOTTOM" 1727 "BOTTOM"
1728 ], 1728 ],
1729 "enumDescriptions": [ 1729 "enumDescriptions": [
1730 "The vertical alignment is not specified. Do not use th is.", 1730 "The vertical alignment is not specified. Do not use th is.",
1731 "The text is explicitly aligned to the top of the cell." , 1731 "The text is explicitly aligned to the top of the cell." ,
1732 "The text is explicitly aligned to the middle of the cel l.", 1732 "The text is explicitly aligned to the middle of the cel l.",
1733 "The text is explicitly aligned to the bottom of the cel l." 1733 "The text is explicitly aligned to the bottom of the cel l."
1734 ], 1734 ],
1735 "type": "string" 1735 "type": "string"
1736 } 1736 }
1737 }, 1737 },
1738 "type": "object" 1738 "type": "object"
1739 }, 1739 },
1740 "MoveDimensionRequest": { 1740 "MoveDimensionRequest": {
1741 "description": "Moves one or more rows or columns.", 1741 "description": "Moves one or more rows or columns.",
1742 "id": "MoveDimensionRequest", 1742 "id": "MoveDimensionRequest",
1743 "properties": { 1743 "properties": {
1744 "source": { 1744 "source": {
1745 "$ref": "DimensionRange", 1745 "$ref": "DimensionRange",
1746 "description": "The source dimensions to move." 1746 "description": "The source dimensions to move."
1747 }, 1747 },
1748 "destinationIndex": { 1748 "destinationIndex": {
1749 "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`.", 1749 "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`.",
1750 "format": "int32", 1750 "format": "int32",
1751 "type": "integer" 1751 "type": "integer"
1752 } 1752 }
1753 }, 1753 },
1754 "type": "object" 1754 "type": "object"
1755 }, 1755 },
1756 "BasicChartAxis": { 1756 "BasicChartAxis": {
1757 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.", 1757 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
1758 "id": "BasicChartAxis", 1758 "id": "BasicChartAxis",
1759 "properties": { 1759 "properties": {
(...skipping 29 matching lines...) Expand all
1789 "id": "PivotGroupSortValueBucket", 1789 "id": "PivotGroupSortValueBucket",
1790 "properties": { 1790 "properties": {
1791 "buckets": { 1791 "buckets": {
1792 "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.", 1792 "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.",
1793 "items": { 1793 "items": {
1794 "$ref": "ExtendedValue" 1794 "$ref": "ExtendedValue"
1795 }, 1795 },
1796 "type": "array" 1796 "type": "array"
1797 }, 1797 },
1798 "valuesIndex": { 1798 "valuesIndex": {
1799 "description": "The offset in the [PivotTable.values] list w hich the values in this\ngrouping should be sorted by.", 1799 "description": "The offset in the PivotTable.values list whi ch the values in this\ngrouping should be sorted by.",
1800 "format": "int32", 1800 "format": "int32",
1801 "type": "integer" 1801 "type": "integer"
1802 } 1802 }
1803 }, 1803 },
1804 "type": "object" 1804 "type": "object"
1805 }, 1805 },
1806 "DimensionProperties": { 1806 "DimensionProperties": {
1807 "description": "Properties about a dimension.", 1807 "description": "Properties about a dimension.",
1808 "id": "DimensionProperties", 1808 "id": "DimensionProperties",
1809 "properties": { 1809 "properties": {
(...skipping 17 matching lines...) Expand all
1827 "description": "The position of an embedded object such as a chart." , 1827 "description": "The position of an embedded object such as a chart." ,
1828 "id": "EmbeddedObjectPosition", 1828 "id": "EmbeddedObjectPosition",
1829 "properties": { 1829 "properties": {
1830 "sheetId": { 1830 "sheetId": {
1831 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.", 1831 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.",
1832 "format": "int32", 1832 "format": "int32",
1833 "type": "integer" 1833 "type": "integer"
1834 }, 1834 },
1835 "overlayPosition": { 1835 "overlayPosition": {
1836 "$ref": "OverlayPosition", 1836 "$ref": "OverlayPosition",
1837 "description": "The position the object is overlaid on top o f a grid." 1837 "description": "The position at which the object is overlaid on top of a grid."
1838 }, 1838 },
1839 "newSheet": { 1839 "newSheet": {
1840 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.", 1840 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
1841 "type": "boolean" 1841 "type": "boolean"
1842 } 1842 }
1843 }, 1843 },
1844 "type": "object" 1844 "type": "object"
1845 }, 1845 },
1846 "InterpolationPoint": { 1846 "InterpolationPoint": {
1847 "description": "A single interpolation point a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and va lue chosen.", 1847 "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.",
1848 "id": "InterpolationPoint", 1848 "id": "InterpolationPoint",
1849 "properties": { 1849 "properties": {
1850 "value": { 1850 "value": {
1851 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.", 1851 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
1852 "type": "string" 1852 "type": "string"
1853 }, 1853 },
1854 "color": { 1854 "color": {
1855 "$ref": "Color", 1855 "$ref": "Color",
1856 "description": "The color this interpolation point should us e." 1856 "description": "The color this interpolation point should us e."
1857 }, 1857 },
(...skipping 145 matching lines...) Expand 10 before | Expand all | Expand 10 after
2003 "items": { 2003 "items": {
2004 "$ref": "GridRange" 2004 "$ref": "GridRange"
2005 }, 2005 },
2006 "type": "array" 2006 "type": "array"
2007 }, 2007 },
2008 "description": { 2008 "description": {
2009 "description": "The description of this protected range.", 2009 "description": "The description of this protected range.",
2010 "type": "string" 2010 "type": "string"
2011 }, 2011 },
2012 "namedRangeId": { 2012 "namedRangeId": {
2013 "description": "The named range this protected range is back ed by, if any.\n\nWhen writing, only one of range or namedRangeId\nmay be set.", 2013 "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. ",
2014 "type": "string" 2014 "type": "string"
2015 }, 2015 },
2016 "requestingUserCanEdit": { 2016 "requestingUserCanEdit": {
2017 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.", 2017 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
2018 "type": "boolean" 2018 "type": "boolean"
2019 }, 2019 },
2020 "editors": { 2020 "editors": {
2021 "$ref": "Editors", 2021 "$ref": "Editors",
2022 "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 warningOnly pr otection." 2022 "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."
2023 }, 2023 },
2024 "protectedRangeId": { 2024 "protectedRangeId": {
2025 "description": "The ID of the protected range.\nThis field i s read-only.", 2025 "description": "The ID of the protected range.\nThis field i s read-only.",
2026 "format": "int32", 2026 "format": "int32",
2027 "type": "integer" 2027 "type": "integer"
2028 }, 2028 },
2029 "warningOnly": { 2029 "warningOnly": {
2030 "description": "True if this this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the u ser\nto confirm the edit.\n\nWhen warning: if this field is true, then editors i s ignored.\nAdditionally, if this field is changed from true to false and the\n` editors` field is not set (nor included in the field mask), then\nthe editors wi ll be set to all the editors in the document.", 2030 "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.",
2031 "type": "boolean" 2031 "type": "boolean"
2032 }, 2032 },
2033 "range": { 2033 "range": {
2034 "$ref": "GridRange", 2034 "$ref": "GridRange",
2035 "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 namedRangeId\nmay be set." 2035 "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."
2036 } 2036 }
2037 }, 2037 },
2038 "type": "object" 2038 "type": "object"
2039 }, 2039 },
2040 "DeleteConditionalFormatRuleRequest": { 2040 "DeleteConditionalFormatRuleRequest": {
2041 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.", 2041 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
2042 "id": "DeleteConditionalFormatRuleRequest", 2042 "id": "DeleteConditionalFormatRuleRequest",
2043 "properties": { 2043 "properties": {
2044 "sheetId": { 2044 "sheetId": {
2045 "description": "The sheet the rule is being deleted from.", 2045 "description": "The sheet the rule is being deleted from.",
2046 "format": "int32", 2046 "format": "int32",
2047 "type": "integer" 2047 "type": "integer"
2048 }, 2048 },
2049 "index": { 2049 "index": {
2050 "description": "The zero-based index of the rule to be delet ed.", 2050 "description": "The zero-based index of the rule to be delet ed.",
2051 "format": "int32", 2051 "format": "int32",
2052 "type": "integer" 2052 "type": "integer"
2053 } 2053 }
2054 }, 2054 },
2055 "type": "object" 2055 "type": "object"
2056 }, 2056 },
2057 "ChartSpec": { 2057 "ChartSpec": {
2058 "description": "The specifications of a chart.", 2058 "description": "The specifications of a chart.",
2059 "id": "ChartSpec", 2059 "id": "ChartSpec",
2060 "properties": { 2060 "properties": {
2061 "hiddenDimensionStrategy": { 2061 "hiddenDimensionStrategy": {
2062 "description": "Determines how the charts will use hidden ro ws or columns.\nThis value is only meaningful if the\nChartData.sourceRange\nis used for a domain or series.", 2062 "description": "Determines how the charts will use hidden ro ws or columns.",
2063 "enum": [ 2063 "enum": [
2064 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED", 2064 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
2065 "SKIP_HIDDEN_ROWS_AND_COLUMNS", 2065 "SKIP_HIDDEN_ROWS_AND_COLUMNS",
2066 "SKIP_HIDDEN_ROWS", 2066 "SKIP_HIDDEN_ROWS",
2067 "SKIP_HIDDEN_COLUMNS", 2067 "SKIP_HIDDEN_COLUMNS",
2068 "SHOW_ALL" 2068 "SHOW_ALL"
2069 ], 2069 ],
2070 "enumDescriptions": [ 2070 "enumDescriptions": [
2071 "Default value, do not use.", 2071 "Default value, do not use.",
2072 "Charts will skip hidden rows and columns.", 2072 "Charts will skip hidden rows and columns.",
2073 "Charts will skip hidden rows only.", 2073 "Charts will skip hidden rows only.",
2074 "Charts will skip hidden columns only.", 2074 "Charts will skip hidden columns only.",
2075 "Charts will not skip any hidden rows or columns." 2075 "Charts will not skip any hidden rows or columns."
2076 ], 2076 ],
2077 "type": "string" 2077 "type": "string"
2078 }, 2078 },
2079 "basicChart": { 2079 "basicChart": {
2080 "$ref": "BasicChartSpec", 2080 "$ref": "BasicChartSpec",
2081 "description": "A basic chart specification, can be one of m any kinds of charts.\nSee BasicChartType for the list of all charts this support s." 2081 "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."
2082 }, 2082 },
2083 "title": { 2083 "title": {
2084 "description": "The title of the chart.", 2084 "description": "The title of the chart.",
2085 "type": "string" 2085 "type": "string"
2086 }, 2086 },
2087 "pieChart": { 2087 "pieChart": {
2088 "$ref": "PieChartSpec", 2088 "$ref": "PieChartSpec",
2089 "description": "A pie chart specification." 2089 "description": "A pie chart specification."
2090 } 2090 }
2091 }, 2091 },
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
2131 "RELATIVE_DATE_UNSPECIFIED", 2131 "RELATIVE_DATE_UNSPECIFIED",
2132 "PAST_YEAR", 2132 "PAST_YEAR",
2133 "PAST_MONTH", 2133 "PAST_MONTH",
2134 "PAST_WEEK", 2134 "PAST_WEEK",
2135 "YESTERDAY", 2135 "YESTERDAY",
2136 "TODAY", 2136 "TODAY",
2137 "TOMORROW" 2137 "TOMORROW"
2138 ], 2138 ],
2139 "enumDescriptions": [ 2139 "enumDescriptions": [
2140 "Default value, do not use.", 2140 "Default value, do not use.",
2141 "The value is the year before today.", 2141 "The value is one year before today.",
2142 "The value is the month before today.", 2142 "The value is one month before today.",
2143 "The value is the week before today.", 2143 "The value is one week before today.",
2144 "The value is yesterday.", 2144 "The value is yesterday.",
2145 "The value is today.", 2145 "The value is today.",
2146 "The value is tomorrow." 2146 "The value is tomorrow."
2147 ], 2147 ],
2148 "type": "string" 2148 "type": "string"
2149 }, 2149 },
2150 "userEnteredValue": { 2150 "userEnteredValue": {
2151 "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 `=`).", 2151 "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 `=`).",
2152 "type": "string" 2152 "type": "string"
2153 } 2153 }
(...skipping 27 matching lines...) Expand all
2181 "PASTE_DATA_VALIDATION", 2181 "PASTE_DATA_VALIDATION",
2182 "PASTE_CONDITIONAL_FORMATTING" 2182 "PASTE_CONDITIONAL_FORMATTING"
2183 ], 2183 ],
2184 "enumDescriptions": [ 2184 "enumDescriptions": [
2185 "Paste values, formulas, formats, and merges.", 2185 "Paste values, formulas, formats, and merges.",
2186 "Paste the values ONLY without formats, formulas, or mer ges.", 2186 "Paste the values ONLY without formats, formulas, or mer ges.",
2187 "Paste the format and data validation only.", 2187 "Paste the format and data validation only.",
2188 "Like PASTE_NORMAL but without borders.", 2188 "Like PASTE_NORMAL but without borders.",
2189 "Paste the formulas only.", 2189 "Paste the formulas only.",
2190 "Paste the data validation only.", 2190 "Paste the data validation only.",
2191 "Paste the color rules only." 2191 "Paste the conditional formatting rules only."
2192 ], 2192 ],
2193 "type": "string" 2193 "type": "string"
2194 }, 2194 },
2195 "html": { 2195 "html": {
2196 "description": "True if the data is HTML.", 2196 "description": "True if the data is HTML.",
2197 "type": "boolean" 2197 "type": "boolean"
2198 } 2198 }
2199 }, 2199 },
2200 "type": "object" 2200 "type": "object"
2201 }, 2201 },
2202 "FindReplaceRequest": { 2202 "FindReplaceRequest": {
2203 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.", 2203 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
2204 "id": "FindReplaceRequest", 2204 "id": "FindReplaceRequest",
2205 "properties": { 2205 "properties": {
2206 "find": { 2206 "find": {
2207 "description": "The value to search.", 2207 "description": "The value to search.",
2208 "type": "string" 2208 "type": "string"
2209 }, 2209 },
2210 "replacement": { 2210 "replacement": {
2211 "description": "The value to use as the replacement.", 2211 "description": "The value to use as the replacement.",
2212 "type": "string" 2212 "type": "string"
2213 }, 2213 },
2214 "searchByRegex": { 2214 "searchByRegex": {
2215 "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.", 2215 "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.",
2216 "type": "boolean" 2216 "type": "boolean"
2217 }, 2217 },
2218 "sheetId": { 2218 "sheetId": {
2219 "description": "The sheet to find/replace over.", 2219 "description": "The sheet to find/replace over.",
2220 "format": "int32", 2220 "format": "int32",
2221 "type": "integer" 2221 "type": "integer"
2222 }, 2222 },
2223 "allSheets": { 2223 "allSheets": {
2224 "description": "True to find/replace over all sheets.", 2224 "description": "True to find/replace over all sheets.",
2225 "type": "boolean" 2225 "type": "boolean"
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
2274 "id": "CopySheetToAnotherSpreadsheetRequest", 2274 "id": "CopySheetToAnotherSpreadsheetRequest",
2275 "properties": { 2275 "properties": {
2276 "destinationSpreadsheetId": { 2276 "destinationSpreadsheetId": {
2277 "description": "The ID of the spreadsheet to copy the sheet to.", 2277 "description": "The ID of the spreadsheet to copy the sheet to.",
2278 "type": "string" 2278 "type": "string"
2279 } 2279 }
2280 }, 2280 },
2281 "type": "object" 2281 "type": "object"
2282 }, 2282 },
2283 "NumberFormat": { 2283 "NumberFormat": {
2284 "description": "The number format of a cell.\nWhen updating, all fie lds must be set.", 2284 "description": "The number format of a cell.",
2285 "id": "NumberFormat", 2285 "id": "NumberFormat",
2286 "properties": { 2286 "properties": {
2287 "pattern": { 2287 "pattern": {
2288 "description": "Pattern string used for formatting.", 2288 "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.",
2289 "type": "string" 2289 "type": "string"
2290 }, 2290 },
2291 "type": { 2291 "type": {
2292 "description": "The type of the number format.", 2292 "description": "The type of the number format.\nWhen writing , this field must be set.",
2293 "enum": [ 2293 "enum": [
2294 "NUMBER_FORMAT_TYPE_UNSPECIFIED", 2294 "NUMBER_FORMAT_TYPE_UNSPECIFIED",
2295 "TEXT", 2295 "TEXT",
2296 "NUMBER", 2296 "NUMBER",
2297 "PERCENT", 2297 "PERCENT",
2298 "CURRENCY", 2298 "CURRENCY",
2299 "DATE", 2299 "DATE",
2300 "TIME", 2300 "TIME",
2301 "DATE_TIME", 2301 "DATE_TIME",
2302 "SCIENTIFIC" 2302 "SCIENTIFIC"
2303 ], 2303 ],
2304 "enumDescriptions": [ 2304 "enumDescriptions": [
2305 "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.", 2305 "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
2306 "Text formatting, e.g `1000.12`", 2306 "Text formatting, e.g `1000.12`",
2307 "Number formatting, e.g, `1,000.12`", 2307 "Number formatting, e.g, `1,000.12`",
2308 "Percent formatting, e.g `10.12%`", 2308 "Percent formatting, e.g `10.12%`",
2309 "Currency formatting, e.g `$1,000.12`", 2309 "Currency formatting, e.g `$1,000.12`",
2310 "Date formatting, e.g `9/26/2008`", 2310 "Date formatting, e.g `9/26/2008`",
2311 "Time formatting, e.g `3:59:00 PM`", 2311 "Time formatting, e.g `3:59:00 PM`",
2312 "Date+Time formatting, e.g `9/26/08 15:59:00`", 2312 "Date+Time formatting, e.g `9/26/08 15:59:00`",
2313 "Scientific number formatting, e.g `1.01E+03`" 2313 "Scientific number formatting, e.g `1.01E+03`"
2314 ], 2314 ],
2315 "type": "string" 2315 "type": "string"
2316 } 2316 }
2317 }, 2317 },
2318 "type": "object" 2318 "type": "object"
2319 }, 2319 },
2320 "UpdateDimensionPropertiesRequest": { 2320 "UpdateDimensionPropertiesRequest": {
2321 "description": "Updates properties of dimensions within the specifie d range.\nIt is an error to specify read only fields in the field mask.", 2321 "description": "Updates properties of dimensions within the specifie d range.",
2322 "id": "UpdateDimensionPropertiesRequest", 2322 "id": "UpdateDimensionPropertiesRequest",
2323 "properties": { 2323 "properties": {
2324 "fields": { 2324 "fields": {
2325 "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 .", 2325 "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 .",
2326 "format": "google-fieldmask", 2326 "format": "google-fieldmask",
2327 "type": "string" 2327 "type": "string"
2328 }, 2328 },
2329 "range": { 2329 "range": {
2330 "$ref": "DimensionRange", 2330 "$ref": "DimensionRange",
2331 "description": "The rows or columns to update." 2331 "description": "The rows or columns to update."
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after
2389 "type": "array" 2389 "type": "array"
2390 } 2390 }
2391 }, 2391 },
2392 "type": "object" 2392 "type": "object"
2393 }, 2393 },
2394 "GridData": { 2394 "GridData": {
2395 "description": "Data in the grid, as well as metadata about the dime nsions.", 2395 "description": "Data in the grid, as well as metadata about the dime nsions.",
2396 "id": "GridData", 2396 "id": "GridData",
2397 "properties": { 2397 "properties": {
2398 "columnMetadata": { 2398 "columnMetadata": {
2399 "description": "Metadata about the requested columns in the grid, starting with the column\nin startColumn.", 2399 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
2400 "items": { 2400 "items": {
2401 "$ref": "DimensionProperties" 2401 "$ref": "DimensionProperties"
2402 }, 2402 },
2403 "type": "array" 2403 "type": "array"
2404 }, 2404 },
2405 "rowData": { 2405 "rowData": {
2406 "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 startColumn.", 2406 "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.",
2407 "items": { 2407 "items": {
2408 "$ref": "RowData" 2408 "$ref": "RowData"
2409 }, 2409 },
2410 "type": "array" 2410 "type": "array"
2411 }, 2411 },
2412 "startRow": { 2412 "startRow": {
2413 "description": "The first row this GridData refers to, zero- based.", 2413 "description": "The first row this GridData refers to, zero- based.",
2414 "format": "int32", 2414 "format": "int32",
2415 "type": "integer" 2415 "type": "integer"
2416 }, 2416 },
2417 "rowMetadata": { 2417 "rowMetadata": {
2418 "description": "Metadata about the requested rows in the gri d, starting with the row\nin startRow.", 2418 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
2419 "items": { 2419 "items": {
2420 "$ref": "DimensionProperties" 2420 "$ref": "DimensionProperties"
2421 }, 2421 },
2422 "type": "array" 2422 "type": "array"
2423 }, 2423 },
2424 "startColumn": { 2424 "startColumn": {
2425 "description": "The first column this GridData refers to, ze ro-based.", 2425 "description": "The first column this GridData refers to, ze ro-based.",
2426 "format": "int32", 2426 "format": "int32",
2427 "type": "integer" 2427 "type": "integer"
2428 } 2428 }
2429 }, 2429 },
2430 "type": "object" 2430 "type": "object"
2431 }, 2431 },
2432 "PivotValue": { 2432 "PivotValue": {
2433 "description": "The definition of how a value in a pivot table shoul d be calculated.", 2433 "description": "The definition of how a value in a pivot table shoul d be calculated.",
2434 "id": "PivotValue", 2434 "id": "PivotValue",
2435 "properties": { 2435 "properties": {
2436 "formula": { 2436 "formula": {
2437 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.", 2437 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.",
2438 "type": "string" 2438 "type": "string"
2439 }, 2439 },
2440 "sourceColumnOffset": { 2440 "sourceColumnOffset": {
2441 "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`.", 2441 "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`.",
2442 "format": "int32", 2442 "format": "int32",
2443 "type": "integer" 2443 "type": "integer"
2444 }, 2444 },
2445 "summarizeFunction": { 2445 "summarizeFunction": {
2446 "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.", 2446 "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.",
2447 "enum": [ 2447 "enum": [
2448 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED", 2448 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
2449 "SUM", 2449 "SUM",
2450 "COUNTA", 2450 "COUNTA",
2451 "COUNT", 2451 "COUNT",
(...skipping 17 matching lines...) Expand all
2469 "Corresponds to the `COUNTUNIQUE` function.", 2469 "Corresponds to the `COUNTUNIQUE` function.",
2470 "Corresponds to the `AVERAGE` function.", 2470 "Corresponds to the `AVERAGE` function.",
2471 "Corresponds to the `MAX` function.", 2471 "Corresponds to the `MAX` function.",
2472 "Corresponds to the `MIN` function.", 2472 "Corresponds to the `MIN` function.",
2473 "Corresponds to the `MEDIAN` function.", 2473 "Corresponds to the `MEDIAN` function.",
2474 "Corresponds to the `PRODUCT` function.", 2474 "Corresponds to the `PRODUCT` function.",
2475 "Corresponds to the `STDEV` function.", 2475 "Corresponds to the `STDEV` function.",
2476 "Corresponds to the `STDEVP` function.", 2476 "Corresponds to the `STDEVP` function.",
2477 "Corresponds to the `VAR` function.", 2477 "Corresponds to the `VAR` function.",
2478 "Corresponds to the `VARP` function.", 2478 "Corresponds to the `VARP` function.",
2479 "Indicates the formula should be used as-is.\nOnly valid if [PivotValue.formula] was set." 2479 "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
2480 ], 2480 ],
2481 "type": "string" 2481 "type": "string"
2482 }, 2482 },
2483 "name": { 2483 "name": {
2484 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.", 2484 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.",
2485 "type": "string" 2485 "type": "string"
2486 } 2486 }
2487 }, 2487 },
2488 "type": "object" 2488 "type": "object"
2489 }, 2489 },
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after
2572 "DASHED", 2572 "DASHED",
2573 "SOLID", 2573 "SOLID",
2574 "NONE", 2574 "NONE",
2575 "DOUBLE" 2575 "DOUBLE"
2576 ], 2576 ],
2577 "enumDescriptions": [ 2577 "enumDescriptions": [
2578 "The style is not specified. Do not use this.", 2578 "The style is not specified. Do not use this.",
2579 "The border is dotted.", 2579 "The border is dotted.",
2580 "The border is dashed.", 2580 "The border is dashed.",
2581 "The border is a solid line.", 2581 "The border is a solid line.",
2582 "No border.\nUsed only when updating a border in order e rase it.", 2582 "No border.\nUsed only when updating a border in order t o erase it.",
2583 "The border is double (two solid lines)." 2583 "The border is two solid lines."
2584 ], 2584 ],
2585 "type": "string" 2585 "type": "string"
2586 }, 2586 },
2587 "width": { 2587 "width": {
2588 "description": "The width of the border, in pixels.\nBorder widths must be between 0 and 3 pixels.", 2588 "description": "The width of the border, in pixels.\nBorder widths must be between 0 and 3 pixels, inclusive.",
2589 "format": "int32", 2589 "format": "int32",
2590 "type": "integer" 2590 "type": "integer"
2591 }, 2591 },
2592 "color": { 2592 "color": {
2593 "$ref": "Color", 2593 "$ref": "Color",
2594 "description": "The color of the border." 2594 "description": "The color of the border."
2595 } 2595 }
2596 }, 2596 },
2597 "type": "object" 2597 "type": "object"
2598 }, 2598 },
(...skipping 13 matching lines...) Expand all
2612 "id": "AddChartResponse", 2612 "id": "AddChartResponse",
2613 "properties": { 2613 "properties": {
2614 "chart": { 2614 "chart": {
2615 "$ref": "EmbeddedChart", 2615 "$ref": "EmbeddedChart",
2616 "description": "The newly added chart." 2616 "description": "The newly added chart."
2617 } 2617 }
2618 }, 2618 },
2619 "type": "object" 2619 "type": "object"
2620 }, 2620 },
2621 "AppendCellsRequest": { 2621 "AppendCellsRequest": {
2622 "description": "Adds new cells to the last row with data in a sheet, \ninserting new rows into the sheet if necessary.", 2622 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
2623 "id": "AppendCellsRequest", 2623 "id": "AppendCellsRequest",
2624 "properties": { 2624 "properties": {
2625 "sheetId": { 2625 "sheetId": {
2626 "description": "The sheet ID to append the data to.", 2626 "description": "The sheet ID to append the data to.",
2627 "format": "int32", 2627 "format": "int32",
2628 "type": "integer" 2628 "type": "integer"
2629 }, 2629 },
2630 "rows": { 2630 "rows": {
2631 "description": "The data to append.", 2631 "description": "The data to append.",
2632 "items": { 2632 "items": {
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
2699 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.", 2699 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
2700 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.", 2700 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
2701 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>." 2701 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>."
2702 ], 2702 ],
2703 "type": "string" 2703 "type": "string"
2704 } 2704 }
2705 }, 2705 },
2706 "type": "object" 2706 "type": "object"
2707 }, 2707 },
2708 "RepeatCellRequest": { 2708 "RepeatCellRequest": {
2709 "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 ing the formula was `=$A$1`, neither\nthe row nor column would increment.", 2709 "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. ",
2710 "id": "RepeatCellRequest", 2710 "id": "RepeatCellRequest",
2711 "properties": { 2711 "properties": {
2712 "cell": { 2712 "cell": {
2713 "$ref": "CellData", 2713 "$ref": "CellData",
2714 "description": "The data to write." 2714 "description": "The data to write."
2715 }, 2715 },
2716 "fields": { 2716 "fields": {
2717 "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be spec ified.\nA single `\"*\"` can be used as short-hand for listing every field.", 2717 "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be spec ified.\nA single `\"*\"` can be used as short-hand for listing every field.",
2718 "format": "google-fieldmask", 2718 "format": "google-fieldmask",
2719 "type": "string" 2719 "type": "string"
(...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after
2832 }, 2832 },
2833 "UpdateEmbeddedObjectPositionRequest": { 2833 "UpdateEmbeddedObjectPositionRequest": {
2834 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).", 2834 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
2835 "id": "UpdateEmbeddedObjectPositionRequest", 2835 "id": "UpdateEmbeddedObjectPositionRequest",
2836 "properties": { 2836 "properties": {
2837 "newPosition": { 2837 "newPosition": {
2838 "$ref": "EmbeddedObjectPosition", 2838 "$ref": "EmbeddedObjectPosition",
2839 "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." 2839 "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."
2840 }, 2840 },
2841 "objectId": { 2841 "objectId": {
2842 "description": "The id of the object to moved.", 2842 "description": "The ID of the object to moved.",
2843 "format": "int32", 2843 "format": "int32",
2844 "type": "integer" 2844 "type": "integer"
2845 }, 2845 },
2846 "fields": { 2846 "fields": {
2847 "description": "The fields of OverlayPosition that should be updated when\nsetting 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.", 2847 "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.",
2848 "format": "google-fieldmask", 2848 "format": "google-fieldmask",
2849 "type": "string" 2849 "type": "string"
2850 } 2850 }
2851 }, 2851 },
2852 "type": "object" 2852 "type": "object"
2853 }, 2853 },
2854 "AutoResizeDimensionsRequest": { 2854 "AutoResizeDimensionsRequest": {
2855 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.", 2855 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
2856 "id": "AutoResizeDimensionsRequest", 2856 "id": "AutoResizeDimensionsRequest",
2857 "properties": { 2857 "properties": {
(...skipping 27 matching lines...) Expand all
2885 "DESCENDING" 2885 "DESCENDING"
2886 ], 2886 ],
2887 "enumDescriptions": [ 2887 "enumDescriptions": [
2888 "Default value, do not use this.", 2888 "Default value, do not use this.",
2889 "Sort ascending.", 2889 "Sort ascending.",
2890 "Sort descending." 2890 "Sort descending."
2891 ], 2891 ],
2892 "type": "string" 2892 "type": "string"
2893 }, 2893 },
2894 "sourceColumnOffset": { 2894 "sourceColumnOffset": {
2895 "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`.", 2895 "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`.",
2896 "format": "int32", 2896 "format": "int32",
2897 "type": "integer" 2897 "type": "integer"
2898 }, 2898 },
2899 "showTotals": { 2899 "showTotals": {
2900 "description": "True if the pivot table should include the t otals for this grouping.", 2900 "description": "True if the pivot table should include the t otals for this grouping.",
2901 "type": "boolean" 2901 "type": "boolean"
2902 }, 2902 },
2903 "valueBucket": { 2903 "valueBucket": {
2904 "$ref": "PivotGroupSortValueBucket", 2904 "$ref": "PivotGroupSortValueBucket",
2905 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values." 2905 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
2906 }, 2906 },
2907 "valueMetadata": { 2907 "valueMetadata": {
2908 "description": "Metadata about values in the grouping.", 2908 "description": "Metadata about values in the grouping.",
2909 "items": { 2909 "items": {
2910 "$ref": "PivotGroupValueMetadata" 2910 "$ref": "PivotGroupValueMetadata"
2911 }, 2911 },
2912 "type": "array" 2912 "type": "array"
2913 } 2913 }
2914 }, 2914 },
2915 "type": "object" 2915 "type": "object"
2916 }, 2916 },
2917 "GridRange": { 2917 "GridRange": {
2918 "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 grid ID 0, then:\n\n Sheet1! 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!A3: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_i d: 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\nThe start ind ex must always be less than or equal to the end index.\nIf the start index equal s the end index, then the range is empty.\nEmpty ranges are typically not meanin gful and are usually rendered in the\nUI as `#REF!`.", 2918 "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!`.",
2919 "id": "GridRange", 2919 "id": "GridRange",
2920 "properties": { 2920 "properties": {
2921 "sheetId": { 2921 "sheetId": {
2922 "description": "The sheet this range is on.", 2922 "description": "The sheet this range is on.",
2923 "format": "int32", 2923 "format": "int32",
2924 "type": "integer" 2924 "type": "integer"
2925 }, 2925 },
2926 "startColumnIndex": { 2926 "startColumnIndex": {
2927 "description": "The start column (inclusive) of the range, o r not set if unbounded.", 2927 "description": "The start column (inclusive) of the range, o r not set if unbounded.",
2928 "format": "int32", 2928 "format": "int32",
(...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after
3041 "PASTE_DATA_VALIDATION", 3041 "PASTE_DATA_VALIDATION",
3042 "PASTE_CONDITIONAL_FORMATTING" 3042 "PASTE_CONDITIONAL_FORMATTING"
3043 ], 3043 ],
3044 "enumDescriptions": [ 3044 "enumDescriptions": [
3045 "Paste values, formulas, formats, and merges.", 3045 "Paste values, formulas, formats, and merges.",
3046 "Paste the values ONLY without formats, formulas, or mer ges.", 3046 "Paste the values ONLY without formats, formulas, or mer ges.",
3047 "Paste the format and data validation only.", 3047 "Paste the format and data validation only.",
3048 "Like PASTE_NORMAL but without borders.", 3048 "Like PASTE_NORMAL but without borders.",
3049 "Paste the formulas only.", 3049 "Paste the formulas only.",
3050 "Paste the data validation only.", 3050 "Paste the data validation only.",
3051 "Paste the color rules only." 3051 "Paste the conditional formatting rules only."
3052 ], 3052 ],
3053 "type": "string" 3053 "type": "string"
3054 }, 3054 },
3055 "pasteOrientation": { 3055 "pasteOrientation": {
3056 "description": "How that data should be oriented when pastin g.", 3056 "description": "How that data should be oriented when pastin g.",
3057 "enum": [ 3057 "enum": [
3058 "NORMAL", 3058 "NORMAL",
3059 "TRANSPOSE" 3059 "TRANSPOSE"
3060 ], 3060 ],
3061 "enumDescriptions": [ 3061 "enumDescriptions": [
(...skipping 120 matching lines...) Expand 10 before | Expand all | Expand 10 after
3182 "PASTE_DATA_VALIDATION", 3182 "PASTE_DATA_VALIDATION",
3183 "PASTE_CONDITIONAL_FORMATTING" 3183 "PASTE_CONDITIONAL_FORMATTING"
3184 ], 3184 ],
3185 "enumDescriptions": [ 3185 "enumDescriptions": [
3186 "Paste values, formulas, formats, and merges.", 3186 "Paste values, formulas, formats, and merges.",
3187 "Paste the values ONLY without formats, formulas, or mer ges.", 3187 "Paste the values ONLY without formats, formulas, or mer ges.",
3188 "Paste the format and data validation only.", 3188 "Paste the format and data validation only.",
3189 "Like PASTE_NORMAL but without borders.", 3189 "Like PASTE_NORMAL but without borders.",
3190 "Paste the formulas only.", 3190 "Paste the formulas only.",
3191 "Paste the data validation only.", 3191 "Paste the data validation only.",
3192 "Paste the color rules only." 3192 "Paste the conditional formatting rules only."
3193 ], 3193 ],
3194 "type": "string" 3194 "type": "string"
3195 }, 3195 },
3196 "source": { 3196 "source": {
3197 "$ref": "GridRange", 3197 "$ref": "GridRange",
3198 "description": "The source data to cut." 3198 "description": "The source data to cut."
3199 }, 3199 },
3200 "destination": { 3200 "destination": {
3201 "$ref": "GridCoordinate", 3201 "$ref": "GridCoordinate",
3202 "description": "The top-left coordinate where the data shoul d be pasted." 3202 "description": "The top-left coordinate where the data shoul d be pasted."
(...skipping 91 matching lines...) Expand 10 before | Expand all | Expand 10 after
3294 "type": "boolean" 3294 "type": "boolean"
3295 }, 3295 },
3296 "domain": { 3296 "domain": {
3297 "$ref": "ChartData", 3297 "$ref": "ChartData",
3298 "description": "The data that covers the domain of the pie c hart." 3298 "description": "The data that covers the domain of the pie c hart."
3299 } 3299 }
3300 }, 3300 },
3301 "type": "object" 3301 "type": "object"
3302 }, 3302 },
3303 "UpdateSheetPropertiesRequest": { 3303 "UpdateSheetPropertiesRequest": {
3304 "description": "Updates properties of the sheet with the specified\n sheetId.\nIt is an error to specify read only fields in the field mask.", 3304 "description": "Updates properties of the sheet with the specified\n sheetId.",
3305 "id": "UpdateSheetPropertiesRequest", 3305 "id": "UpdateSheetPropertiesRequest",
3306 "properties": { 3306 "properties": {
3307 "fields": { 3307 "fields": {
3308 "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 .", 3308 "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 .",
3309 "format": "google-fieldmask", 3309 "format": "google-fieldmask",
3310 "type": "string" 3310 "type": "string"
3311 }, 3311 },
3312 "properties": { 3312 "properties": {
3313 "$ref": "SheetProperties", 3313 "$ref": "SheetProperties",
3314 "description": "The properties to update." 3314 "description": "The properties to update."
(...skipping 201 matching lines...) Expand 10 before | Expand all | Expand 10 after
3516 "updateDimensionProperties": { 3516 "updateDimensionProperties": {
3517 "$ref": "UpdateDimensionPropertiesRequest", 3517 "$ref": "UpdateDimensionPropertiesRequest",
3518 "description": "Updates dimensions' properties." 3518 "description": "Updates dimensions' properties."
3519 }, 3519 },
3520 "deleteSheet": { 3520 "deleteSheet": {
3521 "$ref": "DeleteSheetRequest", 3521 "$ref": "DeleteSheetRequest",
3522 "description": "Deletes a sheet." 3522 "description": "Deletes a sheet."
3523 }, 3523 },
3524 "findReplace": { 3524 "findReplace": {
3525 "$ref": "FindReplaceRequest", 3525 "$ref": "FindReplaceRequest",
3526 "description": "Finds and replace occurrences of some text w ith other text." 3526 "description": "Finds and replaces occurrences of some text with other text."
3527 }, 3527 },
3528 "addProtectedRange": { 3528 "addProtectedRange": {
3529 "$ref": "AddProtectedRangeRequest", 3529 "$ref": "AddProtectedRangeRequest",
3530 "description": "Adds a protected range." 3530 "description": "Adds a protected range."
3531 }, 3531 },
3532 "deleteProtectedRange": { 3532 "deleteProtectedRange": {
3533 "$ref": "DeleteProtectedRangeRequest", 3533 "$ref": "DeleteProtectedRangeRequest",
3534 "description": "Deletes a protected range." 3534 "description": "Deletes a protected range."
3535 }, 3535 },
3536 "updateConditionalFormatRule": { 3536 "updateConditionalFormatRule": {
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after
3588 "duplicateFilterView": { 3588 "duplicateFilterView": {
3589 "$ref": "DuplicateFilterViewRequest", 3589 "$ref": "DuplicateFilterViewRequest",
3590 "description": "Duplicates a filter view." 3590 "description": "Duplicates a filter view."
3591 }, 3591 },
3592 "cutPaste": { 3592 "cutPaste": {
3593 "$ref": "CutPasteRequest", 3593 "$ref": "CutPasteRequest",
3594 "description": "Cuts data from one area and pastes it to ano ther." 3594 "description": "Cuts data from one area and pastes it to ano ther."
3595 }, 3595 },
3596 "appendCells": { 3596 "appendCells": {
3597 "$ref": "AppendCellsRequest", 3597 "$ref": "AppendCellsRequest",
3598 "description": "Appends cells to the last row with data in a sheet." 3598 "description": "Appends cells after the last row with data i n a sheet."
3599 }, 3599 },
3600 "addNamedRange": { 3600 "addNamedRange": {
3601 "$ref": "AddNamedRangeRequest", 3601 "$ref": "AddNamedRangeRequest",
3602 "description": "Adds a named range." 3602 "description": "Adds a named range."
3603 }, 3603 },
3604 "autoFill": { 3604 "autoFill": {
3605 "$ref": "AutoFillRequest", 3605 "$ref": "AutoFillRequest",
3606 "description": "Automatically fills in more data based on ex isting data." 3606 "description": "Automatically fills in more data based on ex isting data."
3607 }, 3607 },
3608 "moveDimension": { 3608 "moveDimension": {
(...skipping 20 matching lines...) Expand all
3629 "id": "BatchGetValuesResponse", 3629 "id": "BatchGetValuesResponse",
3630 "properties": { 3630 "properties": {
3631 "valueRanges": { 3631 "valueRanges": {
3632 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.", 3632 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
3633 "items": { 3633 "items": {
3634 "$ref": "ValueRange" 3634 "$ref": "ValueRange"
3635 }, 3635 },
3636 "type": "array" 3636 "type": "array"
3637 }, 3637 },
3638 "spreadsheetId": { 3638 "spreadsheetId": {
3639 "description": "The id of the spreadsheet to retrieve data f rom.", 3639 "description": "The ID of the spreadsheet the data was retri eved from.",
3640 "type": "string" 3640 "type": "string"
3641 } 3641 }
3642 }, 3642 },
3643 "type": "object" 3643 "type": "object"
3644 }, 3644 },
3645 "InsertDimensionRequest": { 3645 "InsertDimensionRequest": {
3646 "description": "Inserts rows or columns in a sheet at a particular i ndex.", 3646 "description": "Inserts rows or columns in a sheet at a particular i ndex.",
3647 "id": "InsertDimensionRequest", 3647 "id": "InsertDimensionRequest",
3648 "properties": { 3648 "properties": {
3649 "inheritFromBefore": { 3649 "inheritFromBefore": {
3650 "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 rows after the insertion point were green ).", 3650 "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). ",
3651 "type": "boolean" 3651 "type": "boolean"
3652 }, 3652 },
3653 "range": { 3653 "range": {
3654 "$ref": "DimensionRange", 3654 "$ref": "DimensionRange",
3655 "description": "The dimensions to insert. Both the start an d end indexes must be bounded." 3655 "description": "The dimensions to insert. Both the start an d end indexes must be bounded."
3656 } 3656 }
3657 }, 3657 },
3658 "type": "object" 3658 "type": "object"
3659 }, 3659 },
3660 "DeleteEmbeddedObjectRequest": { 3660 "DeleteEmbeddedObjectRequest": {
(...skipping 17 matching lines...) Expand all
3678 "description": "The rule that was deleted." 3678 "description": "The rule that was deleted."
3679 } 3679 }
3680 }, 3680 },
3681 "type": "object" 3681 "type": "object"
3682 } 3682 }
3683 }, 3683 },
3684 "servicePath": "", 3684 "servicePath": "",
3685 "title": "Google Sheets API", 3685 "title": "Google Sheets API",
3686 "version": "v4" 3686 "version": "v4"
3687 } 3687 }
OLDNEW
« no previous file with comments | « discovery/googleapis/safebrowsing__v4.json ('k') | discovery/googleapis/youtube__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698