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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/sheets__v4.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/slides__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/sheets__v4.json
diff --git a/discovery/googleapis/sheets__v4.json b/discovery/googleapis/sheets__v4.json
index acde02a66eb75a74ccecc70cc2b85b7e73053ca9..1ea9c786d13fe5b4b68252366242c3753b49d85d 100644
--- a/discovery/googleapis/sheets__v4.json
+++ b/discovery/googleapis/sheets__v4.json
@@ -2,9 +2,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
- },
"https://www.googleapis.com/auth/drive.file": {
"description": "View and manage Google Drive files and folders that you have opened or created with this app"
},
@@ -16,6 +13,9 @@
},
"https://www.googleapis.com/auth/spreadsheets.readonly": {
"description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
}
}
}
@@ -37,39 +37,13 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
@@ -86,6 +60,11 @@
"location": "query",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -102,13 +81,13 @@
"location": "query",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
@@ -122,6 +101,27 @@
"description": "Pretty-print response.",
"location": "query",
"type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
}
},
"protocol": "rest",
@@ -226,6 +226,17 @@
"range"
],
"parameters": {
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "range": {
+ "description": "The A1 notation of the values to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"spreadsheetId": {
"description": "The ID of the spreadsheet to update.",
"location": "path",
@@ -260,17 +271,6 @@
],
"location": "query",
"type": "string"
- },
- "range": {
- "description": "The A1 notation of the values to update.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
- "location": "query",
- "type": "boolean"
}
},
"path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
@@ -420,6 +420,22 @@
"range"
],
"parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "responseValueRenderOption": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "location": "query",
+ "type": "string"
+ },
"insertDataOption": {
"description": "How the input data should be inserted.",
"enum": [
@@ -458,22 +474,6 @@
"description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
"location": "query",
"type": "boolean"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "location": "query",
- "type": "string"
}
},
"path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
@@ -526,18 +526,6 @@
"range"
],
"parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "range": {
- "description": "The A1 notation of the values to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"valueRenderOption": {
"description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
"enum": [
@@ -566,6 +554,18 @@
],
"location": "query",
"type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "range": {
+ "description": "The A1 notation of the values to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
"path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
@@ -593,18 +593,18 @@
"sheetId"
],
"parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet containing the sheet to copy.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"sheetId": {
"description": "The ID of the sheet to copy.",
"format": "int32",
"location": "path",
"required": true,
"type": "integer"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet containing the sheet to copy.",
- "location": "path",
- "required": true,
- "type": "string"
}
},
"path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
@@ -625,2326 +625,2414 @@
}
}
},
- "revision": "20170519",
+ "revision": "20170602",
"rootUrl": "https://sheets.googleapis.com/",
"schemas": {
- "PasteDataRequest": {
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "id": "PasteDataRequest",
- "properties": {
- "type": {
- "description": "How the data should be pasted.",
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ],
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "type": "string"
- },
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- },
- "coordinate": {
- "$ref": "GridCoordinate",
- "description": "The coordinate at which the data should start being inserted."
- },
- "data": {
- "description": "The data to insert.",
- "type": "string"
- },
- "delimiter": {
- "description": "The delimiter in the data.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AppendDimensionRequest": {
- "description": "Appends rows or columns to the end of a sheet.",
- "id": "AppendDimensionRequest",
+ "UpdateChartSpecRequest": {
+ "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
+ "id": "UpdateChartSpecRequest",
"properties": {
- "sheetId": {
- "description": "The sheet to append rows or columns to.",
- "format": "int32",
- "type": "integer"
- },
- "dimension": {
- "description": "Whether rows or columns should be appended.",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "type": "string"
+ "spec": {
+ "$ref": "ChartSpec",
+ "description": "The specification to apply to the chart."
},
- "length": {
- "description": "The number of rows or columns to append.",
+ "chartId": {
+ "description": "The ID of the chart to update.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "AddNamedRangeRequest": {
- "description": "Adds a named range to the spreadsheet.",
- "id": "AddNamedRangeRequest",
+ "DeleteFilterViewRequest": {
+ "description": "Deletes a particular filter view.",
+ "id": "DeleteFilterViewRequest",
"properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ "filterId": {
+ "description": "The ID of the filter to delete.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "UpdateEmbeddedObjectPositionRequest": {
- "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
- "id": "UpdateEmbeddedObjectPositionRequest",
+ "BatchUpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "id": "BatchUpdateValuesResponse",
"properties": {
- "newPosition": {
- "$ref": "EmbeddedObjectPosition",
- "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
+ "responses": {
+ "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
+ "items": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "type": "array"
},
- "fields": {
- "description": "The fields of OverlayPosition\nthat should be 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 `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
"type": "string"
},
- "objectId": {
- "description": "The ID of the object to moved.",
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "TextRotation": {
- "description": "The rotation applied to text in a cell.",
- "id": "TextRotation",
+ "SortRangeRequest": {
+ "description": "Sorts data in rows based on a sort order per column.",
+ "id": "SortRangeRequest",
"properties": {
- "angle": {
- "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
- "format": "int32",
- "type": "integer"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to sort."
},
- "vertical": {
- "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
- "type": "boolean"
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "PieChartSpec": {
- "description": "A <a href=\"/chart/interactive/docs/gallery/piechart\">pie chart</a>.",
- "id": "PieChartSpec",
+ "MergeCellsRequest": {
+ "description": "Merges all cells in the range.",
+ "id": "MergeCellsRequest",
"properties": {
- "domain": {
- "$ref": "ChartData",
- "description": "The data that covers the domain of the pie chart."
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- },
- "series": {
- "$ref": "ChartData",
- "description": "The data that covers the one and only series of the pie chart."
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to merge."
},
- "legendPosition": {
- "description": "Where the legend of the pie chart should be drawn.",
+ "mergeType": {
+ "description": "How the cells should be merged.",
"enum": [
- "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "LABELED_LEGEND"
+ "MERGE_ALL",
+ "MERGE_COLUMNS",
+ "MERGE_ROWS"
],
"enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "Each pie slice has a label attached to it."
+ "Create a single merge from the range",
+ "Create a merge for each column in the range",
+ "Create a merge for each row in the range"
],
"type": "string"
- },
- "pieHole": {
- "description": "The size of the hole in the pie chart.",
- "format": "double",
- "type": "number"
}
},
"type": "object"
},
- "UpdateFilterViewRequest": {
- "description": "Updates properties of the filter view.",
- "id": "UpdateFilterViewRequest",
+ "AddProtectedRangeRequest": {
+ "description": "Adds a new protected range.",
+ "id": "AddProtectedRangeRequest",
"properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
}
},
"type": "object"
},
- "ConditionalFormatRule": {
- "description": "A rule describing a conditional format.",
- "id": "ConditionalFormatRule",
+ "BatchClearValuesRequest": {
+ "description": "The request for clearing more than one range of values in a spreadsheet.",
+ "id": "BatchClearValuesRequest",
"properties": {
- "gradientRule": {
- "$ref": "GradientRule",
- "description": "The formatting will vary based on the gradients in the rule."
- },
- "booleanRule": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
- },
"ranges": {
- "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
+ "description": "The ranges to clear, in A1 notation.",
"items": {
- "$ref": "GridRange"
+ "type": "string"
},
"type": "array"
}
},
"type": "object"
},
- "CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
- "id": "CopyPasteRequest",
+ "DuplicateFilterViewResponse": {
+ "description": "The result of a filter view being duplicated.",
+ "id": "DuplicateFilterViewResponse",
"properties": {
- "destination": {
- "$ref": "GridRange",
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
- },
- "pasteOrientation": {
- "description": "How that data should be oriented when pasting.",
- "enum": [
- "NORMAL",
- "TRANSPOSE"
- ],
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ],
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly created filter."
+ }
+ },
+ "type": "object"
+ },
+ "DuplicateSheetResponse": {
+ "description": "The result of duplicating a sheet.",
+ "id": "DuplicateSheetResponse",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the duplicate sheet."
+ }
+ },
+ "type": "object"
+ },
+ "ClearBasicFilterRequest": {
+ "description": "Clears the basic filter, if any exists on the sheet.",
+ "id": "ClearBasicFilterRequest",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet ID on which the basic filter should be cleared.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TextToColumnsRequest": {
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "id": "TextToColumnsRequest",
+ "properties": {
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
"type": "string"
},
"source": {
"$ref": "GridRange",
- "description": "The source range to copy."
+ "description": "The source data range. This must span exactly one column."
},
- "pasteType": {
- "description": "What kind of data to paste.",
+ "delimiterType": {
+ "description": "The delimiter type to use.",
"enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM"
],
"enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
],
"type": "string"
}
},
"type": "object"
},
- "Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "id": "Request",
+ "BatchUpdateSpreadsheetResponse": {
+ "description": "The reply for batch updating a spreadsheet.",
+ "id": "BatchUpdateSpreadsheetResponse",
"properties": {
- "sortRange": {
- "$ref": "SortRangeRequest",
- "description": "Sorts data in a range."
- },
- "deleteProtectedRange": {
- "$ref": "DeleteProtectedRangeRequest",
- "description": "Deletes a protected range."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewRequest",
- "description": "Duplicates a filter view."
+ "replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
+ "items": {
+ "$ref": "Response"
+ },
+ "type": "array"
},
- "addChart": {
- "$ref": "AddChartRequest",
- "description": "Adds a chart."
+ "updatedSpreadsheet": {
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
},
- "findReplace": {
- "$ref": "FindReplaceRequest",
- "description": "Finds and replaces occurrences of some text with other text."
- },
- "updateChartSpec": {
- "$ref": "UpdateChartSpecRequest",
- "description": "Updates a chart's specifications."
- },
- "textToColumns": {
- "$ref": "TextToColumnsRequest",
- "description": "Converts a column of text into many columns of text."
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "copyPaste": {
- "$ref": "CopyPasteRequest",
- "description": "Copies data from one area and pastes it to another."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "insertDimension": {
- "$ref": "InsertDimensionRequest",
- "description": "Inserts new rows or columns in a sheet."
- },
- "deleteRange": {
- "$ref": "DeleteRangeRequest",
- "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
- },
- "deleteBanding": {
- "$ref": "DeleteBandingRequest",
- "description": "Removes a banded range"
- },
- "addFilterView": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
- },
- "updateBorders": {
- "$ref": "UpdateBordersRequest",
- "description": "Updates the borders in a range of cells."
- },
- "setDataValidation": {
- "$ref": "SetDataValidationRequest",
- "description": "Sets data validation for one or more cells."
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleRequest",
- "description": "Deletes an existing conditional format rule."
- },
- "clearBasicFilter": {
- "$ref": "ClearBasicFilterRequest",
- "description": "Clears the basic filter on a sheet."
- },
- "repeatCell": {
- "$ref": "RepeatCellRequest",
- "description": "Repeats a single cell across a range."
- },
- "appendDimension": {
- "$ref": "AppendDimensionRequest",
- "description": "Appends dimensions to the end of a sheet."
- },
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleRequest",
- "description": "Updates an existing conditional format rule."
- },
- "insertRange": {
- "$ref": "InsertRangeRequest",
- "description": "Inserts new cells in a sheet, shifting the existing cells."
- },
- "moveDimension": {
- "$ref": "MoveDimensionRequest",
- "description": "Moves rows or columns to another location in a sheet."
- },
- "updateBanding": {
- "$ref": "UpdateBandingRequest",
- "description": "Updates a banded range"
- },
- "deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
- },
- "addProtectedRange": {
- "$ref": "AddProtectedRangeRequest",
- "description": "Adds a protected range."
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetRequest",
- "description": "Duplicates a sheet."
- },
- "deleteSheet": {
- "$ref": "DeleteSheetRequest",
- "description": "Deletes a sheet."
- },
- "unmergeCells": {
- "$ref": "UnmergeCellsRequest",
- "description": "Unmerges merged cells."
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
- },
- "updateDimensionProperties": {
- "$ref": "UpdateDimensionPropertiesRequest",
- "description": "Updates dimensions' properties."
- },
- "pasteData": {
- "$ref": "PasteDataRequest",
- "description": "Pastes data (HTML or delimited) into a sheet."
- },
- "setBasicFilter": {
- "$ref": "SetBasicFilterRequest",
- "description": "Sets the basic filter on a sheet."
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeleteBandingRequest": {
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "id": "DeleteBandingRequest",
+ "properties": {
+ "bandedRangeId": {
+ "description": "The ID of the banded range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AppendValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "id": "AppendValuesResponse",
+ "properties": {
+ "updates": {
+ "$ref": "UpdateValuesResponse",
+ "description": "Information about the updates that were applied."
},
- "addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
+ "tableRange": {
+ "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
+ "type": "string"
},
- "updateCells": {
- "$ref": "UpdateCellsRequest",
- "description": "Updates many cells at once."
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
+ "id": "MoveDimensionRequest",
+ "properties": {
+ "destinationIndex": {
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\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`.",
+ "format": "int32",
+ "type": "integer"
},
- "addNamedRange": {
- "$ref": "AddNamedRangeRequest",
- "description": "Adds a named range."
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
+ }
+ },
+ "type": "object"
+ },
+ "PivotFilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "id": "PivotFilterCriteria",
+ "properties": {
+ "visibleValues": {
+ "description": "Values that should be included. Values not listed here are excluded.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AddFilterViewRequest": {
+ "description": "Adds a filter view.",
+ "id": "AddFilterViewRequest",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)"
+ }
+ },
+ "type": "object"
+ },
+ "AddConditionalFormatRuleRequest": {
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
+ "id": "AddConditionalFormatRuleRequest",
+ "properties": {
+ "index": {
+ "description": "The zero-based index where the rule should be inserted.",
+ "format": "int32",
+ "type": "integer"
},
- "updateSpreadsheetProperties": {
- "$ref": "UpdateSpreadsheetPropertiesRequest",
- "description": "Updates the spreadsheet's properties."
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule to add."
+ }
+ },
+ "type": "object"
+ },
+ "ChartSpec": {
+ "description": "The specifications of a chart.",
+ "id": "ChartSpec",
+ "properties": {
+ "histogramChart": {
+ "$ref": "HistogramChartSpec",
+ "description": "A histogram chart specification."
},
- "deleteEmbeddedObject": {
- "$ref": "DeleteEmbeddedObjectRequest",
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
},
- "updateFilterView": {
- "$ref": "UpdateFilterViewRequest",
- "description": "Updates the properties of a filter view."
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
},
- "addBanding": {
- "$ref": "AddBandingRequest",
- "description": "Adds a new banded range"
+ "fontName": {
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
+ "type": "string"
},
- "autoResizeDimensions": {
- "$ref": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
+ "maximized": {
+ "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
+ "type": "boolean"
},
- "appendCells": {
- "$ref": "AppendCellsRequest",
- "description": "Appends cells after the last row with data in a sheet."
+ "hiddenDimensionStrategy": {
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ],
+ "type": "string"
},
- "cutPaste": {
- "$ref": "CutPasteRequest",
- "description": "Cuts data from one area and pastes it to another."
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the entire chart.\nNot applicable to Org charts."
},
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
+ "basicChart": {
+ "$ref": "BasicChartSpec",
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
},
- "updateNamedRange": {
- "$ref": "UpdateNamedRangeRequest",
- "description": "Updates a named range."
+ "orgChart": {
+ "$ref": "OrgChartSpec",
+ "description": "An org chart specification."
},
- "updateSheetProperties": {
- "$ref": "UpdateSheetPropertiesRequest",
- "description": "Updates a sheet's properties."
+ "pieChart": {
+ "$ref": "PieChartSpec",
+ "description": "A pie chart specification."
},
- "autoFill": {
- "$ref": "AutoFillRequest",
- "description": "Automatically fills in more data based on existing data."
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
},
- "deleteDimension": {
- "$ref": "DeleteDimensionRequest",
- "description": "Deletes rows or columns in a sheet."
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
}
},
"type": "object"
},
- "BooleanCondition": {
- "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
- "id": "BooleanCondition",
+ "NumberFormat": {
+ "description": "The number format of a cell.",
+ "id": "NumberFormat",
"properties": {
"type": {
- "description": "The type of condition.",
+ "description": "The type of the number format.\nWhen writing, this field must be set.",
"enum": [
- "CONDITION_TYPE_UNSPECIFIED",
- "NUMBER_GREATER",
- "NUMBER_GREATER_THAN_EQ",
- "NUMBER_LESS",
- "NUMBER_LESS_THAN_EQ",
- "NUMBER_EQ",
- "NUMBER_NOT_EQ",
- "NUMBER_BETWEEN",
- "NUMBER_NOT_BETWEEN",
- "TEXT_CONTAINS",
- "TEXT_NOT_CONTAINS",
- "TEXT_STARTS_WITH",
- "TEXT_ENDS_WITH",
- "TEXT_EQ",
- "TEXT_IS_EMAIL",
- "TEXT_IS_URL",
- "DATE_EQ",
- "DATE_BEFORE",
- "DATE_AFTER",
- "DATE_ON_OR_BEFORE",
- "DATE_ON_OR_AFTER",
- "DATE_BETWEEN",
- "DATE_NOT_BETWEEN",
- "DATE_IS_VALID",
- "ONE_OF_RANGE",
- "ONE_OF_LIST",
- "BLANK",
- "NOT_BLANK",
- "CUSTOM_FORMULA"
+ "NUMBER_FORMAT_TYPE_UNSPECIFIED",
+ "TEXT",
+ "NUMBER",
+ "PERCENT",
+ "CURRENCY",
+ "DATE",
+ "TIME",
+ "DATE_TIME",
+ "SCIENTIFIC"
],
"enumDescriptions": [
- "The default value, do not use.",
- "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
- "The cell's value must in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
- "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue."
+ "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
+ "Text formatting, e.g `1000.12`",
+ "Number formatting, e.g, `1,000.12`",
+ "Percent formatting, e.g `10.12%`",
+ "Currency formatting, e.g `$1,000.12`",
+ "Date formatting, e.g `9/26/2008`",
+ "Time formatting, e.g `3:59:00 PM`",
+ "Date+Time formatting, e.g `9/26/08 15:59:00`",
+ "Scientific number formatting, e.g `1.01E+03`"
],
"type": "string"
},
- "values": {
- "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
- "items": {
- "$ref": "ConditionValue"
- },
- "type": "array"
+ "pattern": {
+ "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "id": "CandlestickDomain",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickDomain."
}
},
"type": "object"
},
- "GridRange": {
- "description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet 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_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\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
- "id": "GridRange",
+ "SheetProperties": {
+ "description": "Properties of a sheet.",
+ "id": "SheetProperties",
"properties": {
- "endRowIndex": {
- "description": "The end row (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
+ "tabColor": {
+ "$ref": "Color",
+ "description": "The color of the tab in the UI."
},
- "endColumnIndex": {
- "description": "The end column (exclusive) of the range, or not set if unbounded.",
+ "index": {
+ "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
"format": "int32",
"type": "integer"
},
- "startRowIndex": {
- "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "sheetId": {
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
"format": "int32",
"type": "integer"
},
- "startColumnIndex": {
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
},
- "sheetId": {
- "description": "The sheet this range is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "BasicChartSpec": {
- "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
- "id": "BasicChartSpec",
- "properties": {
- "chartType": {
- "description": "The type of the chart.",
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO"
- ],
- "enumDescriptions": [
- "Default value, do not use.",
- "A <a href=\"/chart/interactive/docs/gallery/barchart\">bar chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/linechart\">line chart</a>.",
- "An <a href=\"/chart/interactive/docs/gallery/areachart\">area chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/columnchart\">column chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/scatterchart\">scatter chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/combochart\">combo chart</a>."
- ],
- "type": "string"
+ "hidden": {
+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
+ "type": "boolean"
},
- "series": {
- "description": "The data this chart is visualizing.",
- "items": {
- "$ref": "BasicChartSeries"
- },
- "type": "array"
+ "gridProperties": {
+ "$ref": "GridProperties",
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
},
- "legendPosition": {
- "description": "The position of the chart legend.",
+ "sheetType": {
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
"enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
],
"enumDescriptions": [
"Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered."
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
],
"type": "string"
},
- "domains": {
- "description": "The domain of data this is charting.\nOnly a single domain is supported.",
- "items": {
- "$ref": "BasicChartDomain"
- },
- "type": "array"
- },
- "headerCount": {
- "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
- "format": "int32",
- "type": "integer"
- },
- "axis": {
- "description": "The axis on the chart.",
- "items": {
- "$ref": "BasicChartAxis"
- },
- "type": "array"
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
}
},
"type": "object"
},
- "SetDataValidationRequest": {
- "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
- "id": "SetDataValidationRequest",
+ "UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "id": "UpdateDimensionPropertiesRequest",
"properties": {
- "rule": {
- "$ref": "DataValidationRule",
- "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
+ "properties": {
+ "$ref": "DimensionProperties",
+ "description": "Properties to update."
},
"range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
- }
- },
- "type": "object"
- },
- "CellData": {
- "description": "Data about a specific cell.",
- "id": "CellData",
- "properties": {
- "formattedValue": {
- "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
- "type": "string"
- },
- "textFormatRuns": {
- "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 next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell 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 erased.",
- "items": {
- "$ref": "TextFormatRun"
- },
- "type": "array"
- },
- "hyperlink": {
- "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
- "type": "string"
- },
- "pivotTable": {
- "$ref": "PivotTable",
- "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
- },
- "userEnteredFormat": {
- "$ref": "CellFormat",
- "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
+ "$ref": "DimensionRange",
+ "description": "The rows or columns to update."
},
- "note": {
- "description": "Any note on the cell.",
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
"type": "string"
- },
- "effectiveFormat": {
- "$ref": "CellFormat",
- "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only."
- },
- "dataValidation": {
- "$ref": "DataValidationRule",
- "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
- },
- "userEnteredValue": {
- "$ref": "ExtendedValue",
- "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
- },
- "effectiveValue": {
- "$ref": "ExtendedValue",
- "description": "The effective value of the cell. For cells with 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."
}
},
"type": "object"
},
- "BatchUpdateSpreadsheetRequest": {
- "description": "The request for updating any aspect of a spreadsheet.",
- "id": "BatchUpdateSpreadsheetRequest",
+ "SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "id": "SourceAndDestination",
"properties": {
- "includeSpreadsheetInResponse": {
- "description": "Determines if the update response should include the spreadsheet\nresource.",
- "type": "boolean"
- },
- "responseRanges": {
- "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "dimension": {
+ "description": "The dimension that data should be filled into.",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "type": "string"
},
- "responseIncludeGridData": {
- "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
+ "fillLength": {
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "format": "int32",
+ "type": "integer"
},
- "requests": {
- "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
- "items": {
- "$ref": "Request"
- },
- "type": "array"
+ "source": {
+ "$ref": "GridRange",
+ "description": "The location of the data to use as the source of the autofill."
}
},
"type": "object"
},
- "Padding": {
- "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
- "id": "Padding",
+ "FilterView": {
+ "description": "A filter view.",
+ "id": "FilterView",
"properties": {
- "right": {
- "description": "The right padding of the cell.",
+ "filterViewId": {
+ "description": "The ID of the filter view.",
"format": "int32",
"type": "integer"
},
- "bottom": {
- "description": "The bottom padding of the cell.",
- "format": "int32",
- "type": "integer"
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
+ },
+ "title": {
+ "description": "The name of the filter view.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
},
- "top": {
- "description": "The top padding of the cell.",
- "format": "int32",
- "type": "integer"
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
},
- "left": {
- "description": "The left padding of the cell.",
- "format": "int32",
- "type": "integer"
+ "namedRangeId": {
+ "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
}
},
"type": "object"
},
- "BasicChartAxis": {
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
- "id": "BasicChartAxis",
+ "OrgChartSpec": {
+ "description": "An <a href=\"/chart/interactive/docs/gallery/orgchart\">org chart</a>.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
+ "id": "OrgChartSpec",
"properties": {
- "position": {
- "description": "The position of this axis.",
+ "tooltips": {
+ "$ref": "ChartData",
+ "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
+ },
+ "selectedNodeColor": {
+ "$ref": "Color",
+ "description": "The color of the selected org chart nodes."
+ },
+ "parentLabels": {
+ "$ref": "ChartData",
+ "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
+ },
+ "nodeSize": {
+ "description": "The size of the org chart nodes.",
"enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
],
"enumDescriptions": [
"Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ "The small org chart node size.",
+ "The medium org chart node size.",
+ "The large org chart node size."
],
"type": "string"
},
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
+ "labels": {
+ "$ref": "ChartData",
+ "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
},
- "format": {
- "$ref": "TextFormat",
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
+ "nodeColor": {
+ "$ref": "Color",
+ "description": "The color of the org chart nodes."
}
},
"type": "object"
},
- "DeleteDimensionRequest": {
- "description": "Deletes the dimensions from the sheet.",
- "id": "DeleteDimensionRequest",
+ "BandingProperties": {
+ "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
+ "id": "BandingProperties",
"properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The dimensions to delete from the sheet."
+ "secondBandColor": {
+ "$ref": "Color",
+ "description": "The second color that is alternating. (Required)"
+ },
+ "footerColor": {
+ "$ref": "Color",
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
+ },
+ "headerColor": {
+ "$ref": "Color",
+ "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
+ },
+ "firstBandColor": {
+ "$ref": "Color",
+ "description": "The first color that is alternating. (Required)"
}
},
"type": "object"
},
- "UpdateChartSpecRequest": {
- "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
- "id": "UpdateChartSpecRequest",
+ "AddProtectedRangeResponse": {
+ "description": "The result of adding a new protected range.",
+ "id": "AddProtectedRangeResponse",
"properties": {
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification to apply to the chart."
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The newly added protected range."
+ }
+ },
+ "type": "object"
+ },
+ "BasicFilter": {
+ "description": "The default filter associated with a sheet.",
+ "id": "BasicFilter",
+ "properties": {
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
},
- "chartId": {
- "description": "The ID of the chart to update.",
- "format": "int32",
- "type": "integer"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the filter covers."
+ },
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
}
},
"type": "object"
},
- "DeleteFilterViewRequest": {
- "description": "Deletes a particular filter view.",
- "id": "DeleteFilterViewRequest",
+ "CandlestickSeries": {
+ "description": "The series of a CandlestickData.",
+ "id": "CandlestickSeries",
"properties": {
- "filterId": {
- "description": "The ID of the filter to delete.",
- "format": "int32",
- "type": "integer"
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickSeries."
}
},
"type": "object"
},
- "BatchUpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "id": "BatchUpdateValuesResponse",
+ "HistogramChartSpec": {
+ "description": "A <a href=\"/chart/interactive/docs/gallery/histogram\">histogram chart</a>.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.",
+ "id": "HistogramChartSpec",
"properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
+ "legendPosition": {
+ "description": "The position of the chart legend.",
+ "enum": [
+ "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
+ ],
+ "type": "string"
},
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
+ "bucketSize": {
+ "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
+ "format": "double",
+ "type": "number"
},
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
+ "outlierPercentile": {
+ "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
+ "format": "double",
+ "type": "number"
+ },
+ "showItemDividers": {
+ "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
+ "type": "boolean"
},
+ "series": {
+ "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
+ "items": {
+ "$ref": "HistogramSeries"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "id": "UpdateValuesResponse",
+ "properties": {
"spreadsheetId": {
"description": "The spreadsheet the updates were applied to.",
"type": "string"
},
- "totalUpdatedRows": {
- "description": "The total number of rows where at least one cell in the row was updated.",
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "description": "The number of cells updated.",
"format": "int32",
"type": "integer"
},
- "responses": {
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
- "items": {
- "$ref": "UpdateValuesResponse"
- },
- "type": "array"
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
+ },
+ "updatedRows": {
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedColumns": {
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "SortRangeRequest": {
- "description": "Sorts data in rows based on a sort order per column.",
- "id": "SortRangeRequest",
+ "PivotValue": {
+ "description": "The definition of how a value in a pivot table should be calculated.",
+ "id": "PivotValue",
"properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to sort."
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
+ "format": "int32",
+ "type": "integer"
},
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
+ "name": {
+ "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
+ "type": "string"
+ },
+ "formula": {
+ "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
+ "type": "string"
+ },
+ "summarizeFunction": {
+ "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
+ "enum": [
+ "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
+ "SUM",
+ "COUNTA",
+ "COUNT",
+ "COUNTUNIQUE",
+ "AVERAGE",
+ "MAX",
+ "MIN",
+ "MEDIAN",
+ "PRODUCT",
+ "STDEV",
+ "STDEVP",
+ "VAR",
+ "VARP",
+ "CUSTOM"
+ ],
+ "enumDescriptions": [
+ "The default, do not use.",
+ "Corresponds to the `SUM` function.",
+ "Corresponds to the `COUNTA` function.",
+ "Corresponds to the `COUNT` function.",
+ "Corresponds to the `COUNTUNIQUE` function.",
+ "Corresponds to the `AVERAGE` function.",
+ "Corresponds to the `MAX` function.",
+ "Corresponds to the `MIN` function.",
+ "Corresponds to the `MEDIAN` function.",
+ "Corresponds to the `PRODUCT` function.",
+ "Corresponds to the `STDEV` function.",
+ "Corresponds to the `STDEVP` function.",
+ "Corresponds to the `VAR` function.",
+ "Corresponds to the `VARP` function.",
+ "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "MergeCellsRequest": {
- "description": "Merges all cells in the range.",
- "id": "MergeCellsRequest",
+ "ErrorValue": {
+ "description": "An error in a cell.",
+ "id": "ErrorValue",
"properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range of cells to merge."
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
},
- "mergeType": {
- "description": "How the cells should be merged.",
+ "type": {
+ "description": "The type of error.",
"enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
+ "ERROR_TYPE_UNSPECIFIED",
+ "ERROR",
+ "NULL_VALUE",
+ "DIVIDE_BY_ZERO",
+ "VALUE",
+ "REF",
+ "NAME",
+ "NUM",
+ "N_A",
+ "LOADING"
],
"enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
+ "The default error type, do not use this.",
+ "Corresponds to the `#ERROR!` error.",
+ "Corresponds to the `#NULL!` error.",
+ "Corresponds to the `#DIV/0` error.",
+ "Corresponds to the `#VALUE!` error.",
+ "Corresponds to the `#REF!` error.",
+ "Corresponds to the `#NAME?` error.",
+ "Corresponds to the `#NUM`! error.",
+ "Corresponds to the `#N/A` error.",
+ "Corresponds to the `Loading...` state."
],
"type": "string"
}
},
"type": "object"
},
- "AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "id": "AddProtectedRangeRequest",
+ "CopySheetToAnotherSpreadsheetRequest": {
+ "description": "The request to copy a sheet across spreadsheets.",
+ "id": "CopySheetToAnotherSpreadsheetRequest",
"properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
+ "destinationSpreadsheetId": {
+ "description": "The ID of the spreadsheet to copy the sheet to.",
+ "type": "string"
}
},
"type": "object"
},
- "BatchClearValuesRequest": {
- "description": "The request for clearing more than one range of values in a spreadsheet.",
- "id": "BatchClearValuesRequest",
+ "PivotGroupSortValueBucket": {
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "id": "PivotGroupSortValueBucket",
"properties": {
- "ranges": {
- "description": "The ranges to clear, in A1 notation.",
+ "buckets": {
+ "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\nto 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 indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
"items": {
- "type": "string"
+ "$ref": "ExtendedValue"
},
"type": "array"
+ },
+ "valuesIndex": {
+ "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "DuplicateFilterViewResponse": {
- "description": "The result of a filter view being duplicated.",
- "id": "DuplicateFilterViewResponse",
+ "CandlestickChartSpec": {
+ "description": "A <a href=\"/chart/interactive/docs/gallery/candlestickchart\">candlestick chart</a>.",
+ "id": "CandlestickChartSpec",
"properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly created filter."
+ "domain": {
+ "$ref": "CandlestickDomain",
+ "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as continous\nvalues."
+ },
+ "data": {
+ "description": "The Candlestick chart data.\nOnly one CandlestickData is supported.",
+ "items": {
+ "$ref": "CandlestickData"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "id": "DuplicateSheetResponse",
+ "CandlestickData": {
+ "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
+ "id": "CandlestickData",
"properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the duplicate sheet."
+ "openSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow."
+ },
+ "highSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line."
+ },
+ "lowSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line."
+ },
+ "closeSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow."
}
},
"type": "object"
},
- "ClearBasicFilterRequest": {
- "description": "Clears the basic filter, if any exists on the sheet.",
- "id": "ClearBasicFilterRequest",
+ "EmbeddedObjectPosition": {
+ "description": "The position of an embedded object such as a chart.",
+ "id": "EmbeddedObjectPosition",
"properties": {
+ "newSheet": {
+ "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
+ "type": "boolean"
+ },
"sheetId": {
- "description": "The sheet ID on which the basic filter should be cleared.",
+ "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
"format": "int32",
"type": "integer"
- }
- },
- "type": "object"
- },
- "TextToColumnsRequest": {
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "id": "TextToColumnsRequest",
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The source data range. This must span exactly one column."
- },
- "delimiterType": {
- "description": "The delimiter type to use.",
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM"
- ],
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ],
- "type": "string"
},
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
- "type": "string"
+ "overlayPosition": {
+ "$ref": "OverlayPosition",
+ "description": "The position at which the object is overlaid on top of a grid."
}
},
"type": "object"
},
- "DeleteBandingRequest": {
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "id": "DeleteBandingRequest",
+ "DeleteProtectedRangeRequest": {
+ "description": "Deletes the protected range with the given ID.",
+ "id": "DeleteProtectedRangeRequest",
"properties": {
- "bandedRangeId": {
- "description": "The ID of the banded range to delete.",
+ "protectedRangeId": {
+ "description": "The ID of the protected range to delete.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "BatchUpdateSpreadsheetResponse": {
- "description": "The reply for batch updating a spreadsheet.",
- "id": "BatchUpdateSpreadsheetResponse",
+ "AutoFillRequest": {
+ "description": "Fills in more data based on existing data.",
+ "id": "AutoFillRequest",
"properties": {
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "items": {
- "$ref": "Response"
- },
- "type": "array"
+ "sourceAndDestination": {
+ "$ref": "SourceAndDestination",
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
},
- "updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range."
},
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
+ "useAlternateSeries": {
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
+ "type": "boolean"
}
},
"type": "object"
},
- "AppendValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "id": "AppendValuesResponse",
+ "GradientRule": {
+ "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
+ "id": "GradientRule",
"properties": {
- "tableRange": {
- "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
- "type": "string"
+ "minpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The starting interpolation point."
},
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
+ "maxpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
},
- "updates": {
- "$ref": "UpdateValuesResponse",
- "description": "Information about the updates that were applied."
+ "midpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "An optional midway interpolation point."
}
},
"type": "object"
},
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
- "id": "AddFilterViewRequest",
+ "SetBasicFilterRequest": {
+ "description": "Sets the basic filter associated with a sheet.",
+ "id": "SetBasicFilterRequest",
"properties": {
"filter": {
- "$ref": "FilterView",
- "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)"
+ "$ref": "BasicFilter",
+ "description": "The filter to set."
}
},
"type": "object"
},
- "PivotFilterCriteria": {
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "id": "PivotFilterCriteria",
+ "ClearValuesRequest": {
+ "description": "The request for clearing a range of values in a spreadsheet.",
+ "id": "ClearValuesRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "InterpolationPoint": {
+ "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
+ "id": "InterpolationPoint",
"properties": {
- "visibleValues": {
- "description": "Values that should be included. Values not listed here are excluded.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color this interpolation point should use."
+ },
+ "type": {
+ "description": "How the value should be interpreted.",
+ "enum": [
+ "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
+ "MIN",
+ "MAX",
+ "NUMBER",
+ "PERCENT",
+ "PERCENTILE"
+ ],
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
+ "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
+ "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "id": "MoveDimensionRequest",
+ "DeleteEmbeddedObjectRequest": {
+ "description": "Deletes the embedded object with the given ID.",
+ "id": "DeleteEmbeddedObjectRequest",
"properties": {
- "destinationIndex": {
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\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`.",
+ "objectId": {
+ "description": "The ID of the embedded object to delete.",
"format": "int32",
"type": "integer"
- },
- "source": {
- "$ref": "DimensionRange",
- "description": "The source dimensions to move."
}
},
"type": "object"
},
- "AddConditionalFormatRuleRequest": {
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "id": "AddConditionalFormatRuleRequest",
+ "FindReplaceResponse": {
+ "description": "The result of the find/replace.",
+ "id": "FindReplaceResponse",
"properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule to add."
+ "valuesChanged": {
+ "description": "The number of non-formula cells changed.",
+ "format": "int32",
+ "type": "integer"
},
- "index": {
- "description": "The zero-based index where the rule should be inserted.",
+ "occurrencesChanged": {
+ "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowsChanged": {
+ "description": "The number of rows changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetsChanged": {
+ "description": "The number of sheets changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "ChartSpec": {
- "description": "The specifications of a chart.",
- "id": "ChartSpec",
+ "DeleteSheetRequest": {
+ "description": "Deletes the requested sheet.",
+ "id": "DeleteSheetRequest",
"properties": {
- "hiddenDimensionStrategy": {
- "description": "Determines how the charts will use hidden rows or columns.",
- "enum": [
- "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
- "SKIP_HIDDEN_ROWS_AND_COLUMNS",
- "SKIP_HIDDEN_ROWS",
- "SKIP_HIDDEN_COLUMNS",
- "SHOW_ALL"
- ],
- "enumDescriptions": [
- "Default value, do not use.",
- "Charts will skip hidden rows and columns.",
- "Charts will skip hidden rows only.",
- "Charts will skip hidden columns only.",
- "Charts will not skip any hidden rows or columns."
- ],
- "type": "string"
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
- },
- "basicChart": {
- "$ref": "BasicChartSpec",
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
+ "sheetId": {
+ "description": "The ID of the sheet to delete.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "NumberFormat": {
- "description": "The number format of a cell.",
- "id": "NumberFormat",
+ "DuplicateFilterViewRequest": {
+ "description": "Duplicates a particular filter view.",
+ "id": "DuplicateFilterViewRequest",
"properties": {
- "type": {
- "description": "The type of the number format.\nWhen writing, this field must be set.",
- "enum": [
- "NUMBER_FORMAT_TYPE_UNSPECIFIED",
- "TEXT",
- "NUMBER",
- "PERCENT",
- "CURRENCY",
- "DATE",
- "TIME",
- "DATE_TIME",
- "SCIENTIFIC"
- ],
- "enumDescriptions": [
- "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
- "Text formatting, e.g `1000.12`",
- "Number formatting, e.g, `1,000.12`",
- "Percent formatting, e.g `10.12%`",
- "Currency formatting, e.g `$1,000.12`",
- "Date formatting, e.g `9/26/2008`",
- "Time formatting, e.g `3:59:00 PM`",
- "Date+Time formatting, e.g `9/26/08 15:59:00`",
- "Scientific number formatting, e.g `1.01E+03`"
- ],
- "type": "string"
- },
- "pattern": {
- "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
- "type": "string"
+ "filterId": {
+ "description": "The ID of the filter being duplicated.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "SheetProperties": {
- "description": "Properties of a sheet.",
- "id": "SheetProperties",
+ "UpdateConditionalFormatRuleResponse": {
+ "description": "The result of updating a conditional format rule.",
+ "id": "UpdateConditionalFormatRuleResponse",
"properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "tabColor": {
- "$ref": "Color",
- "description": "The color of the tab in the UI."
- },
- "index": {
- "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
+ "newIndex": {
+ "description": "The index of the new rule.",
"format": "int32",
"type": "integer"
},
- "sheetId": {
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
+ "oldIndex": {
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
"format": "int32",
"type": "integer"
},
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "gridProperties": {
- "$ref": "GridProperties",
- "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
+ "newRule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
},
- "sheetType": {
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "oldRule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
+ }
+ },
+ "type": "object"
+ },
+ "ConditionValue": {
+ "description": "The value of the condition.",
+ "id": "ConditionValue",
+ "properties": {
+ "relativeDate": {
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
"enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "TOMORROW"
],
"enumDescriptions": [
"Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
+ "The value is one year before today.",
+ "The value is one month before today.",
+ "The value is one week before today.",
+ "The value is yesterday.",
+ "The value is today.",
+ "The value is tomorrow."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "id": "UpdateDimensionPropertiesRequest",
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The rows or columns to update."
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
+ "userEnteredValue": {
+ "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
"type": "string"
- },
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
}
},
"type": "object"
},
- "SourceAndDestination": {
- "description": "A combination of a source range and how to extend that source.",
- "id": "SourceAndDestination",
+ "DuplicateSheetRequest": {
+ "description": "Duplicates the contents of a sheet.",
+ "id": "DuplicateSheetRequest",
"properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The location of the data to use as the source of the autofill."
- },
- "dimension": {
- "description": "The dimension that data should be filled into.",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
"type": "string"
},
- "fillLength": {
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newSheetId": {
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "insertSheetIndex": {
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "FilterView": {
- "description": "A filter view.",
- "id": "FilterView",
+ "ExtendedValue": {
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "id": "ExtendedValue",
"properties": {
- "criteria": {
- "additionalProperties": {
- "$ref": "FilterCriteria"
- },
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object"
+ "errorValue": {
+ "$ref": "ErrorValue",
+ "description": "Represents an error.\nThis field is read-only."
},
- "title": {
- "description": "The name of the filter view.",
+ "stringValue": {
+ "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
"type": "string"
},
- "range": {
- "$ref": "GridRange",
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
+ "boolValue": {
+ "description": "Represents a boolean value.",
+ "type": "boolean"
},
- "namedRangeId": {
- "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "formulaValue": {
+ "description": "Represents a formula.",
"type": "string"
},
- "filterViewId": {
- "description": "The ID of the filter view.",
- "format": "int32",
- "type": "integer"
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
- "id": "BandingProperties",
+ "BandedRange": {
+ "description": "A banded (alternating colors) range in a sheet.",
+ "id": "BandedRange",
"properties": {
- "footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
+ "bandedRangeId": {
+ "description": "The id of the banded range.",
+ "format": "int32",
+ "type": "integer"
},
- "headerColor": {
- "$ref": "Color",
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
+ "rowProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
},
- "firstBandColor": {
- "$ref": "Color",
- "description": "The first color that is alternating. (Required)"
+ "columnProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
},
- "secondBandColor": {
- "$ref": "Color",
- "description": "The second color that is alternating. (Required)"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range over which these properties are applied."
}
},
"type": "object"
},
- "AddProtectedRangeResponse": {
- "description": "The result of adding a new protected range.",
- "id": "AddProtectedRangeResponse",
+ "HistogramSeries": {
+ "description": "A histogram series containing the series color and data.",
+ "id": "HistogramSeries",
"properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The newly added protected range."
+ "barColor": {
+ "$ref": "Color",
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional."
+ },
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data for this histogram series."
}
},
"type": "object"
},
- "BasicFilter": {
- "description": "The default filter associated with a sheet.",
- "id": "BasicFilter",
+ "BatchClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "id": "BatchClearValuesResponse",
"properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range the filter covers."
- },
- "criteria": {
- "additionalProperties": {
- "$ref": "FilterCriteria"
- },
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object"
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
"items": {
- "$ref": "SortSpec"
+ "type": "string"
},
"type": "array"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
}
},
"type": "object"
},
- "UpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "id": "UpdateValuesResponse",
+ "Spreadsheet": {
+ "description": "Resource that represents a spreadsheet.",
+ "id": "Spreadsheet",
"properties": {
- "updatedData": {
- "$ref": "ValueRange",
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
- },
- "updatedRows": {
- "description": "The number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "updatedColumns": {
- "description": "The number of columns where at least one cell in the column was updated.",
- "format": "int32",
- "type": "integer"
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "Overall properties of a spreadsheet."
},
"spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
+ "description": "The ID of the spreadsheet.\nThis field is read-only.",
"type": "string"
},
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
+ "sheets": {
+ "description": "The sheets that are part of a spreadsheet.",
+ "items": {
+ "$ref": "Sheet"
+ },
+ "type": "array"
},
- "updatedCells": {
- "description": "The number of cells updated.",
- "format": "int32",
- "type": "integer"
+ "namedRanges": {
+ "description": "The named ranges defined in a spreadsheet.",
+ "items": {
+ "$ref": "NamedRange"
+ },
+ "type": "array"
+ },
+ "spreadsheetUrl": {
+ "description": "The url of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
}
},
"type": "object"
},
- "PivotValue": {
- "description": "The definition of how a value in a pivot table should be calculated.",
- "id": "PivotValue",
+ "AddChartRequest": {
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "id": "AddChartRequest",
"properties": {
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
- "format": "int32",
- "type": "integer"
+ "chart": {
+ "$ref": "EmbeddedChart",
+ "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateProtectedRangeRequest": {
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "id": "UpdateProtectedRangeRequest",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
},
- "name": {
- "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TextFormat": {
+ "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
+ "id": "TextFormat",
+ "properties": {
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
},
- "formula": {
- "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
- "type": "string"
+ "foregroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
},
- "summarizeFunction": {
- "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
- "enum": [
- "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
- "SUM",
- "COUNTA",
- "COUNT",
- "COUNTUNIQUE",
- "AVERAGE",
- "MAX",
- "MIN",
- "MEDIAN",
- "PRODUCT",
- "STDEV",
- "STDEVP",
- "VAR",
- "VARP",
- "CUSTOM"
- ],
- "enumDescriptions": [
- "The default, do not use.",
- "Corresponds to the `SUM` function.",
- "Corresponds to the `COUNTA` function.",
- "Corresponds to the `COUNT` function.",
- "Corresponds to the `COUNTUNIQUE` function.",
- "Corresponds to the `AVERAGE` function.",
- "Corresponds to the `MAX` function.",
- "Corresponds to the `MIN` function.",
- "Corresponds to the `MEDIAN` function.",
- "Corresponds to the `PRODUCT` function.",
- "Corresponds to the `STDEV` function.",
- "Corresponds to the `STDEVP` function.",
- "Corresponds to the `VAR` function.",
- "Corresponds to the `VARP` function.",
- "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
- ],
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "description": "The font family.",
"type": "string"
+ },
+ "strikethrough": {
+ "description": "True if the text has a strikethrough.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "True if the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the font.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "ErrorValue": {
- "description": "An error in a cell.",
- "id": "ErrorValue",
+ "AddSheetResponse": {
+ "description": "The result of adding a sheet.",
+ "id": "AddSheetResponse",
"properties": {
- "type": {
- "description": "The type of error.",
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ERROR",
- "NULL_VALUE",
- "DIVIDE_BY_ZERO",
- "VALUE",
- "REF",
- "NAME",
- "NUM",
- "N_A",
- "LOADING"
- ],
- "enumDescriptions": [
- "The default error type, do not use this.",
- "Corresponds to the `#ERROR!` error.",
- "Corresponds to the `#NULL!` error.",
- "Corresponds to the `#DIV/0` error.",
- "Corresponds to the `#VALUE!` error.",
- "Corresponds to the `#REF!` error.",
- "Corresponds to the `#NAME?` error.",
- "Corresponds to the `#NUM`! error.",
- "Corresponds to the `#N/A` error.",
- "Corresponds to the `Loading...` state."
- ],
- "type": "string"
- },
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the newly added sheet."
}
},
"type": "object"
},
- "CopySheetToAnotherSpreadsheetRequest": {
- "description": "The request to copy a sheet across spreadsheets.",
- "id": "CopySheetToAnotherSpreadsheetRequest",
+ "AddFilterViewResponse": {
+ "description": "The result of adding a filter view.",
+ "id": "AddFilterViewResponse",
"properties": {
- "destinationSpreadsheetId": {
- "description": "The ID of the spreadsheet to copy the sheet to.",
- "type": "string"
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly added filter view."
}
},
"type": "object"
},
- "PivotGroupSortValueBucket": {
- "description": "Information about which values in a pivot group should be used for sorting.",
- "id": "PivotGroupSortValueBucket",
+ "IterativeCalculationSettings": {
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "id": "IterativeCalculationSettings",
"properties": {
- "buckets": {
- "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\nto 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 indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
- "items": {
- "$ref": "ExtendedValue"
- },
- "type": "array"
+ "convergenceThreshold": {
+ "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
+ "format": "double",
+ "type": "number"
},
- "valuesIndex": {
- "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "maxIterations": {
+ "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "EmbeddedObjectPosition": {
- "description": "The position of an embedded object such as a chart.",
- "id": "EmbeddedObjectPosition",
+ "OverlayPosition": {
+ "description": "The location an object is overlaid on top of a grid.",
+ "id": "OverlayPosition",
"properties": {
- "newSheet": {
- "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
- "type": "boolean"
+ "offsetXPixels": {
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
},
- "sheetId": {
- "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
+ "anchorCell": {
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
+ },
+ "offsetYPixels": {
+ "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
"format": "int32",
"type": "integer"
},
- "overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
+ "heightPixels": {
+ "description": "The height of the object, in pixels. Defaults to 371.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "widthPixels": {
+ "description": "The width of the object, in pixels. Defaults to 600.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "DeleteProtectedRangeRequest": {
- "description": "Deletes the protected range with the given ID.",
- "id": "DeleteProtectedRangeRequest",
+ "SpreadsheetProperties": {
+ "description": "Properties of a spreadsheet.",
+ "id": "SpreadsheetProperties",
"properties": {
- "protectedRangeId": {
- "description": "The ID of the protected range to delete.",
- "format": "int32",
- "type": "integer"
+ "iterativeCalculationSettings": {
+ "$ref": "IterativeCalculationSettings",
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ },
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
+ },
+ "autoRecalc": {
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "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.",
+ "type": "string"
}
},
"type": "object"
},
- "AutoFillRequest": {
- "description": "Fills in more data based on existing data.",
- "id": "AutoFillRequest",
+ "RepeatCellRequest": {
+ "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; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will 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 `=A2`, 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, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
+ "id": "RepeatCellRequest",
"properties": {
"range": {
"$ref": "GridRange",
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range."
+ "description": "The range to repeat the cell in."
},
- "useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
},
- "sourceAndDestination": {
- "$ref": "SourceAndDestination",
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
+ "cell": {
+ "$ref": "CellData",
+ "description": "The data to write."
}
},
"type": "object"
},
- "GradientRule": {
- "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
- "id": "GradientRule",
+ "AddChartResponse": {
+ "description": "The result of adding a chart to a spreadsheet.",
+ "id": "AddChartResponse",
"properties": {
- "minpoint": {
- "$ref": "InterpolationPoint",
- "description": "The starting interpolation point."
- },
- "maxpoint": {
- "$ref": "InterpolationPoint",
- "description": "The final interpolation point."
+ "chart": {
+ "$ref": "EmbeddedChart",
+ "description": "The newly added chart."
+ }
+ },
+ "type": "object"
+ },
+ "InsertDimensionRequest": {
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "id": "InsertDimensionRequest",
+ "properties": {
+ "inheritFromBefore": {
+ "description": "Whether dimension properties should be extended 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 greater 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 inserting 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 before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
+ "type": "boolean"
},
- "midpoint": {
- "$ref": "InterpolationPoint",
- "description": "An optional midway interpolation point."
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded."
}
},
"type": "object"
},
- "ClearValuesRequest": {
- "description": "The request for clearing a range of values in a spreadsheet.",
- "id": "ClearValuesRequest",
- "properties": {},
+ "UpdateSpreadsheetPropertiesRequest": {
+ "description": "Updates properties of a spreadsheet.",
+ "id": "UpdateSpreadsheetPropertiesRequest",
+ "properties": {
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "The properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
"type": "object"
},
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "id": "SetBasicFilterRequest",
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "id": "ProtectedRange",
"properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
+ "warningOnly": {
+ "description": "True if 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 user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is 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 will be set to all the editors in the document.",
+ "type": "boolean"
+ },
+ "requestingUserCanEdit": {
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "editors": {
+ "$ref": "Editors",
+ "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range that is being protected.\nThe range 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."
+ },
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "items": {
+ "$ref": "GridRange"
+ },
+ "type": "array"
+ },
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "InterpolationPoint": {
- "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
- "id": "InterpolationPoint",
+ "BatchUpdateValuesRequest": {
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "id": "BatchUpdateValuesRequest",
"properties": {
- "color": {
- "$ref": "Color",
- "description": "The color this interpolation point should use."
+ "responseValueRenderOption": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "type": "string"
},
- "type": {
- "description": "How the value should be interpreted.",
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
"enum": [
- "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
- "MIN",
- "MAX",
- "NUMBER",
- "PERCENT",
- "PERCENTILE"
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
],
"enumDescriptions": [
- "The default value, do not use.",
- "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
- "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
- "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into 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 into a cell via the Google Sheets UI."
],
"type": "string"
},
- "value": {
- "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "data": {
+ "description": "The new values to apply to the spreadsheet.",
+ "items": {
+ "$ref": "ValueRange"
+ },
+ "type": "array"
+ },
+ "responseDateTimeRenderOption": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+ ],
"type": "string"
}
},
"type": "object"
},
- "DeleteEmbeddedObjectRequest": {
- "description": "Deletes the embedded object with the given ID.",
- "id": "DeleteEmbeddedObjectRequest",
+ "DimensionProperties": {
+ "description": "Properties about a dimension.",
+ "id": "DimensionProperties",
"properties": {
- "objectId": {
- "description": "The ID of the embedded object to delete.",
+ "pixelSize": {
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
"format": "int32",
"type": "integer"
+ },
+ "hiddenByFilter": {
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
}
},
"type": "object"
},
- "FindReplaceResponse": {
- "description": "The result of the find/replace.",
- "id": "FindReplaceResponse",
+ "DimensionRange": {
+ "description": "A range along a single dimension on a sheet.\nAll indexes 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.",
+ "id": "DimensionRange",
"properties": {
- "occurrencesChanged": {
- "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.",
- "format": "int32",
- "type": "integer"
- },
- "rowsChanged": {
- "description": "The number of rows changed.",
- "format": "int32",
- "type": "integer"
+ "dimension": {
+ "description": "The dimension of the span.",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "type": "string"
},
- "sheetsChanged": {
- "description": "The number of sheets changed.",
+ "startIndex": {
+ "description": "The start (inclusive) of the span, or not set if unbounded.",
"format": "int32",
"type": "integer"
},
- "formulasChanged": {
- "description": "The number of formula cells changed.",
+ "endIndex": {
+ "description": "The end (exclusive) of the span, or not set if unbounded.",
"format": "int32",
"type": "integer"
},
- "valuesChanged": {
- "description": "The number of non-formula cells changed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DuplicateFilterViewRequest": {
- "description": "Duplicates a particular filter view.",
- "id": "DuplicateFilterViewRequest",
- "properties": {
- "filterId": {
- "description": "The ID of the filter being duplicated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
- "id": "DeleteSheetRequest",
- "properties": {
"sheetId": {
- "description": "The ID of the sheet to delete.",
+ "description": "The sheet this span is on.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "UpdateConditionalFormatRuleResponse": {
- "description": "The result of updating a conditional format rule.",
- "id": "UpdateConditionalFormatRuleResponse",
+ "NamedRange": {
+ "description": "A named range.",
+ "id": "NamedRange",
"properties": {
- "oldRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
- },
- "newIndex": {
- "description": "The index of the new rule.",
- "format": "int32",
- "type": "integer"
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
},
- "oldIndex": {
- "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
- "format": "int32",
- "type": "integer"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this represents."
},
- "newRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
}
},
"type": "object"
},
- "DuplicateSheetRequest": {
- "description": "Duplicates the contents of a sheet.",
- "id": "DuplicateSheetRequest",
+ "CutPasteRequest": {
+ "description": "Moves data from the source to the destination.",
+ "id": "CutPasteRequest",
"properties": {
- "newSheetName": {
- "description": "The name of the new sheet. If empty, a new name is chosen for you.",
- "type": "string"
- },
- "sourceSheetId": {
- "description": "The sheet to duplicate.",
- "format": "int32",
- "type": "integer"
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data to cut."
},
- "newSheetId": {
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
- "format": "int32",
- "type": "integer"
+ "pasteType": {
+ "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "type": "string"
},
- "insertSheetIndex": {
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "format": "int32",
- "type": "integer"
+ "destination": {
+ "$ref": "GridCoordinate",
+ "description": "The top-left coordinate where the data should be pasted."
}
},
"type": "object"
},
- "ConditionValue": {
- "description": "The value of the condition.",
- "id": "ConditionValue",
+ "BasicChartSeries": {
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "id": "BasicChartSeries",
"properties": {
- "relativeDate": {
- "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
- "enum": [
- "RELATIVE_DATE_UNSPECIFIED",
- "PAST_YEAR",
- "PAST_MONTH",
- "PAST_WEEK",
- "YESTERDAY",
- "TODAY",
- "TOMORROW"
+ "targetAxis": {
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
],
"enumDescriptions": [
"Default value, do not use.",
- "The value is one year before today.",
- "The value is one month before today.",
- "The value is one week before today.",
- "The value is yesterday.",
- "The value is today.",
- "The value is tomorrow."
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
],
"type": "string"
},
- "userEnteredValue": {
- "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data being visualized in this chart series."
+ },
+ "type": {
+ "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A <a href=\"/chart/interactive/docs/gallery/barchart\">bar chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/linechart\">line chart</a>.",
+ "An <a href=\"/chart/interactive/docs/gallery/areachart\">area chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/columnchart\">column chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/scatterchart\">scatter chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/combochart\">combo chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/steppedareachart\">stepped area chart</a>."
+ ],
"type": "string"
}
},
"type": "object"
},
- "ExtendedValue": {
- "description": "The kinds of value that a cell in a spreadsheet can have.",
- "id": "ExtendedValue",
+ "Borders": {
+ "description": "The borders of the cell.",
+ "id": "Borders",
"properties": {
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- },
- "errorValue": {
- "$ref": "ErrorValue",
- "description": "Represents an error.\nThis field is read-only."
+ "right": {
+ "$ref": "Border",
+ "description": "The right border of the cell."
},
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
+ "bottom": {
+ "$ref": "Border",
+ "description": "The bottom border of the cell."
},
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
+ "top": {
+ "$ref": "Border",
+ "description": "The top border of the cell."
},
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
+ "left": {
+ "$ref": "Border",
+ "description": "The left border of the cell."
}
},
"type": "object"
},
- "BandedRange": {
- "description": "A banded (alternating colors) range in a sheet.",
- "id": "BandedRange",
+ "AutoResizeDimensionsRequest": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "id": "AutoResizeDimensionsRequest",
"properties": {
- "bandedRangeId": {
- "description": "The id of the banded range.",
- "format": "int32",
- "type": "integer"
- },
- "rowProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
- },
- "columnProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range over which these properties are applied."
+ "dimensions": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported."
}
},
"type": "object"
},
- "BatchClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "id": "BatchClearValuesResponse",
+ "UpdateBordersRequest": {
+ "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
+ "id": "UpdateBordersRequest",
"properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
+ "right": {
+ "$ref": "Border",
+ "description": "The border to put at the right of the range."
},
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range whose borders should be updated."
+ },
+ "innerHorizontal": {
+ "$ref": "Border",
+ "description": "The horizontal border to put within the range."
+ },
+ "top": {
+ "$ref": "Border",
+ "description": "The border to put at the top of the range."
+ },
+ "left": {
+ "$ref": "Border",
+ "description": "The border to put at the left of the range."
+ },
+ "bottom": {
+ "$ref": "Border",
+ "description": "The border to put at the bottom of the range."
+ },
+ "innerVertical": {
+ "$ref": "Border",
+ "description": "The vertical border to put within the range."
}
},
"type": "object"
},
- "Spreadsheet": {
- "description": "Resource that represents a spreadsheet.",
- "id": "Spreadsheet",
+ "CellFormat": {
+ "description": "The format of a cell.",
+ "id": "CellFormat",
"properties": {
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "Overall properties of a spreadsheet."
+ "numberFormat": {
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
},
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "hyperlinkDisplayType": {
+ "description": "How a hyperlink, if it exists, should be displayed in the cell.",
+ "enum": [
+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
+ "LINKED",
+ "PLAIN_TEXT"
+ ],
+ "enumDescriptions": [
+ "The default value: the hyperlink is rendered. Do not use this.",
+ "A hyperlink should be explicitly rendered.",
+ "A hyperlink should not be rendered."
+ ],
"type": "string"
},
- "sheets": {
- "description": "The sheets that are part of a spreadsheet.",
- "items": {
- "$ref": "Sheet"
- },
- "type": "array"
+ "horizontalAlignment": {
+ "description": "The horizontal alignment of the value in the cell.",
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "type": "string"
},
- "namedRanges": {
- "description": "The named ranges defined in a spreadsheet.",
- "items": {
- "$ref": "NamedRange"
- },
- "type": "array"
+ "textFormat": {
+ "$ref": "TextFormat",
+ "description": "The format of the text in the cell (unless overridden by a format run)."
},
- "spreadsheetUrl": {
- "description": "The url of the spreadsheet.\nThis field is read-only.",
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the cell."
+ },
+ "verticalAlignment": {
+ "description": "The vertical alignment of the value in the cell.",
+ "enum": [
+ "VERTICAL_ALIGN_UNSPECIFIED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "enumDescriptions": [
+ "The vertical alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the top of the cell.",
+ "The text is explicitly aligned to the middle of the cell.",
+ "The text is explicitly aligned to the bottom of the cell."
+ ],
+ "type": "string"
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
+ },
+ "borders": {
+ "$ref": "Borders",
+ "description": "The borders of the cell."
+ },
+ "textDirection": {
+ "description": "The direction of the text in the cell.",
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "enumDescriptions": [
+ "The text direction is not specified. Do not use this.",
+ "The text direction of left-to-right was set by the user.",
+ "The text direction of right-to-left was set by the user."
+ ],
+ "type": "string"
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
+ },
+ "wrapStrategy": {
+ "description": "The wrap strategy for the value in the cell.",
+ "enum": [
+ "WRAP_STRATEGY_UNSPECIFIED",
+ "OVERFLOW_CELL",
+ "LEGACY_WRAP",
+ "CLIP",
+ "WRAP"
+ ],
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Lines that are longer than the cell width will be written 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 next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. <- Text continues into next cell\n | Next newline. |",
+ "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | word. |",
+ "Lines that are longer than the cell width will be clipped.\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| <- Text is clipped\n | Next newline. |",
+ "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| <- Word is broken.\n | ong word. |"
+ ],
"type": "string"
}
},
"type": "object"
},
- "AddChartRequest": {
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "id": "AddChartRequest",
- "properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)"
- }
- },
- "type": "object"
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "id": "UpdateProtectedRangeRequest",
+ "ClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "id": "ClearValuesResponse",
"properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
+ "clearedRange": {
+ "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
"type": "string"
}
},
"type": "object"
},
- "TextFormat": {
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "id": "TextFormat",
+ "DeleteConditionalFormatRuleRequest": {
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "id": "DeleteConditionalFormatRuleRequest",
"properties": {
- "foregroundColor": {
- "$ref": "Color",
- "description": "The foreground color of the text."
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
- },
- "fontFamily": {
- "description": "The font family.",
- "type": "string"
- },
- "strikethrough": {
- "description": "True if the text has a strikethrough.",
- "type": "boolean"
- },
- "italic": {
- "description": "True if the text is italicized.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the font.",
+ "index": {
+ "description": "The zero-based index of the rule to be deleted.",
"format": "int32",
"type": "integer"
},
- "underline": {
- "description": "True if the text is underlined.",
- "type": "boolean"
+ "sheetId": {
+ "description": "The sheet the rule is being deleted from.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "AddSheetResponse": {
- "description": "The result of adding a sheet.",
- "id": "AddSheetResponse",
+ "AddBandingResponse": {
+ "description": "The result of adding a banded range.",
+ "id": "AddBandingResponse",
"properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the newly added sheet."
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range that was added."
}
},
"type": "object"
},
- "AddFilterViewResponse": {
- "description": "The result of adding a filter view.",
- "id": "AddFilterViewResponse",
+ "DeleteNamedRangeRequest": {
+ "description": "Removes the named range with the given ID from the spreadsheet.",
+ "id": "DeleteNamedRangeRequest",
"properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly added filter view."
+ "namedRangeId": {
+ "description": "The ID of the named range to delete.",
+ "type": "string"
}
},
"type": "object"
},
- "IterativeCalculationSettings": {
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
- "id": "IterativeCalculationSettings",
+ "ChartData": {
+ "description": "The data included in a domain or series.",
+ "id": "ChartData",
"properties": {
- "convergenceThreshold": {
- "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
- "format": "double",
- "type": "number"
- },
- "maxIterations": {
- "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
+ "sourceRange": {
+ "$ref": "ChartSourceRange",
+ "description": "The source ranges of the data."
}
},
"type": "object"
},
- "SpreadsheetProperties": {
- "description": "Properties of a spreadsheet.",
- "id": "SpreadsheetProperties",
+ "BatchGetValuesResponse": {
+ "description": "The response when retrieving more than one range of values in a spreadsheet.",
+ "id": "BatchGetValuesResponse",
"properties": {
- "autoRecalc": {
- "description": "The amount of time to wait before volatile functions are recalculated.",
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ],
- "type": "string"
- },
- "defaultFormat": {
- "$ref": "CellFormat",
- "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "type": "string"
- },
- "timeZone": {
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
"type": "string"
},
- "locale": {
- "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.",
+ "valueRanges": {
+ "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
+ "items": {
+ "$ref": "ValueRange"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateBandingRequest": {
+ "description": "Updates properties of the supplied banded range.",
+ "id": "UpdateBandingRequest",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
"type": "string"
},
- "iterativeCalculationSettings": {
- "$ref": "IterativeCalculationSettings",
- "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range to update with the new properties."
}
},
"type": "object"
},
- "OverlayPosition": {
- "description": "The location an object is overlaid on top of a grid.",
- "id": "OverlayPosition",
+ "Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "id": "Color",
"properties": {
- "widthPixels": {
- "description": "The width of the object, in pixels. Defaults to 600.",
- "format": "int32",
- "type": "integer"
- },
- "offsetXPixels": {
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
},
- "anchorCell": {
- "$ref": "GridCoordinate",
- "description": "The cell the object is anchored to."
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
},
- "offsetYPixels": {
- "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
},
- "heightPixels": {
- "description": "The height of the object, in pixels. Defaults to 371.",
- "format": "int32",
- "type": "integer"
+ "alpha": {
+ "description": "The fraction of this color that should be applied 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\nThis 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 between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
}
},
"type": "object"
},
- "RepeatCellRequest": {
- "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; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will 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 `=A2`, 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, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
- "id": "RepeatCellRequest",
+ "PivotGroup": {
+ "description": "A single grouping (either row or column) in a pivot table.",
+ "id": "PivotGroup",
"properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to repeat the cell in."
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
+ "format": "int32",
+ "type": "integer"
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
+ "showTotals": {
+ "description": "True if the pivot table should include the totals for this grouping.",
+ "type": "boolean"
},
- "cell": {
- "$ref": "CellData",
- "description": "The data to write."
+ "valueMetadata": {
+ "description": "Metadata about values in the grouping.",
+ "items": {
+ "$ref": "PivotGroupValueMetadata"
+ },
+ "type": "array"
+ },
+ "sortOrder": {
+ "description": "The order the values in this group should be sorted.",
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "type": "string"
+ },
+ "valueBucket": {
+ "$ref": "PivotGroupSortValueBucket",
+ "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
}
},
"type": "object"
},
- "AddChartResponse": {
- "description": "The result of adding a chart to a spreadsheet.",
- "id": "AddChartResponse",
+ "PivotTable": {
+ "description": "A pivot table.",
+ "id": "PivotTable",
"properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The newly added chart."
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "PivotFilterCriteria"
+ },
+ "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot 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 the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
+ "type": "object"
+ },
+ "rows": {
+ "description": "Each row grouping in the pivot table.",
+ "items": {
+ "$ref": "PivotGroup"
+ },
+ "type": "array"
+ },
+ "valueLayout": {
+ "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
+ "enum": [
+ "HORIZONTAL",
+ "VERTICAL"
+ ],
+ "enumDescriptions": [
+ "Values are laid out horizontally (as columns).",
+ "Values are laid out vertically (as rows)."
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "A list of values to include in the pivot table.",
+ "items": {
+ "$ref": "PivotValue"
+ },
+ "type": "array"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The range the pivot table is reading data from."
+ },
+ "columns": {
+ "description": "Each column grouping in the pivot table.",
+ "items": {
+ "$ref": "PivotGroup"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "InsertDimensionRequest": {
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "id": "InsertDimensionRequest",
+ "ChartSourceRange": {
+ "description": "Source ranges for a chart.",
+ "id": "ChartSourceRange",
"properties": {
- "inheritFromBefore": {
- "description": "Whether dimension properties should be extended 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 greater 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 inserting 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 before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
- "type": "boolean"
- },
- "range": {
- "$ref": "DimensionRange",
- "description": "The dimensions to insert. Both the start and end indexes must be bounded."
+ "sources": {
+ "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
+ "items": {
+ "$ref": "GridRange"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "id": "UpdateSpreadsheetPropertiesRequest",
+ "AppendCellsRequest": {
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "id": "AppendCellsRequest",
"properties": {
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "The properties to update."
+ "rows": {
+ "description": "The data to append.",
+ "items": {
+ "$ref": "RowData"
+ },
+ "type": "array"
},
"fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "sheetId": {
+ "description": "The sheet ID to append the data to.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "BatchUpdateValuesRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "id": "BatchUpdateValuesRequest",
+ "ValueRange": {
+ "description": "Data within a range of the spreadsheet.",
+ "id": "ValueRange",
"properties": {
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
+ "range": {
+ "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
"type": "string"
},
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "description": "How the input data should be interpreted.",
+ "majorDimension": {
+ "description": "The major dimension of the values.\n\nFor output, 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]]`.\n\nFor input, with `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 defaults to ROWS.",
"enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
],
"enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into 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 into a cell via the Google Sheets UI."
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
],
"type": "string"
},
- "data": {
- "description": "The new values to apply to the spreadsheet.",
+ "values": {
+ "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
"items": {
- "$ref": "ValueRange"
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
},
"type": "array"
- },
- "responseDateTimeRenderOption": {
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ],
- "type": "string"
}
},
"type": "object"
},
- "ProtectedRange": {
- "description": "A protected range.",
- "id": "ProtectedRange",
+ "AddBandingRequest": {
+ "description": "Adds a new banded range to the spreadsheet.",
+ "id": "AddBandingRequest",
"properties": {
- "warningOnly": {
- "description": "True if 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 user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is 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 will be set to all the editors in the document.",
- "type": "boolean"
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ }
+ },
+ "type": "object"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "id": "Response",
+ "properties": {
+ "addFilterView": {
+ "$ref": "AddFilterViewResponse",
+ "description": "A reply from adding a filter view."
},
- "requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
+ "addBanding": {
+ "$ref": "AddBandingResponse",
+ "description": "A reply from adding a banded range."
},
- "range": {
- "$ref": "GridRange",
- "description": "The range that is being protected.\nThe range 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."
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeResponse",
+ "description": "A reply from adding a protected range."
},
- "editors": {
- "$ref": "Editors",
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
},
- "description": {
- "description": "The description of this protected range.",
- "type": "string"
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleResponse",
+ "description": "A reply from deleting a conditional format rule."
},
- "unprotectedRanges": {
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
- "items": {
- "$ref": "GridRange"
- },
- "type": "array"
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionResponse",
+ "description": "A reply from updating an embedded object's position."
},
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewResponse",
+ "description": "A reply from duplicating a filter view."
},
- "protectedRangeId": {
- "description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32",
- "type": "integer"
+ "addChart": {
+ "$ref": "AddChartResponse",
+ "description": "A reply from adding a chart."
+ },
+ "findReplace": {
+ "$ref": "FindReplaceResponse",
+ "description": "A reply from doing a find/replace."
+ },
+ "addSheet": {
+ "$ref": "AddSheetResponse",
+ "description": "A reply from adding a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeResponse",
+ "description": "A reply from adding a named range."
}
},
"type": "object"
},
- "DimensionProperties": {
- "description": "Properties about a dimension.",
- "id": "DimensionProperties",
+ "EmbeddedChart": {
+ "description": "A chart embedded in a sheet.",
+ "id": "EmbeddedChart",
"properties": {
- "pixelSize": {
- "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
+ "spec": {
+ "$ref": "ChartSpec",
+ "description": "The specification of the chart."
+ },
+ "chartId": {
+ "description": "The ID of the chart.",
"format": "int32",
"type": "integer"
},
- "hiddenByFilter": {
- "description": "True if this dimension is being filtered.\nThis field is read-only.",
- "type": "boolean"
- },
- "hiddenByUser": {
- "description": "True if this dimension is explicitly hidden.",
- "type": "boolean"
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The position of the chart."
}
},
"type": "object"
},
- "NamedRange": {
- "description": "A named range.",
- "id": "NamedRange",
+ "TextFormatRun": {
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
+ "id": "TextFormatRun",
"properties": {
- "namedRangeId": {
- "description": "The ID of the named range.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this represents."
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
},
- "name": {
- "description": "The name of the named range.",
- "type": "string"
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "DimensionRange": {
- "description": "A range along a single dimension on a sheet.\nAll indexes 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.",
- "id": "DimensionRange",
+ "InsertRangeRequest": {
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "id": "InsertRangeRequest",
"properties": {
- "dimension": {
- "description": "The dimension of the span.",
+ "shiftDimension": {
+ "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
@@ -2957,554 +3045,624 @@
],
"type": "string"
},
- "startIndex": {
- "description": "The start (inclusive) of the span, or not set if unbounded.",
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to insert new cells into."
+ }
+ },
+ "type": "object"
+ },
+ "AddNamedRangeResponse": {
+ "description": "The result of adding a named range.",
+ "id": "AddNamedRangeResponse",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add."
+ }
+ },
+ "type": "object"
+ },
+ "RowData": {
+ "description": "Data about each cell in a row.",
+ "id": "RowData",
+ "properties": {
+ "values": {
+ "description": "The values in the row, one per column.",
+ "items": {
+ "$ref": "CellData"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Border": {
+ "description": "A border along a cell.",
+ "id": "Border",
+ "properties": {
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
"format": "int32",
"type": "integer"
},
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
+ "style": {
+ "description": "The style of the border.",
+ "enum": [
+ "STYLE_UNSPECIFIED",
+ "DOTTED",
+ "DASHED",
+ "SOLID",
+ "SOLID_MEDIUM",
+ "SOLID_THICK",
+ "NONE",
+ "DOUBLE"
+ ],
+ "enumDescriptions": [
+ "The style is not specified. Do not use this.",
+ "The border is dotted.",
+ "The border is dashed.",
+ "The border is a thin solid line.",
+ "The border is a medium solid line.",
+ "The border is a thick solid line.",
+ "No border.\nUsed only when updating a border in order to erase it.",
+ "The border is two solid lines."
+ ],
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the border."
+ }
+ },
+ "type": "object"
+ },
+ "GridData": {
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "id": "GridData",
+ "properties": {
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "items": {
+ "$ref": "RowData"
+ },
+ "type": "array"
+ },
+ "startRow": {
+ "description": "The first row this GridData refers to, zero-based.",
"format": "int32",
"type": "integer"
},
- "sheetId": {
- "description": "The sheet this span is on.",
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "items": {
+ "$ref": "DimensionProperties"
+ },
+ "type": "array"
+ },
+ "startColumn": {
+ "description": "The first column this GridData refers to, zero-based.",
"format": "int32",
"type": "integer"
+ },
+ "rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
+ "items": {
+ "$ref": "DimensionProperties"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "CutPasteRequest": {
- "description": "Moves data from the source to the destination.",
- "id": "CutPasteRequest",
+ "FindReplaceRequest": {
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
+ "id": "FindReplaceRequest",
"properties": {
- "source": {
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
"$ref": "GridRange",
- "description": "The source data to cut."
+ "description": "The range to find/replace over."
},
- "pasteType": {
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ],
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
+ "sheetId": {
+ "description": "The sheet to find/replace over.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "matchCase": {
+ "description": "True if the search is case sensitive.",
+ "type": "boolean"
+ },
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
+ "includeFormulas": {
+ "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
+ "type": "boolean"
+ },
+ "matchEntireCell": {
+ "description": "True if the find value should match the entire cell.",
+ "type": "boolean"
+ },
+ "find": {
+ "description": "The value to search.",
"type": "string"
},
- "destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
+ "searchByRegex": {
+ "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"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.",
+ "type": "boolean"
}
},
"type": "object"
},
- "BasicChartSeries": {
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
- "id": "BasicChartSeries",
+ "UpdateNamedRangeRequest": {
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "id": "UpdateNamedRangeRequest",
"properties": {
- "series": {
- "$ref": "ChartData",
- "description": "The data being visualized in this chart series."
- },
- "type": {
- "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO"
- ],
- "enumDescriptions": [
- "Default value, do not use.",
- "A <a href=\"/chart/interactive/docs/gallery/barchart\">bar chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/linechart\">line chart</a>.",
- "An <a href=\"/chart/interactive/docs/gallery/areachart\">area chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/columnchart\">column chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/scatterchart\">scatter chart</a>.",
- "A <a href=\"/chart/interactive/docs/gallery/combochart\">combo chart</a>."
- ],
- "type": "string"
- },
- "targetAxis": {
- "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to update with the new properties."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
- "Borders": {
- "description": "The borders of the cell.",
- "id": "Borders",
+ "AddSheetRequest": {
+ "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\nEmbeddedObjectPosition.newSheet.",
+ "id": "AddSheetRequest",
"properties": {
- "bottom": {
- "$ref": "Border",
- "description": "The bottom border of the cell."
- },
- "top": {
- "$ref": "Border",
- "description": "The top border of the cell."
- },
- "left": {
- "$ref": "Border",
- "description": "The left border of the cell."
- },
- "right": {
- "$ref": "Border",
- "description": "The right border of the cell."
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
}
},
"type": "object"
},
- "AutoResizeDimensionsRequest": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "id": "AutoResizeDimensionsRequest",
+ "UpdateCellsRequest": {
+ "description": "Updates all cells in a range with new data.",
+ "id": "UpdateCellsRequest",
"properties": {
- "dimensions": {
- "$ref": "DimensionRange",
- "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported."
+ "start": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ },
+ "rows": {
+ "description": "The data to write.",
+ "items": {
+ "$ref": "RowData"
+ },
+ "type": "array"
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"type": "object"
},
- "UpdateBordersRequest": {
- "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
- "id": "UpdateBordersRequest",
+ "DeleteConditionalFormatRuleResponse": {
+ "description": "The result of deleting a conditional format rule.",
+ "id": "DeleteConditionalFormatRuleResponse",
"properties": {
- "innerHorizontal": {
- "$ref": "Border",
- "description": "The horizontal border to put within the range."
- },
- "top": {
- "$ref": "Border",
- "description": "The border to put at the top of the range."
- },
- "left": {
- "$ref": "Border",
- "description": "The border to put at the left of the range."
- },
- "bottom": {
- "$ref": "Border",
- "description": "The border to put at the bottom of the range."
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within the range."
- },
- "right": {
- "$ref": "Border",
- "description": "The border to put at the right of the range."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range whose borders should be updated."
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that was deleted."
}
},
"type": "object"
},
- "CellFormat": {
- "description": "The format of a cell.",
- "id": "CellFormat",
+ "DeleteRangeRequest": {
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
+ "id": "DeleteRangeRequest",
"properties": {
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the cell."
- },
- "padding": {
- "$ref": "Padding",
- "description": "The padding of the cell."
- },
- "verticalAlignment": {
- "description": "The vertical alignment of the value in the cell.",
+ "shiftDimension": {
+ "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
"enum": [
- "VERTICAL_ALIGN_UNSPECIFIED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
],
"enumDescriptions": [
- "The vertical alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the top of the cell.",
- "The text is explicitly aligned to the middle of the cell.",
- "The text is explicitly aligned to the bottom of the cell."
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
],
"type": "string"
},
- "borders": {
- "$ref": "Borders",
- "description": "The borders of the cell."
- },
- "textDirection": {
- "description": "The direction of the text in the cell.",
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "enumDescriptions": [
- "The text direction is not specified. Do not use this.",
- "The text direction of left-to-right was set by the user.",
- "The text direction of right-to-left was set by the user."
- ],
- "type": "string"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to delete."
+ }
+ },
+ "type": "object"
+ },
+ "GridCoordinate": {
+ "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
+ "id": "GridCoordinate",
+ "properties": {
+ "rowIndex": {
+ "description": "The row index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
},
- "textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
+ "columnIndex": {
+ "description": "The column index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
},
- "wrapStrategy": {
- "description": "The wrap strategy for the value in the cell.",
- "enum": [
- "WRAP_STRATEGY_UNSPECIFIED",
- "OVERFLOW_CELL",
- "LEGACY_WRAP",
- "CLIP",
- "WRAP"
- ],
- "enumDescriptions": [
- "The default value, do not use.",
- "Lines that are longer than the cell width will be written 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 next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. <- Text continues into next cell\n | Next newline. |",
- "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | word. |",
- "Lines that are longer than the cell width will be clipped.\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| <- Text is clipped\n | Next newline. |",
- "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| <- Word is broken.\n | ong word. |"
- ],
+ "sheetId": {
+ "description": "The sheet this coordinate is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateSheetPropertiesRequest": {
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "id": "UpdateSheetPropertiesRequest",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
"type": "string"
},
- "numberFormat": {
- "$ref": "NumberFormat",
- "description": "A format describing how number values should be represented to the user."
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties to update."
+ }
+ },
+ "type": "object"
+ },
+ "GridProperties": {
+ "description": "Properties of a grid.",
+ "id": "GridProperties",
+ "properties": {
+ "rowCount": {
+ "description": "The number of rows in the grid.",
+ "format": "int32",
+ "type": "integer"
},
- "hyperlinkDisplayType": {
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "enum": [
- "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
- "LINKED",
- "PLAIN_TEXT"
- ],
- "enumDescriptions": [
- "The default value: the hyperlink is rendered. Do not use this.",
- "A hyperlink should be explicitly rendered.",
- "A hyperlink should not be rendered."
- ],
- "type": "string"
+ "frozenRowCount": {
+ "description": "The number of rows that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
},
- "horizontalAlignment": {
- "description": "The horizontal alignment of the value in the cell.",
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ],
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "type": "string"
+ "hideGridlines": {
+ "description": "True if the grid isn't showing gridlines in the UI.",
+ "type": "boolean"
},
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The format of the text in the cell (unless overridden by a format run)."
+ "columnCount": {
+ "description": "The number of columns in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenColumnCount": {
+ "description": "The number of columns that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "ClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "id": "ClearValuesResponse",
+ "UnmergeCellsRequest": {
+ "description": "Unmerges cells in the given range.",
+ "id": "UnmergeCellsRequest",
"properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRange": {
- "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
- "type": "string"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
}
},
"type": "object"
},
- "DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
- "id": "DeleteConditionalFormatRuleRequest",
+ "UpdateEmbeddedObjectPositionResponse": {
+ "description": "The result of updating an embedded object's position.",
+ "id": "UpdateEmbeddedObjectPositionResponse",
"properties": {
- "index": {
- "description": "The zero-based index of the rule to be deleted.",
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The new position of the embedded object."
+ }
+ },
+ "type": "object"
+ },
+ "SortSpec": {
+ "description": "A sort order associated with a specific column or row.",
+ "id": "SortSpec",
+ "properties": {
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
"format": "int32",
"type": "integer"
},
- "sheetId": {
- "description": "The sheet the rule is being deleted from.",
- "format": "int32",
- "type": "integer"
+ "sortOrder": {
+ "description": "The order data should be sorted.",
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "DeleteNamedRangeRequest": {
- "description": "Removes the named range with the given ID from the spreadsheet.",
- "id": "DeleteNamedRangeRequest",
+ "Sheet": {
+ "description": "A sheet in a spreadsheet.",
+ "id": "Sheet",
"properties": {
- "namedRangeId": {
- "description": "The ID of the named range to delete.",
- "type": "string"
+ "data": {
+ "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "items": {
+ "$ref": "GridData"
+ },
+ "type": "array"
+ },
+ "bandedRanges": {
+ "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "items": {
+ "$ref": "BandedRange"
+ },
+ "type": "array"
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "items": {
+ "$ref": "EmbeddedChart"
+ },
+ "type": "array"
+ },
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "items": {
+ "$ref": "FilterView"
+ },
+ "type": "array"
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "items": {
+ "$ref": "ProtectedRange"
+ },
+ "type": "array"
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ },
+ "type": "array"
+ },
+ "basicFilter": {
+ "$ref": "BasicFilter",
+ "description": "The filter on this sheet, if any."
+ },
+ "merges": {
+ "description": "The ranges that are merged together.",
+ "items": {
+ "$ref": "GridRange"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "AddBandingResponse": {
- "description": "The result of adding a banded range.",
- "id": "AddBandingResponse",
+ "BooleanRule": {
+ "description": "A rule that may or may not match, depending on the condition.",
+ "id": "BooleanRule",
"properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
+ "format": {
+ "$ref": "CellFormat",
+ "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
}
},
"type": "object"
},
- "ChartData": {
- "description": "The data included in a domain or series.",
- "id": "ChartData",
+ "PivotGroupValueMetadata": {
+ "description": "Metadata about a value in a pivot grouping.",
+ "id": "PivotGroupValueMetadata",
"properties": {
- "sourceRange": {
- "$ref": "ChartSourceRange",
- "description": "The source ranges of the data."
+ "value": {
+ "$ref": "ExtendedValue",
+ "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
+ },
+ "collapsed": {
+ "description": "True if the data corresponding to the value is collapsed.",
+ "type": "boolean"
}
},
"type": "object"
},
- "BatchGetValuesResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "id": "BatchGetValuesResponse",
+ "FilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "id": "FilterCriteria",
"properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
+ "hiddenValues": {
+ "description": "Values that should be hidden.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "valueRanges": {
- "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
+ "condition": {
+ "$ref": "BooleanCondition",
+ "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.)"
+ }
+ },
+ "type": "object"
+ },
+ "Editors": {
+ "description": "The editors of a protected range.",
+ "id": "Editors",
+ "properties": {
+ "users": {
+ "description": "The email addresses of users with edit access to the protected range.",
"items": {
- "$ref": "ValueRange"
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "groups": {
+ "description": "The email addresses of groups with edit access to the protected range.",
+ "items": {
+ "type": "string"
},
"type": "array"
+ },
+ "domainUsersCanEdit": {
+ "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
+ "type": "boolean"
}
},
"type": "object"
},
- "UpdateBandingRequest": {
- "description": "Updates properties of the supplied banded range.",
- "id": "UpdateBandingRequest",
+ "UpdateConditionalFormatRuleRequest": {
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "id": "UpdateConditionalFormatRuleRequest",
"properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that should replace the rule at the given index."
},
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to update with the new properties."
+ "index": {
+ "description": "The zero-based index of the rule that should be replaced or moved.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newIndex": {
+ "description": "The zero-based new index the rule should end up at.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "id": "Color",
+ "DataValidationRule": {
+ "description": "A data validation rule.",
+ "id": "DataValidationRule",
"properties": {
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition that data in the cell must match."
},
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
+ "showCustomUi": {
+ "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
+ "type": "boolean"
},
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
+ "strict": {
+ "description": "True if invalid data should be rejected.",
+ "type": "boolean"
},
- "alpha": {
- "description": "The fraction of this color that should be applied 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\nThis 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 between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
+ "inputMessage": {
+ "description": "A message to show the user when adding data to the cell.",
+ "type": "string"
}
},
"type": "object"
},
- "PivotGroup": {
- "description": "A single grouping (either row or column) in a pivot table.",
- "id": "PivotGroup",
+ "BasicChartDomain": {
+ "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
+ "id": "BasicChartDomain",
"properties": {
- "valueBucket": {
- "$ref": "PivotGroupSortValueBucket",
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
- },
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
- "format": "int32",
- "type": "integer"
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
},
- "showTotals": {
- "description": "True if the pivot table should include the totals for this grouping.",
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).\nNot applicable to Gauge, Geo, Histogram, Org, Pie, Radar, and Treemap\ncharts.",
"type": "boolean"
- },
- "valueMetadata": {
- "description": "Metadata about values in the grouping.",
- "items": {
- "$ref": "PivotGroupValueMetadata"
- },
- "type": "array"
- },
- "sortOrder": {
- "description": "The order the values in this group should be sorted.",
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "type": "string"
}
},
"type": "object"
},
- "PivotTable": {
- "description": "A pivot table.",
- "id": "PivotTable",
+ "PasteDataRequest": {
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "id": "PasteDataRequest",
"properties": {
- "criteria": {
- "additionalProperties": {
- "$ref": "PivotFilterCriteria"
- },
- "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot 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 the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
- "type": "object"
+ "data": {
+ "description": "The data to insert.",
+ "type": "string"
},
- "rows": {
- "description": "Each row grouping in the pivot table.",
- "items": {
- "$ref": "PivotGroup"
- },
- "type": "array"
+ "delimiter": {
+ "description": "The delimiter in the data.",
+ "type": "string"
},
- "valueLayout": {
- "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
+ "type": {
+ "description": "How the data should be pasted.",
"enum": [
- "HORIZONTAL",
- "VERTICAL"
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
],
"enumDescriptions": [
- "Values are laid out horizontally (as columns).",
- "Values are laid out vertically (as rows)."
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
],
"type": "string"
},
- "source": {
- "$ref": "GridRange",
- "description": "The range the pivot table is reading data from."
- },
- "columns": {
- "description": "Each column grouping in the pivot table.",
- "items": {
- "$ref": "PivotGroup"
- },
- "type": "array"
+ "html": {
+ "description": "True if the data is HTML.",
+ "type": "boolean"
},
- "values": {
- "description": "A list of values to include in the pivot table.",
- "items": {
- "$ref": "PivotValue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ChartSourceRange": {
- "description": "Source ranges for a chart.",
- "id": "ChartSourceRange",
- "properties": {
- "sources": {
- "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
- "items": {
- "$ref": "GridRange"
- },
- "type": "array"
+ "coordinate": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate at which the data should start being inserted."
}
},
"type": "object"
},
- "AppendCellsRequest": {
- "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
- "id": "AppendCellsRequest",
+ "AppendDimensionRequest": {
+ "description": "Appends rows or columns to the end of a sheet.",
+ "id": "AppendDimensionRequest",
"properties": {
"sheetId": {
- "description": "The sheet ID to append the data to.",
+ "description": "The sheet to append rows or columns to.",
"format": "int32",
"type": "integer"
},
- "rows": {
- "description": "The data to append.",
- "items": {
- "$ref": "RowData"
- },
- "type": "array"
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ValueRange": {
- "description": "Data within a range of the spreadsheet.",
- "id": "ValueRange",
- "properties": {
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
- },
- "majorDimension": {
- "description": "The major dimension of the values.\n\nFor output, 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]]`.\n\nFor input, with `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 defaults to ROWS.",
+ "dimension": {
+ "description": "Whether rows or columns should be appended.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
@@ -3517,693 +3675,846 @@
],
"type": "string"
},
- "values": {
- "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
- "items": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AddBandingRequest": {
- "description": "Adds a new banded range to the spreadsheet.",
- "id": "AddBandingRequest",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ "length": {
+ "description": "The number of rows or columns to append.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "Response": {
- "description": "A single response from an update.",
- "id": "Response",
+ "AddNamedRangeRequest": {
+ "description": "Adds a named range to the spreadsheet.",
+ "id": "AddNamedRangeRequest",
"properties": {
- "addProtectedRange": {
- "$ref": "AddProtectedRangeResponse",
- "description": "A reply from adding a protected range."
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetResponse",
- "description": "A reply from duplicating a sheet."
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleResponse",
- "description": "A reply from deleting a conditional format rule."
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionResponse",
- "description": "A reply from updating an embedded object's position."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewResponse",
- "description": "A reply from duplicating a filter view."
- },
- "addChart": {
- "$ref": "AddChartResponse",
- "description": "A reply from adding a chart."
- },
- "findReplace": {
- "$ref": "FindReplaceResponse",
- "description": "A reply from doing a find/replace."
- },
- "addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- },
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleResponse",
- "description": "A reply from updating a conditional format rule."
- },
- "addNamedRange": {
- "$ref": "AddNamedRangeResponse",
- "description": "A reply from adding a named range."
- },
- "addFilterView": {
- "$ref": "AddFilterViewResponse",
- "description": "A reply from adding a filter view."
- },
- "addBanding": {
- "$ref": "AddBandingResponse",
- "description": "A reply from adding a banded range."
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
}
},
"type": "object"
},
- "EmbeddedChart": {
- "description": "A chart embedded in a sheet.",
- "id": "EmbeddedChart",
+ "UpdateEmbeddedObjectPositionRequest": {
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "id": "UpdateEmbeddedObjectPositionRequest",
"properties": {
- "chartId": {
- "description": "The ID of the chart.",
+ "fields": {
+ "description": "The fields of OverlayPosition\nthat should be 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 `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The ID of the object to moved.",
"format": "int32",
"type": "integer"
},
- "position": {
+ "newPosition": {
"$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
- },
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification of the chart."
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
}
},
"type": "object"
},
- "TextFormatRun": {
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
- "id": "TextFormatRun",
+ "TextRotation": {
+ "description": "The rotation applied to text in a cell.",
+ "id": "TextRotation",
"properties": {
- "format": {
- "$ref": "TextFormat",
- "description": "The format of this run. Absent values inherit the cell's format."
- },
- "startIndex": {
- "description": "The character index where this run starts.",
+ "angle": {
+ "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
"format": "int32",
"type": "integer"
+ },
+ "vertical": {
+ "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
+ "type": "boolean"
}
},
"type": "object"
},
- "InsertRangeRequest": {
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "id": "InsertRangeRequest",
+ "PieChartSpec": {
+ "description": "A <a href=\"/chart/interactive/docs/gallery/piechart\">pie chart</a>.",
+ "id": "PieChartSpec",
"properties": {
- "shiftDimension": {
- "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data that covers the domain of the pie chart."
+ },
+ "threeDimensional": {
+ "description": "True if the pie is three dimensional.",
+ "type": "boolean"
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data that covers the one and only series of the pie chart."
+ },
+ "legendPosition": {
+ "description": "Where the legend of the pie chart should be drawn.",
"enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
+ "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "LABELED_LEGEND"
],
"enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "Each pie slice has a label attached to it."
],
"type": "string"
},
- "range": {
- "$ref": "GridRange",
- "description": "The range to insert new cells into."
+ "pieHole": {
+ "description": "The size of the hole in the pie chart.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
},
- "AddNamedRangeResponse": {
- "description": "The result of adding a named range.",
- "id": "AddNamedRangeResponse",
+ "UpdateFilterViewRequest": {
+ "description": "Updates properties of the filter view.",
+ "id": "UpdateFilterViewRequest",
"properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The new properties of the filter view."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"type": "object"
},
- "RowData": {
- "description": "Data about each cell in a row.",
- "id": "RowData",
+ "ConditionalFormatRule": {
+ "description": "A rule describing a conditional format.",
+ "id": "ConditionalFormatRule",
"properties": {
- "values": {
- "description": "The values in the row, one per column.",
+ "ranges": {
+ "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
"items": {
- "$ref": "CellData"
+ "$ref": "GridRange"
},
"type": "array"
+ },
+ "gradientRule": {
+ "$ref": "GradientRule",
+ "description": "The formatting will vary based on the gradients in the rule."
+ },
+ "booleanRule": {
+ "$ref": "BooleanRule",
+ "description": "The formatting is either \"on\" or \"off\" according to the rule."
}
},
"type": "object"
},
- "Border": {
- "description": "A border along a cell.",
- "id": "Border",
+ "CopyPasteRequest": {
+ "description": "Copies data from the source to the destination.",
+ "id": "CopyPasteRequest",
"properties": {
- "color": {
- "$ref": "Color",
- "description": "The color of the border."
+ "destination": {
+ "$ref": "GridRange",
+ "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
+ },
+ "pasteOrientation": {
+ "description": "How that data should be oriented when pasting.",
+ "enum": [
+ "NORMAL",
+ "TRANSPOSE"
+ ],
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
+ "type": "string"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source range to copy."
+ },
+ "pasteType": {
+ "description": "What kind of data to paste.",
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "id": "Request",
+ "properties": {
+ "updateBanding": {
+ "$ref": "UpdateBandingRequest",
+ "description": "Updates a banded range"
+ },
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetRequest",
+ "description": "Duplicates a sheet."
+ },
+ "unmergeCells": {
+ "$ref": "UnmergeCellsRequest",
+ "description": "Unmerges merged cells."
+ },
+ "deleteSheet": {
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Updates an embedded object's (e.g. chart, image) position."
+ },
+ "updateDimensionProperties": {
+ "$ref": "UpdateDimensionPropertiesRequest",
+ "description": "Updates dimensions' properties."
+ },
+ "pasteData": {
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
+ },
+ "setBasicFilter": {
+ "$ref": "SetBasicFilterRequest",
+ "description": "Sets the basic filter on a sheet."
+ },
+ "addConditionalFormatRule": {
+ "$ref": "AddConditionalFormatRuleRequest",
+ "description": "Adds a new conditional format rule."
+ },
+ "updateCells": {
+ "$ref": "UpdateCellsRequest",
+ "description": "Updates many cells at once."
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeRequest",
+ "description": "Adds a named range."
+ },
+ "updateSpreadsheetProperties": {
+ "$ref": "UpdateSpreadsheetPropertiesRequest",
+ "description": "Updates the spreadsheet's properties."
+ },
+ "deleteEmbeddedObject": {
+ "$ref": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ },
+ "updateFilterView": {
+ "$ref": "UpdateFilterViewRequest",
+ "description": "Updates the properties of a filter view."
+ },
+ "addBanding": {
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "appendCells": {
+ "$ref": "AppendCellsRequest",
+ "description": "Appends cells after the last row with data in a sheet."
+ },
+ "autoResizeDimensions": {
+ "$ref": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
+ },
+ "cutPaste": {
+ "$ref": "CutPasteRequest",
+ "description": "Cuts data from one area and pastes it to another."
+ },
+ "mergeCells": {
+ "$ref": "MergeCellsRequest",
+ "description": "Merges cells together."
},
- "width": {
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32",
- "type": "integer"
+ "updateNamedRange": {
+ "$ref": "UpdateNamedRangeRequest",
+ "description": "Updates a named range."
},
- "style": {
- "description": "The style of the border.",
- "enum": [
- "STYLE_UNSPECIFIED",
- "DOTTED",
- "DASHED",
- "SOLID",
- "SOLID_MEDIUM",
- "SOLID_THICK",
- "NONE",
- "DOUBLE"
- ],
- "enumDescriptions": [
- "The style is not specified. Do not use this.",
- "The border is dotted.",
- "The border is dashed.",
- "The border is a thin solid line.",
- "The border is a medium solid line.",
- "The border is a thick solid line.",
- "No border.\nUsed only when updating a border in order to erase it.",
- "The border is two solid lines."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "id": "GridData",
- "properties": {
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "items": {
- "$ref": "DimensionProperties"
- },
- "type": "array"
+ "updateSheetProperties": {
+ "$ref": "UpdateSheetPropertiesRequest",
+ "description": "Updates a sheet's properties."
},
- "startColumn": {
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
+ "autoFill": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
},
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "items": {
- "$ref": "DimensionProperties"
- },
- "type": "array"
+ "deleteDimension": {
+ "$ref": "DeleteDimensionRequest",
+ "description": "Deletes rows or columns in a sheet."
},
- "rowData": {
- "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
- "items": {
- "$ref": "RowData"
- },
- "type": "array"
+ "sortRange": {
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
},
- "startRow": {
- "description": "The first row this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "FindReplaceRequest": {
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "id": "FindReplaceRequest",
- "properties": {
- "replacement": {
- "description": "The value to use as the replacement.",
- "type": "string"
+ "deleteProtectedRange": {
+ "$ref": "DeleteProtectedRangeRequest",
+ "description": "Deletes a protected range."
},
- "range": {
- "$ref": "GridRange",
- "description": "The range to find/replace over."
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewRequest",
+ "description": "Duplicates a filter view."
},
- "sheetId": {
- "description": "The sheet to find/replace over.",
- "format": "int32",
- "type": "integer"
+ "addChart": {
+ "$ref": "AddChartRequest",
+ "description": "Adds a chart."
},
- "matchCase": {
- "description": "True if the search is case sensitive.",
- "type": "boolean"
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
},
- "allSheets": {
- "description": "True to find/replace over all sheets.",
- "type": "boolean"
+ "textToColumns": {
+ "$ref": "TextToColumnsRequest",
+ "description": "Converts a column of text into many columns of text."
},
- "includeFormulas": {
- "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
- "type": "boolean"
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
},
- "matchEntireCell": {
- "description": "True if the find value should match the entire cell.",
- "type": "boolean"
+ "updateProtectedRange": {
+ "$ref": "UpdateProtectedRangeRequest",
+ "description": "Updates a protected range."
},
- "find": {
- "description": "The value to search.",
- "type": "string"
+ "addSheet": {
+ "$ref": "AddSheetRequest",
+ "description": "Adds a sheet."
},
- "searchByRegex": {
- "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"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.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "id": "UpdateNamedRangeRequest",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to update with the new properties."
+ "copyPaste": {
+ "$ref": "CopyPasteRequest",
+ "description": "Copies data from one area and pastes it to another."
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AddSheetRequest": {
- "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\nEmbeddedObjectPosition.newSheet.",
- "id": "AddSheetRequest",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
- }
- },
- "type": "object"
- },
- "UpdateCellsRequest": {
- "description": "Updates all cells in a range with new data.",
- "id": "UpdateCellsRequest",
- "properties": {
- "start": {
- "$ref": "GridCoordinate",
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
+ "deleteFilterView": {
+ "$ref": "DeleteFilterViewRequest",
+ "description": "Deletes a filter view from a sheet."
},
- "range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ "insertDimension": {
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
},
- "rows": {
- "description": "The data to write.",
- "items": {
- "$ref": "RowData"
- },
- "type": "array"
+ "deleteRange": {
+ "$ref": "DeleteRangeRequest",
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
},
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DeleteConditionalFormatRuleResponse": {
- "description": "The result of deleting a conditional format rule.",
- "id": "DeleteConditionalFormatRuleResponse",
- "properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule that was deleted."
+ "deleteBanding": {
+ "$ref": "DeleteBandingRequest",
+ "description": "Removes a banded range"
+ },
+ "addFilterView": {
+ "$ref": "AddFilterViewRequest",
+ "description": "Adds a filter view."
+ },
+ "setDataValidation": {
+ "$ref": "SetDataValidationRequest",
+ "description": "Sets data validation for one or more cells."
+ },
+ "updateBorders": {
+ "$ref": "UpdateBordersRequest",
+ "description": "Updates the borders in a range of cells."
+ },
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
+ },
+ "repeatCell": {
+ "$ref": "RepeatCellRequest",
+ "description": "Repeats a single cell across a range."
+ },
+ "clearBasicFilter": {
+ "$ref": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter on a sheet."
+ },
+ "appendDimension": {
+ "$ref": "AppendDimensionRequest",
+ "description": "Appends dimensions to the end of a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
+ },
+ "insertRange": {
+ "$ref": "InsertRangeRequest",
+ "description": "Inserts new cells in a sheet, shifting the existing cells."
+ },
+ "moveDimension": {
+ "$ref": "MoveDimensionRequest",
+ "description": "Moves rows or columns to another location in a sheet."
}
},
"type": "object"
},
- "DeleteRangeRequest": {
- "description": "Deletes a range of cells, shifting other cells into the deleted area.",
- "id": "DeleteRangeRequest",
+ "BooleanCondition": {
+ "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
+ "id": "BooleanCondition",
"properties": {
- "shiftDimension": {
- "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
+ "type": {
+ "description": "The type of condition.",
"enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
+ "CONDITION_TYPE_UNSPECIFIED",
+ "NUMBER_GREATER",
+ "NUMBER_GREATER_THAN_EQ",
+ "NUMBER_LESS",
+ "NUMBER_LESS_THAN_EQ",
+ "NUMBER_EQ",
+ "NUMBER_NOT_EQ",
+ "NUMBER_BETWEEN",
+ "NUMBER_NOT_BETWEEN",
+ "TEXT_CONTAINS",
+ "TEXT_NOT_CONTAINS",
+ "TEXT_STARTS_WITH",
+ "TEXT_ENDS_WITH",
+ "TEXT_EQ",
+ "TEXT_IS_EMAIL",
+ "TEXT_IS_URL",
+ "DATE_EQ",
+ "DATE_BEFORE",
+ "DATE_AFTER",
+ "DATE_ON_OR_BEFORE",
+ "DATE_ON_OR_AFTER",
+ "DATE_BETWEEN",
+ "DATE_NOT_BETWEEN",
+ "DATE_IS_VALID",
+ "ONE_OF_RANGE",
+ "ONE_OF_LIST",
+ "BLANK",
+ "NOT_BLANK",
+ "CUSTOM_FORMULA"
],
"enumDescriptions": [
"The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
+ "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
+ "The cell's value must in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
+ "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue."
],
"type": "string"
},
- "range": {
- "$ref": "GridRange",
- "description": "The range of cells to delete."
+ "values": {
+ "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
+ "items": {
+ "$ref": "ConditionValue"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "GridCoordinate": {
- "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
- "id": "GridCoordinate",
+ "GridRange": {
+ "description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet 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_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\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
+ "id": "GridRange",
"properties": {
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
- },
- "rowIndex": {
- "description": "The row index of the coordinate.",
- "format": "int32",
- "type": "integer"
- },
- "columnIndex": {
- "description": "The column index of the coordinate.",
+ "startColumnIndex": {
+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
"format": "int32",
"type": "integer"
- }
- },
- "type": "object"
- },
- "UpdateSheetPropertiesRequest": {
- "description": "Updates properties of the sheet with the specified\nsheetId.",
- "id": "UpdateSheetPropertiesRequest",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties to update."
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "type": "object"
- },
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "id": "UnmergeCellsRequest",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
- }
- },
- "type": "object"
- },
- "GridProperties": {
- "description": "Properties of a grid.",
- "id": "GridProperties",
- "properties": {
- "rowCount": {
- "description": "The number of rows in the grid.",
+ "sheetId": {
+ "description": "The sheet this range is on.",
"format": "int32",
"type": "integer"
},
- "frozenRowCount": {
- "description": "The number of rows that are frozen in the grid.",
+ "endRowIndex": {
+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
"format": "int32",
"type": "integer"
},
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- },
- "columnCount": {
- "description": "The number of columns in the grid.",
+ "endColumnIndex": {
+ "description": "The end column (exclusive) of the range, or not set if unbounded.",
"format": "int32",
"type": "integer"
},
- "frozenColumnCount": {
- "description": "The number of columns that are frozen in the grid.",
+ "startRowIndex": {
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "Sheet": {
- "description": "A sheet in a spreadsheet.",
- "id": "Sheet",
+ "BasicChartSpec": {
+ "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
+ "id": "BasicChartSpec",
"properties": {
- "bandedRanges": {
- "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "domains": {
+ "description": "The domain of data this is charting.\nOnly a single domain is supported.",
"items": {
- "$ref": "BandedRange"
+ "$ref": "BasicChartDomain"
},
"type": "array"
},
- "charts": {
- "description": "The specifications of every chart on this sheet.",
- "items": {
- "$ref": "EmbeddedChart"
- },
- "type": "array"
+ "lineSmoothing": {
+ "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.",
+ "type": "boolean"
},
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the sheet."
+ "headerCount": {
+ "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
+ "format": "int32",
+ "type": "integer"
},
- "filterViews": {
- "description": "The filter views in this sheet.",
- "items": {
- "$ref": "FilterView"
- },
- "type": "array"
+ "stackedType": {
+ "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
+ "enum": [
+ "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
+ "NOT_STACKED",
+ "STACKED",
+ "PERCENT_STACKED"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Series are not stacked.",
+ "Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.",
+ "Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other."
+ ],
+ "type": "string"
},
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
+ "axis": {
+ "description": "The axis on the chart.",
"items": {
- "$ref": "ConditionalFormatRule"
+ "$ref": "BasicChartAxis"
},
"type": "array"
},
- "protectedRanges": {
- "description": "The protected ranges in this sheet.",
- "items": {
- "$ref": "ProtectedRange"
- },
- "type": "array"
+ "threeDimensional": {
+ "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
+ "type": "boolean"
},
- "basicFilter": {
- "$ref": "BasicFilter",
- "description": "The filter on this sheet, if any."
+ "chartType": {
+ "description": "The type of the chart.",
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A <a href=\"/chart/interactive/docs/gallery/barchart\">bar chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/linechart\">line chart</a>.",
+ "An <a href=\"/chart/interactive/docs/gallery/areachart\">area chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/columnchart\">column chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/scatterchart\">scatter chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/combochart\">combo chart</a>.",
+ "A <a href=\"/chart/interactive/docs/gallery/steppedareachart\">stepped area chart</a>."
+ ],
+ "type": "string"
},
- "merges": {
- "description": "The ranges that are merged together.",
- "items": {
- "$ref": "GridRange"
- },
- "type": "array"
+ "interpolateNulls": {
+ "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
+ "type": "boolean"
},
- "data": {
- "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "series": {
+ "description": "The data this chart is visualizing.",
"items": {
- "$ref": "GridData"
+ "$ref": "BasicChartSeries"
},
"type": "array"
+ },
+ "legendPosition": {
+ "description": "The position of the chart legend.",
+ "enum": [
+ "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "SortSpec": {
- "description": "A sort order associated with a specific column or row.",
- "id": "SortSpec",
+ "BubbleChartSpec": {
+ "description": "A <a href=\"/chart/interactive/docs/gallery/bubblechart\">bubble chart</a>.",
+ "id": "BubbleChartSpec",
"properties": {
- "dimensionIndex": {
- "description": "The dimension the sort should be applied to.",
+ "bubbleOpacity": {
+ "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
+ "format": "float",
+ "type": "number"
+ },
+ "bubbleSizes": {
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional."
+ },
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
+ },
+ "bubbleTextStyle": {
+ "$ref": "TextFormat",
+ "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
+ },
+ "bubbleBorderColor": {
+ "$ref": "Color",
+ "description": "The bubble border color."
+ },
+ "groupIds": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional."
+ },
+ "bubbleLabels": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble labels. These do not need to be unique."
+ },
+ "bubbleMinRadiusSize": {
+ "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
"format": "int32",
"type": "integer"
},
- "sortOrder": {
- "description": "The order data should be sorted.",
+ "bubbleMaxRadiusSize": {
+ "description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
+ },
+ "legendPosition": {
+ "description": "Where the legend of the chart should be drawn.",
"enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
+ "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
],
"enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
],
"type": "string"
}
},
"type": "object"
},
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "id": "UpdateEmbeddedObjectPositionResponse",
- "properties": {
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The new position of the embedded object."
- }
- },
- "type": "object"
- },
- "BooleanRule": {
- "description": "A rule that may or may not match, depending on the condition.",
- "id": "BooleanRule",
+ "SetDataValidationRequest": {
+ "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
+ "id": "SetDataValidationRequest",
"properties": {
- "format": {
- "$ref": "CellFormat",
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
+ "rule": {
+ "$ref": "DataValidationRule",
+ "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
},
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the data validation rule should apply to."
}
},
"type": "object"
},
- "FilterCriteria": {
- "description": "Criteria for showing/hiding rows in a filter or filter view.",
- "id": "FilterCriteria",
+ "CellData": {
+ "description": "Data about a specific cell.",
+ "id": "CellData",
"properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
+ "effectiveValue": {
+ "$ref": "ExtendedValue",
+ "description": "The effective value of the cell. For cells with 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."
+ },
+ "formattedValue": {
+ "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
+ "type": "string"
+ },
+ "textFormatRuns": {
+ "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 next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell 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 erased.",
"items": {
- "type": "string"
+ "$ref": "TextFormatRun"
},
"type": "array"
},
- "condition": {
- "$ref": "BooleanCondition",
- "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.)"
- }
- },
- "type": "object"
- },
- "PivotGroupValueMetadata": {
- "description": "Metadata about a value in a pivot grouping.",
- "id": "PivotGroupValueMetadata",
- "properties": {
- "value": {
+ "hyperlink": {
+ "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
+ "type": "string"
+ },
+ "pivotTable": {
+ "$ref": "PivotTable",
+ "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
+ },
+ "userEnteredFormat": {
+ "$ref": "CellFormat",
+ "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
+ },
+ "note": {
+ "description": "Any note on the cell.",
+ "type": "string"
+ },
+ "effectiveFormat": {
+ "$ref": "CellFormat",
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only."
+ },
+ "userEnteredValue": {
"$ref": "ExtendedValue",
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
+ "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
},
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
+ "dataValidation": {
+ "$ref": "DataValidationRule",
+ "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
}
},
"type": "object"
},
- "Editors": {
- "description": "The editors of a protected range.",
- "id": "Editors",
+ "BatchUpdateSpreadsheetRequest": {
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "id": "BatchUpdateSpreadsheetRequest",
"properties": {
- "users": {
- "description": "The email addresses of users with edit access to the protected range.",
+ "includeSpreadsheetInResponse": {
+ "description": "Determines if the update response should include the spreadsheet\nresource.",
+ "type": "boolean"
+ },
+ "responseRanges": {
+ "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
"items": {
"type": "string"
},
"type": "array"
},
- "groups": {
- "description": "The email addresses of groups with edit access to the protected range.",
+ "responseIncludeGridData": {
+ "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
"items": {
- "type": "string"
+ "$ref": "Request"
},
"type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BasicChartAxis": {
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
+ "id": "BasicChartAxis",
+ "properties": {
+ "position": {
+ "description": "The position of this axis.",
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ],
+ "type": "string"
},
- "domainUsersCanEdit": {
- "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
- "type": "boolean"
+ "title": {
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
+ "type": "string"
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
}
},
"type": "object"
},
- "UpdateConditionalFormatRuleRequest": {
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "id": "UpdateConditionalFormatRuleRequest",
+ "Padding": {
+ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
+ "id": "Padding",
"properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule that should replace the rule at the given index."
+ "right": {
+ "description": "The right padding of the cell.",
+ "format": "int32",
+ "type": "integer"
},
- "index": {
- "description": "The zero-based index of the rule that should be replaced or moved.",
+ "bottom": {
+ "description": "The bottom padding of the cell.",
"format": "int32",
"type": "integer"
},
- "sheetId": {
- "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "top": {
+ "description": "The top padding of the cell.",
"format": "int32",
"type": "integer"
},
- "newIndex": {
- "description": "The zero-based new index the rule should end up at.",
+ "left": {
+ "description": "The left padding of the cell.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
- "BasicChartDomain": {
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
- "id": "BasicChartDomain",
- "properties": {
- "domain": {
- "$ref": "ChartData",
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
- }
- },
- "type": "object"
- },
- "DataValidationRule": {
- "description": "A data validation rule.",
- "id": "DataValidationRule",
+ "DeleteDimensionRequest": {
+ "description": "Deletes the dimensions from the sheet.",
+ "id": "DeleteDimensionRequest",
"properties": {
- "inputMessage": {
- "description": "A message to show the user when adding data to the cell.",
- "type": "string"
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition that data in the cell must match."
- },
- "showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
- },
- "strict": {
- "description": "True if invalid data should be rejected.",
- "type": "boolean"
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to delete from the sheet."
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/slides__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698