| Index: discovery/googleapis/sheets__v4.json
|
| diff --git a/discovery/googleapis/sheets__v4.json b/discovery/googleapis/sheets__v4.json
|
| index 89faac9129900c1212c2e77f97ca4de07464498e..d84bcaec7177d0daabfd1c452d4e427253adc6c3 100644
|
| --- a/discovery/googleapis/sheets__v4.json
|
| +++ b/discovery/googleapis/sheets__v4.json
|
| @@ -37,6 +37,37 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "alt": {
|
| + "default": "json",
|
| + "description": "Data format for response.",
|
| + "enum": [
|
| + "json",
|
| + "media",
|
| + "proto"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Responses with Content-Type of application/json",
|
| + "Media download with context-dependent Content-Type",
|
| + "Responses with Content-Type of application/x-protobuf"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "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.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "pp": {
|
| "default": "true",
|
| "description": "Pretty-print response.",
|
| @@ -64,13 +95,18 @@
|
| "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"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "callback": {
|
| + "description": "JSONP",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -86,42 +122,6 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "alt": {
|
| - "default": "json",
|
| - "description": "Data format for response.",
|
| - "enum": [
|
| - "json",
|
| - "media",
|
| - "proto"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Responses with Content-Type of application/json",
|
| - "Media download with context-dependent Content-Type",
|
| - "Responses with Content-Type of application/x-protobuf"
|
| - ],
|
| - "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -217,103 +217,6 @@
|
| "resources": {
|
| "values": {
|
| "methods": {
|
| - "clear": {
|
| - "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
|
| - "httpMethod": "POST",
|
| - "id": "sheets.spreadsheets.values.clear",
|
| - "parameterOrder": [
|
| - "spreadsheetId",
|
| - "range"
|
| - ],
|
| - "parameters": {
|
| - "spreadsheetId": {
|
| - "description": "The ID of the spreadsheet to update.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "range": {
|
| - "description": "The A1 notation of the values to clear.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
|
| - "request": {
|
| - "$ref": "ClearValuesRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "ClearValuesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/drive",
|
| - "https://www.googleapis.com/auth/drive.file",
|
| - "https://www.googleapis.com/auth/spreadsheets"
|
| - ]
|
| - },
|
| - "batchGet": {
|
| - "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
|
| - "httpMethod": "GET",
|
| - "id": "sheets.spreadsheets.values.batchGet",
|
| - "parameterOrder": [
|
| - "spreadsheetId"
|
| - ],
|
| - "parameters": {
|
| - "majorDimension": {
|
| - "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
|
| - "enum": [
|
| - "DIMENSION_UNSPECIFIED",
|
| - "ROWS",
|
| - "COLUMNS"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "ranges": {
|
| - "description": "The A1 notation of the values to retrieve.",
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| - "spreadsheetId": {
|
| - "description": "The ID of the spreadsheet to retrieve data from.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "dateTimeRenderOption": {
|
| - "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
|
| - "enum": [
|
| - "SERIAL_NUMBER",
|
| - "FORMATTED_STRING"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "valueRenderOption": {
|
| - "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
|
| - "enum": [
|
| - "FORMATTED_VALUE",
|
| - "UNFORMATTED_VALUE",
|
| - "FORMULA"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
|
| - "response": {
|
| - "$ref": "BatchGetValuesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/drive",
|
| - "https://www.googleapis.com/auth/drive.file",
|
| - "https://www.googleapis.com/auth/drive.readonly",
|
| - "https://www.googleapis.com/auth/spreadsheets",
|
| - "https://www.googleapis.com/auth/spreadsheets.readonly"
|
| - ]
|
| - },
|
| "append": {
|
| "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
|
| "httpMethod": "POST",
|
| @@ -429,6 +332,12 @@
|
| "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",
|
| @@ -463,12 +372,6 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "spreadsheetId": {
|
| - "description": "The ID of the spreadsheet to retrieve data from.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
|
| @@ -492,6 +395,12 @@
|
| "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": [
|
| @@ -521,22 +430,16 @@
|
| "location": "query",
|
| "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"
|
| - },
|
| "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",
|
| - "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}",
|
| @@ -579,69 +482,336 @@
|
| "https://www.googleapis.com/auth/drive.file",
|
| "https://www.googleapis.com/auth/spreadsheets"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "sheets": {
|
| - "methods": {
|
| - "copyTo": {
|
| - "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
|
| + },
|
| + "clear": {
|
| + "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
|
| "httpMethod": "POST",
|
| - "id": "sheets.spreadsheets.sheets.copyTo",
|
| + "id": "sheets.spreadsheets.values.clear",
|
| "parameterOrder": [
|
| "spreadsheetId",
|
| - "sheetId"
|
| + "range"
|
| ],
|
| "parameters": {
|
| "spreadsheetId": {
|
| - "description": "The ID of the spreadsheet containing the sheet to copy.",
|
| + "description": "The ID of the spreadsheet to update.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "sheetId": {
|
| - "description": "The ID of the sheet to copy.",
|
| - "format": "int32",
|
| + "range": {
|
| + "description": "The A1 notation of the values to clear.",
|
| "location": "path",
|
| "required": true,
|
| - "type": "integer"
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
|
| + "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
|
| "request": {
|
| - "$ref": "CopySheetToAnotherSpreadsheetRequest"
|
| + "$ref": "ClearValuesRequest"
|
| },
|
| "response": {
|
| - "$ref": "SheetProperties"
|
| + "$ref": "ClearValuesResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/drive",
|
| "https://www.googleapis.com/auth/drive.file",
|
| "https://www.googleapis.com/auth/spreadsheets"
|
| ]
|
| - }
|
| - }
|
| - }
|
| - }
|
| - }
|
| - },
|
| - "revision": "20170801",
|
| - "rootUrl": "https://sheets.googleapis.com/",
|
| - "schemas": {
|
| - "UpdateConditionalFormatRuleResponse": {
|
| - "description": "The result of updating a conditional format rule.",
|
| - "id": "UpdateConditionalFormatRuleResponse",
|
| - "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"
|
| - },
|
| - "newRule": {
|
| + },
|
| + "batchGet": {
|
| + "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
|
| + "httpMethod": "GET",
|
| + "id": "sheets.spreadsheets.values.batchGet",
|
| + "parameterOrder": [
|
| + "spreadsheetId"
|
| + ],
|
| + "parameters": {
|
| + "majorDimension": {
|
| + "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
|
| + "enum": [
|
| + "DIMENSION_UNSPECIFIED",
|
| + "ROWS",
|
| + "COLUMNS"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "ranges": {
|
| + "description": "The A1 notation of the values to retrieve.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "spreadsheetId": {
|
| + "description": "The ID of the spreadsheet to retrieve data from.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "dateTimeRenderOption": {
|
| + "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
|
| + "enum": [
|
| + "SERIAL_NUMBER",
|
| + "FORMATTED_STRING"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "valueRenderOption": {
|
| + "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
|
| + "enum": [
|
| + "FORMATTED_VALUE",
|
| + "UNFORMATTED_VALUE",
|
| + "FORMULA"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
|
| + "response": {
|
| + "$ref": "BatchGetValuesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/drive",
|
| + "https://www.googleapis.com/auth/drive.file",
|
| + "https://www.googleapis.com/auth/drive.readonly",
|
| + "https://www.googleapis.com/auth/spreadsheets",
|
| + "https://www.googleapis.com/auth/spreadsheets.readonly"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "sheets": {
|
| + "methods": {
|
| + "copyTo": {
|
| + "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
|
| + "httpMethod": "POST",
|
| + "id": "sheets.spreadsheets.sheets.copyTo",
|
| + "parameterOrder": [
|
| + "spreadsheetId",
|
| + "sheetId"
|
| + ],
|
| + "parameters": {
|
| + "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",
|
| + "request": {
|
| + "$ref": "CopySheetToAnotherSpreadsheetRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "SheetProperties"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/drive",
|
| + "https://www.googleapis.com/auth/drive.file",
|
| + "https://www.googleapis.com/auth/spreadsheets"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "revision": "20170831",
|
| + "rootUrl": "https://sheets.googleapis.com/",
|
| + "schemas": {
|
| + "DeleteProtectedRangeRequest": {
|
| + "description": "Deletes the protected range with the given ID.",
|
| + "id": "DeleteProtectedRangeRequest",
|
| + "properties": {
|
| + "protectedRangeId": {
|
| + "description": "The ID of the protected range to delete.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AutoFillRequest": {
|
| + "description": "Fills in more data based on existing data.",
|
| + "id": "AutoFillRequest",
|
| + "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."
|
| + },
|
| + "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"
|
| + },
|
| + "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."
|
| + }
|
| + },
|
| + "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",
|
| + "properties": {
|
| + "maxpoint": {
|
| + "$ref": "InterpolationPoint",
|
| + "description": "The final interpolation point."
|
| + },
|
| + "minpoint": {
|
| + "$ref": "InterpolationPoint",
|
| + "description": "The starting interpolation point."
|
| + },
|
| + "midpoint": {
|
| + "$ref": "InterpolationPoint",
|
| + "description": "An optional midway interpolation point."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SetBasicFilterRequest": {
|
| + "description": "Sets the basic filter associated with a sheet.",
|
| + "id": "SetBasicFilterRequest",
|
| + "properties": {
|
| + "filter": {
|
| + "$ref": "BasicFilter",
|
| + "description": "The filter to set."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "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": {
|
| + "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"
|
| + },
|
| + "value": {
|
| + "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DeleteEmbeddedObjectRequest": {
|
| + "description": "Deletes the embedded object with the given ID.",
|
| + "id": "DeleteEmbeddedObjectRequest",
|
| + "properties": {
|
| + "objectId": {
|
| + "description": "The ID of the embedded object to delete.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FindReplaceResponse": {
|
| + "description": "The result of the find/replace.",
|
| + "id": "FindReplaceResponse",
|
| + "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"
|
| + },
|
| + "sheetsChanged": {
|
| + "description": "The number of sheets changed.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "formulasChanged": {
|
| + "description": "The number of formula cells changed.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "valuesChanged": {
|
| + "description": "The number of non-formula cells changed.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DeleteSheetRequest": {
|
| + "description": "Deletes the requested sheet.",
|
| + "id": "DeleteSheetRequest",
|
| + "properties": {
|
| + "sheetId": {
|
| + "description": "The ID of the sheet to delete.",
|
| + "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"
|
| + },
|
| + "UpdateConditionalFormatRuleResponse": {
|
| + "description": "The result of updating a conditional format rule.",
|
| + "id": "UpdateConditionalFormatRuleResponse",
|
| + "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"
|
| + },
|
| + "newRule": {
|
| "$ref": "ConditionalFormatRule",
|
| "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
|
| },
|
| @@ -690,6 +860,16 @@
|
| "description": "Duplicates the contents of a sheet.",
|
| "id": "DuplicateSheetRequest",
|
| "properties": {
|
| + "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"
|
| + },
|
| "newSheetName": {
|
| "description": "The name of the new sheet. If empty, a new name is chosen for you.",
|
| "type": "string"
|
| @@ -698,55 +878,91 @@
|
| "description": "The sheet to duplicate.",
|
| "format": "int32",
|
| "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ExtendedValue": {
|
| + "description": "The kinds of value that a cell in a spreadsheet can have.",
|
| + "id": "ExtendedValue",
|
| + "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"
|
| },
|
| - "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"
|
| + "errorValue": {
|
| + "$ref": "ErrorValue",
|
| + "description": "Represents an error.\nThis field is read-only."
|
| },
|
| - "insertSheetIndex": {
|
| - "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
|
| + "formulaValue": {
|
| + "description": "Represents a formula.",
|
| + "type": "string"
|
| + },
|
| + "boolValue": {
|
| + "description": "Represents a boolean value.",
|
| + "type": "boolean"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BandedRange": {
|
| + "description": "A banded (alternating colors) range in a sheet.",
|
| + "id": "BandedRange",
|
| + "properties": {
|
| + "range": {
|
| + "$ref": "GridRange",
|
| + "description": "The range over which these properties are applied."
|
| + },
|
| + "bandedRangeId": {
|
| + "description": "The id of the banded range.",
|
| "format": "int32",
|
| "type": "integer"
|
| + },
|
| + "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."
|
| + },
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ExtendedValue": {
|
| - "description": "The kinds of value that a cell in a spreadsheet can have.",
|
| - "id": "ExtendedValue",
|
| + "HistogramSeries": {
|
| + "description": "A histogram series containing the series color and data.",
|
| + "id": "HistogramSeries",
|
| "properties": {
|
| - "formulaValue": {
|
| - "description": "Represents a formula.",
|
| - "type": "string"
|
| - },
|
| - "boolValue": {
|
| - "description": "Represents a boolean value.",
|
| - "type": "boolean"
|
| - },
|
| - "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"
|
| - },
|
| - "numberValue": {
|
| - "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "data": {
|
| + "$ref": "ChartData",
|
| + "description": "The data for this histogram series."
|
| },
|
| - "errorValue": {
|
| - "$ref": "ErrorValue",
|
| - "description": "Represents an error.\nThis field is read-only."
|
| + "barColor": {
|
| + "$ref": "Color",
|
| + "description": "The color of the column representing this series in each bucket.\nThis field is optional."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AddChartRequest": {
|
| - "description": "Adds a chart to a sheet in the spreadsheet.",
|
| - "id": "AddChartRequest",
|
| + "BatchClearValuesResponse": {
|
| + "description": "The response when clearing a range of values in a spreadsheet.",
|
| + "id": "BatchClearValuesResponse",
|
| "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.)"
|
| + "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"
|
| + },
|
| + "spreadsheetId": {
|
| + "description": "The spreadsheet the updates were applied to.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -755,10 +971,6 @@
|
| "description": "Resource that represents a spreadsheet.",
|
| "id": "Spreadsheet",
|
| "properties": {
|
| - "spreadsheetUrl": {
|
| - "description": "The url of the spreadsheet.\nThis field is read-only.",
|
| - "type": "string"
|
| - },
|
| "properties": {
|
| "$ref": "SpreadsheetProperties",
|
| "description": "Overall properties of a spreadsheet."
|
| @@ -780,63 +992,21 @@
|
| "spreadsheetId": {
|
| "description": "The ID of the spreadsheet.\nThis field is read-only.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "BatchClearValuesResponse": {
|
| - "description": "The response when clearing a range of values in a spreadsheet.",
|
| - "id": "BatchClearValuesResponse",
|
| - "properties": {
|
| - "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"
|
| },
|
| - "spreadsheetId": {
|
| - "description": "The spreadsheet the updates were applied to.",
|
| + "spreadsheetUrl": {
|
| + "description": "The url of the spreadsheet.\nThis field is read-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "HistogramSeries": {
|
| - "description": "A histogram series containing the series color and data.",
|
| - "id": "HistogramSeries",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "BandedRange": {
|
| - "description": "A banded (alternating colors) range in a sheet.",
|
| - "id": "BandedRange",
|
| + "AddChartRequest": {
|
| + "description": "Adds a chart to a sheet in the spreadsheet.",
|
| + "id": "AddChartRequest",
|
| "properties": {
|
| - "range": {
|
| - "$ref": "GridRange",
|
| - "description": "The range over which these properties are applied."
|
| - },
|
| - "bandedRangeId": {
|
| - "description": "The id of the banded range.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "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."
|
| - },
|
| - "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."
|
| + "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"
|
| @@ -861,14 +1031,18 @@
|
| "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
|
| "id": "TextFormat",
|
| "properties": {
|
| - "bold": {
|
| - "description": "True if the text is bold.",
|
| + "underline": {
|
| + "description": "True if the text is underlined.",
|
| "type": "boolean"
|
| },
|
| "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"
|
| @@ -885,10 +1059,6 @@
|
| "description": "The size of the font.",
|
| "format": "int32",
|
| "type": "integer"
|
| - },
|
| - "underline": {
|
| - "description": "True if the text is underlined.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -919,15 +1089,15 @@
|
| "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
|
| "id": "IterativeCalculationSettings",
|
| "properties": {
|
| - "maxIterations": {
|
| - "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -936,26 +1106,6 @@
|
| "description": "Properties of a spreadsheet.",
|
| "id": "SpreadsheetProperties",
|
| "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"
|
| @@ -971,6 +1121,26 @@
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -979,11 +1149,6 @@
|
| "description": "The location an object is overlaid on top of a grid.",
|
| "id": "OverlayPosition",
|
| "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",
|
| @@ -1002,6 +1167,11 @@
|
| "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
|
| "format": "int32",
|
| "type": "integer"
|
| + },
|
| + "widthPixels": {
|
| + "description": "The width of the object, in pixels. Defaults to 600.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1041,13 +1211,13 @@
|
| "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"
|
| - },
|
| "range": {
|
| "$ref": "DimensionRange",
|
| "description": "The dimensions to insert. Both the start and end indexes must be bounded."
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1056,14 +1226,14 @@
|
| "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"
|
| - },
|
| - "properties": {
|
| - "$ref": "SpreadsheetProperties",
|
| - "description": "The properties to update."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1130,18 +1300,6 @@
|
| "description": "A protected range.",
|
| "id": "ProtectedRange",
|
| "properties": {
|
| - "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": {
|
| @@ -1165,6 +1323,18 @@
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1193,10 +1363,6 @@
|
| "description": "A named range.",
|
| "id": "NamedRange",
|
| "properties": {
|
| - "name": {
|
| - "description": "The name of the named range.",
|
| - "type": "string"
|
| - },
|
| "namedRangeId": {
|
| "description": "The ID of the named range.",
|
| "type": "string"
|
| @@ -1204,6 +1370,10 @@
|
| "range": {
|
| "$ref": "GridRange",
|
| "description": "The range this represents."
|
| + },
|
| + "name": {
|
| + "description": "The name of the named range.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1212,6 +1382,20 @@
|
| "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": {
|
| + "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"
|
| + },
|
| "endIndex": {
|
| "description": "The end (exclusive) of the span, or not set if unbounded.",
|
| "format": "int32",
|
| @@ -1226,20 +1410,6 @@
|
| "description": "The sheet this span is on.",
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1285,10 +1455,6 @@
|
| "description": "The borders of the cell.",
|
| "id": "Borders",
|
| "properties": {
|
| - "right": {
|
| - "$ref": "Border",
|
| - "description": "The right border of the cell."
|
| - },
|
| "bottom": {
|
| "$ref": "Border",
|
| "description": "The bottom border of the cell."
|
| @@ -1300,6 +1466,10 @@
|
| "left": {
|
| "$ref": "Border",
|
| "description": "The left border of the cell."
|
| + },
|
| + "right": {
|
| + "$ref": "Border",
|
| + "description": "The right border of the cell."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1361,7 +1531,7 @@
|
| "properties": {
|
| "dimensions": {
|
| "$ref": "DimensionRange",
|
| - "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported."
|
| + "description": "The dimensions to automatically resize."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1370,6 +1540,10 @@
|
| "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": {
|
| + "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."
|
| @@ -1393,10 +1567,6 @@
|
| "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1405,19 +1575,9 @@
|
| "description": "The format of a cell.",
|
| "id": "CellFormat",
|
| "properties": {
|
| - "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"
|
| + "numberFormat": {
|
| + "$ref": "NumberFormat",
|
| + "description": "A format describing how number values should be represented to the user."
|
| },
|
| "horizontalAlignment": {
|
| "description": "The horizontal alignment of the value in the cell.",
|
| @@ -1435,6 +1595,20 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "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"
|
| + },
|
| "textFormat": {
|
| "$ref": "TextFormat",
|
| "description": "The format of the text in the cell (unless overridden by a format run)."
|
| @@ -1443,6 +1617,10 @@
|
| "$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.",
|
| "enum": [
|
| @@ -1459,10 +1637,6 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "padding": {
|
| - "$ref": "Padding",
|
| - "description": "The padding of the cell."
|
| - },
|
| "textDirection": {
|
| "description": "The direction of the text in the cell.",
|
| "enum": [
|
| @@ -1481,10 +1655,6 @@
|
| "$ref": "Borders",
|
| "description": "The borders of the cell."
|
| },
|
| - "textRotation": {
|
| - "$ref": "TextRotation",
|
| - "description": "The rotation applied to text in a cell"
|
| - },
|
| "wrapStrategy": {
|
| "description": "The wrap strategy for the value in the cell.",
|
| "enum": [
|
| @@ -1503,9 +1673,9 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "numberFormat": {
|
| - "$ref": "NumberFormat",
|
| - "description": "A format describing how number values should be represented to the user."
|
| + "textRotation": {
|
| + "$ref": "TextRotation",
|
| + "description": "The rotation applied to text in a cell"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1514,13 +1684,13 @@
|
| "description": "The response when clearing a range of values in a spreadsheet.",
|
| "id": "ClearValuesResponse",
|
| "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"
|
| + },
|
| + "spreadsheetId": {
|
| + "description": "The spreadsheet the updates were applied to.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1579,16 +1749,16 @@
|
| "description": "The response when retrieving more than one range of values in a spreadsheet.",
|
| "id": "BatchGetValuesResponse",
|
| "properties": {
|
| - "spreadsheetId": {
|
| - "description": "The ID of the spreadsheet the data was retrieved from.",
|
| - "type": "string"
|
| - },
|
| "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"
|
| + },
|
| + "spreadsheetId": {
|
| + "description": "The ID of the spreadsheet the data was retrieved from.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1613,11 +1783,6 @@
|
| "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": {
|
| - "red": {
|
| - "description": "The amount of red in the color as a value in the interval [0, 1].",
|
| - "format": "float",
|
| - "type": "number"
|
| - },
|
| "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",
|
| @@ -1632,6 +1797,11 @@
|
| "description": "The amount of green in the color as a value in the interval [0, 1].",
|
| "format": "float",
|
| "type": "number"
|
| + },
|
| + "red": {
|
| + "description": "The amount of red in the color as a value in the interval [0, 1].",
|
| + "format": "float",
|
| + "type": "number"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1640,6 +1810,10 @@
|
| "description": "A single grouping (either row or column) in a pivot table.",
|
| "id": "PivotGroup",
|
| "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."
|
| + },
|
| "valueMetadata": {
|
| "description": "Metadata about values in the grouping.",
|
| "items": {
|
| @@ -1669,10 +1843,6 @@
|
| "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"
|
| @@ -1816,10 +1986,6 @@
|
| "description": "A single response from an update.",
|
| "id": "Response",
|
| "properties": {
|
| - "duplicateSheet": {
|
| - "$ref": "DuplicateSheetResponse",
|
| - "description": "A reply from duplicating a sheet."
|
| - },
|
| "updateEmbeddedObjectPosition": {
|
| "$ref": "UpdateEmbeddedObjectPositionResponse",
|
| "description": "A reply from updating an embedded object's position."
|
| @@ -1863,6 +2029,10 @@
|
| "addProtectedRange": {
|
| "$ref": "AddProtectedRangeResponse",
|
| "description": "A reply from adding a protected range."
|
| + },
|
| + "duplicateSheet": {
|
| + "$ref": "DuplicateSheetResponse",
|
| + "description": "A reply from duplicating a sheet."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1871,6 +2041,10 @@
|
| "description": "A chart embedded in a sheet.",
|
| "id": "EmbeddedChart",
|
| "properties": {
|
| + "spec": {
|
| + "$ref": "ChartSpec",
|
| + "description": "The specification of the chart."
|
| + },
|
| "chartId": {
|
| "description": "The ID of the chart.",
|
| "format": "int32",
|
| @@ -1879,10 +2053,6 @@
|
| "position": {
|
| "$ref": "EmbeddedObjectPosition",
|
| "description": "The position of the chart."
|
| - },
|
| - "spec": {
|
| - "$ref": "ChartSpec",
|
| - "description": "The specification of the chart."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1953,15 +2123,48 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Border": {
|
| - "description": "A border along a cell.",
|
| - "id": "Border",
|
| + "GridData": {
|
| + "description": "Data in the grid, as well as metadata about the dimensions.",
|
| + "id": "GridData",
|
| "properties": {
|
| - "width": {
|
| - "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
|
| + "startRow": {
|
| + "description": "The first row this GridData refers to, zero-based.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Border": {
|
| + "description": "A border along a cell.",
|
| + "id": "Border",
|
| + "properties": {
|
| "style": {
|
| "description": "The style of the border.",
|
| "enum": [
|
| @@ -1989,42 +2192,9 @@
|
| "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": {
|
| - "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"
|
| - },
|
| - "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.",
|
| + "width": {
|
| + "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
|
| "format": "int32",
|
| "type": "integer"
|
| }
|
| @@ -2035,6 +2205,14 @@
|
| "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
|
| "id": "FindReplaceRequest",
|
| "properties": {
|
| + "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"
|
| @@ -2043,14 +2221,14 @@
|
| "description": "True if the find value should match the entire cell.",
|
| "type": "boolean"
|
| },
|
| - "find": {
|
| - "description": "The value to search.",
|
| - "type": "string"
|
| - },
|
| "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"
|
| },
|
| + "find": {
|
| + "description": "The value to search.",
|
| + "type": "string"
|
| + },
|
| "replacement": {
|
| "description": "The value to use as the replacement.",
|
| "type": "string"
|
| @@ -2063,14 +2241,6 @@
|
| "description": "The sheet to find/replace over.",
|
| "format": "int32",
|
| "type": "integer"
|
| - },
|
| - "allSheets": {
|
| - "description": "True to find/replace over all sheets.",
|
| - "type": "boolean"
|
| - },
|
| - "matchCase": {
|
| - "description": "True if the search is case sensitive.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2106,10 +2276,6 @@
|
| "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."
|
| - },
|
| "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."
|
| @@ -2125,28 +2291,32 @@
|
| "$ref": "RowData"
|
| },
|
| "type": "array"
|
| + },
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DeleteConditionalFormatRuleResponse": {
|
| - "description": "The result of deleting a conditional format rule.",
|
| - "id": "DeleteConditionalFormatRuleResponse",
|
| + "RandomizeRangeRequest": {
|
| + "description": "Randomizes the order of the rows in a range.",
|
| + "id": "RandomizeRangeRequest",
|
| "properties": {
|
| - "rule": {
|
| - "$ref": "ConditionalFormatRule",
|
| - "description": "The rule that was deleted."
|
| + "range": {
|
| + "$ref": "GridRange",
|
| + "description": "The range to randomize."
|
| }
|
| },
|
| "type": "object"
|
| - },
|
| - "RandomizeRangeRequest": {
|
| - "description": "Randomizes the order of the rows in a range.",
|
| - "id": "RandomizeRangeRequest",
|
| + },
|
| + "DeleteConditionalFormatRuleResponse": {
|
| + "description": "The result of deleting a conditional format rule.",
|
| + "id": "DeleteConditionalFormatRuleResponse",
|
| "properties": {
|
| - "range": {
|
| - "$ref": "GridRange",
|
| - "description": "The range to randomize."
|
| + "rule": {
|
| + "$ref": "ConditionalFormatRule",
|
| + "description": "The rule that was deleted."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2202,14 +2372,14 @@
|
| "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"
|
| - },
|
| - "properties": {
|
| - "$ref": "SheetProperties",
|
| - "description": "The properties to update."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2297,6 +2467,10 @@
|
| "description": "A sheet in a spreadsheet.",
|
| "id": "Sheet",
|
| "properties": {
|
| + "basicFilter": {
|
| + "$ref": "BasicFilter",
|
| + "description": "The filter on this sheet, if any."
|
| + },
|
| "merges": {
|
| "description": "The ranges that are merged together.",
|
| "items": {
|
| @@ -2318,6 +2492,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "properties": {
|
| + "$ref": "SheetProperties",
|
| + "description": "The properties of the sheet."
|
| + },
|
| "charts": {
|
| "description": "The specifications of every chart on this sheet.",
|
| "items": {
|
| @@ -2325,10 +2503,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "properties": {
|
| - "$ref": "SheetProperties",
|
| - "description": "The properties of the sheet."
|
| - },
|
| "filterViews": {
|
| "description": "The filter views in this sheet.",
|
| "items": {
|
| @@ -2349,10 +2523,6 @@
|
| "$ref": "ProtectedRange"
|
| },
|
| "type": "array"
|
| - },
|
| - "basicFilter": {
|
| - "$ref": "BasicFilter",
|
| - "description": "The filter on this sheet, if any."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2361,13 +2531,13 @@
|
| "description": "A rule that may or may not match, depending on the condition.",
|
| "id": "BooleanRule",
|
| "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."
|
| - },
|
| "condition": {
|
| "$ref": "BooleanCondition",
|
| "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
|
| + },
|
| + "format": {
|
| + "$ref": "CellFormat",
|
| + "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2456,10 +2626,29 @@
|
| },
|
| "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."
|
| + },
|
| + "reversed": {
|
| + "description": "True to reverse the order of the domain values (horizontal axis).",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "DataValidationRule": {
|
| "description": "A data validation rule.",
|
| "id": "DataValidationRule",
|
| "properties": {
|
| + "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"
|
| @@ -2471,25 +2660,6 @@
|
| "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"
|
| - }
|
| - },
|
| - "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."
|
| - },
|
| - "reversed": {
|
| - "description": "True to reverse the order of the domain values (horizontal axis).",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2498,6 +2668,14 @@
|
| "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
|
| "id": "PasteDataRequest",
|
| "properties": {
|
| + "delimiter": {
|
| + "description": "The delimiter in the data.",
|
| + "type": "string"
|
| + },
|
| + "data": {
|
| + "description": "The data to insert.",
|
| + "type": "string"
|
| + },
|
| "type": {
|
| "description": "How the data should be pasted.",
|
| "enum": [
|
| @@ -2527,14 +2705,6 @@
|
| "coordinate": {
|
| "$ref": "GridCoordinate",
|
| "description": "The coordinate at which the data should start being inserted."
|
| - },
|
| - "delimiter": {
|
| - "description": "The delimiter in the data.",
|
| - "type": "string"
|
| - },
|
| - "data": {
|
| - "description": "The data to insert.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2622,6 +2792,18 @@
|
| "description": "A <a href=\"/chart/interactive/docs/gallery/piechart\">pie chart</a>.",
|
| "id": "PieChartSpec",
|
| "properties": {
|
| + "threeDimensional": {
|
| + "description": "True if the pie is three dimensional.",
|
| + "type": "boolean"
|
| + },
|
| + "domain": {
|
| + "$ref": "ChartData",
|
| + "description": "The data that covers the domain of the pie chart."
|
| + },
|
| + "series": {
|
| + "$ref": "ChartData",
|
| + "description": "The data that covers the one and only series of the pie chart."
|
| + },
|
| "pieHole": {
|
| "description": "The size of the hole in the pie chart.",
|
| "format": "double",
|
| @@ -2648,18 +2830,6 @@
|
| "Each pie slice has a label attached to it."
|
| ],
|
| "type": "string"
|
| - },
|
| - "threeDimensional": {
|
| - "description": "True if the pie is three dimensional.",
|
| - "type": "boolean"
|
| - },
|
| - "domain": {
|
| - "$ref": "ChartData",
|
| - "description": "The data that covers the domain of the pie chart."
|
| - },
|
| - "series": {
|
| - "$ref": "ChartData",
|
| - "description": "The data that covers the one and only series of the pie chart."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2684,6 +2854,13 @@
|
| "description": "A rule describing a conditional format.",
|
| "id": "ConditionalFormatRule",
|
| "properties": {
|
| + "ranges": {
|
| + "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
|
| + "items": {
|
| + "$ref": "GridRange"
|
| + },
|
| + "type": "array"
|
| + },
|
| "gradientRule": {
|
| "$ref": "GradientRule",
|
| "description": "The formatting will vary based on the gradients in the rule."
|
| @@ -2691,13 +2868,6 @@
|
| "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.",
|
| - "items": {
|
| - "$ref": "GridRange"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2751,98 +2921,70 @@
|
| },
|
| "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",
|
| - "properties": {
|
| - "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": {
|
| - "description": "The type of condition.",
|
| - "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"
|
| - ],
|
| - "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."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "Request": {
|
| "description": "A single kind of update to apply to a spreadsheet.",
|
| "id": "Request",
|
| "properties": {
|
| - "deleteFilterView": {
|
| - "$ref": "DeleteFilterViewRequest",
|
| - "description": "Deletes a filter view from a sheet."
|
| + "updateNamedRange": {
|
| + "$ref": "UpdateNamedRangeRequest",
|
| + "description": "Updates a named range."
|
| + },
|
| + "updateSheetProperties": {
|
| + "$ref": "UpdateSheetPropertiesRequest",
|
| + "description": "Updates a sheet's properties."
|
| + },
|
| + "deleteDimension": {
|
| + "$ref": "DeleteDimensionRequest",
|
| + "description": "Deletes rows or columns in a sheet."
|
| + },
|
| + "autoFill": {
|
| + "$ref": "AutoFillRequest",
|
| + "description": "Automatically fills in more data based on existing data."
|
| + },
|
| + "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."
|
| + },
|
| + "addChart": {
|
| + "$ref": "AddChartRequest",
|
| + "description": "Adds a chart."
|
| + },
|
| + "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."
|
| @@ -2871,14 +3013,14 @@
|
| "$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."
|
| },
|
| + "clearBasicFilter": {
|
| + "$ref": "ClearBasicFilterRequest",
|
| + "description": "Clears the basic filter on a sheet."
|
| + },
|
| "appendDimension": {
|
| "$ref": "AppendDimensionRequest",
|
| "description": "Appends dimensions to the end of a sheet."
|
| @@ -2915,14 +3057,14 @@
|
| "$ref": "DuplicateSheetRequest",
|
| "description": "Duplicates a sheet."
|
| },
|
| - "deleteSheet": {
|
| - "$ref": "DeleteSheetRequest",
|
| - "description": "Deletes 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."
|
| @@ -2982,58 +3124,86 @@
|
| "mergeCells": {
|
| "$ref": "MergeCellsRequest",
|
| "description": "Merges cells together."
|
| + }
|
| + },
|
| + "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",
|
| + "properties": {
|
| + "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"
|
| },
|
| - "updateNamedRange": {
|
| - "$ref": "UpdateNamedRangeRequest",
|
| - "description": "Updates a named range."
|
| - },
|
| - "updateSheetProperties": {
|
| - "$ref": "UpdateSheetPropertiesRequest",
|
| - "description": "Updates a sheet's properties."
|
| - },
|
| - "autoFill": {
|
| - "$ref": "AutoFillRequest",
|
| - "description": "Automatically fills in more data based on existing data."
|
| - },
|
| - "deleteDimension": {
|
| - "$ref": "DeleteDimensionRequest",
|
| - "description": "Deletes rows or columns in a sheet."
|
| - },
|
| - "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."
|
| - },
|
| - "addChart": {
|
| - "$ref": "AddChartRequest",
|
| - "description": "Adds a chart."
|
| - },
|
| - "findReplace": {
|
| - "$ref": "FindReplaceRequest",
|
| - "description": "Finds and replaces occurrences of some text with other text."
|
| - },
|
| - "textToColumns": {
|
| - "$ref": "TextToColumnsRequest",
|
| - "description": "Converts a column of text into many columns of text."
|
| - },
|
| - "updateChartSpec": {
|
| - "$ref": "UpdateChartSpecRequest",
|
| - "description": "Updates a chart's specifications."
|
| - },
|
| - "addSheet": {
|
| - "$ref": "AddSheetRequest",
|
| - "description": "Adds a sheet."
|
| - },
|
| - "updateProtectedRange": {
|
| - "$ref": "UpdateProtectedRangeRequest",
|
| - "description": "Updates a protected range."
|
| + "type": {
|
| + "description": "The type of condition.",
|
| + "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"
|
| + ],
|
| + "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."
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3042,16 +3212,6 @@
|
| "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": {
|
| - "startColumnIndex": {
|
| - "description": "The start column (inclusive) of the range, or not set if unbounded.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "sheetId": {
|
| - "description": "The sheet this range is on.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| "endColumnIndex": {
|
| "description": "The end column (exclusive) of the range, or not set if unbounded.",
|
| "format": "int32",
|
| @@ -3066,6 +3226,16 @@
|
| "description": "The start row (inclusive) of the range, or not set if unbounded.",
|
| "format": "int32",
|
| "type": "integer"
|
| + },
|
| + "startColumnIndex": {
|
| + "description": "The start column (inclusive) of the range, or not set if unbounded.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "sheetId": {
|
| + "description": "The sheet this range is on.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3117,10 +3287,6 @@
|
| },
|
| "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"
|
| - },
|
| "chartType": {
|
| "description": "The type of the chart.",
|
| "enum": [
|
| @@ -3145,6 +3311,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "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"
|
| + },
|
| "series": {
|
| "description": "The data this chart is visualizing.",
|
| "items": {
|
| @@ -3194,20 +3364,6 @@
|
| "description": "A <a href=\"/chart/interactive/docs/gallery/bubblechart\">bubble chart</a>.",
|
| "id": "BubbleChartSpec",
|
| "properties": {
|
| - "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"
|
| - },
|
| - "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."
|
| @@ -3234,15 +3390,15 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "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."
|
| - },
|
| "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."
|
| @@ -3258,6 +3414,20 @@
|
| "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"
|
| + },
|
| + "bubbleMaxRadiusSize": {
|
| + "description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3266,34 +3436,34 @@
|
| "description": "Data about a specific cell.",
|
| "id": "CellData",
|
| "properties": {
|
| + "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."
|
| },
|
| - "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."
|
| - },
|
| "note": {
|
| "description": "Any note on the cell.",
|
| "type": "string"
|
| },
|
| - "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."
|
| + "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."
|
| },
|
| - "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": {
|
| @@ -3301,13 +3471,13 @@
|
| },
|
| "type": "array"
|
| },
|
| + "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"
|
| + },
|
| "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -3341,14 +3511,37 @@
|
| },
|
| "type": "object"
|
| },
|
| + "Padding": {
|
| + "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
|
| + "id": "Padding",
|
| + "properties": {
|
| + "right": {
|
| + "description": "The right padding of the cell.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "bottom": {
|
| + "description": "The bottom padding of the cell.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "top": {
|
| + "description": "The top padding of the cell.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "left": {
|
| + "description": "The left padding of the cell.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "BasicChartAxis": {
|
| "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
|
| "id": "BasicChartAxis",
|
| "properties": {
|
| - "format": {
|
| - "$ref": "TextFormat",
|
| - "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
|
| - },
|
| "title": {
|
| "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
|
| "type": "string"
|
| @@ -3368,33 +3561,10 @@
|
| "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Padding": {
|
| - "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
|
| - "id": "Padding",
|
| - "properties": {
|
| - "top": {
|
| - "description": "The top padding of the cell.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "left": {
|
| - "description": "The left padding of the cell.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| },
|
| - "right": {
|
| - "description": "The right padding of the cell.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "bottom": {
|
| - "description": "The bottom padding of the cell.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "format": {
|
| + "$ref": "TextFormat",
|
| + "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
|
| }
|
| },
|
| "type": "object"
|
| @@ -3498,10 +3668,6 @@
|
| "description": "Merges all cells in the range.",
|
| "id": "MergeCellsRequest",
|
| "properties": {
|
| - "range": {
|
| - "$ref": "GridRange",
|
| - "description": "The range of cells to merge."
|
| - },
|
| "mergeType": {
|
| "description": "How the cells should be merged.",
|
| "enum": [
|
| @@ -3515,6 +3681,10 @@
|
| "Create a merge for each row in the range"
|
| ],
|
| "type": "string"
|
| + },
|
| + "range": {
|
| + "$ref": "GridRange",
|
| + "description": "The range of cells to merge."
|
| }
|
| },
|
| "type": "object"
|
| @@ -3566,6 +3736,18 @@
|
| },
|
| "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",
|
| @@ -3601,18 +3783,6 @@
|
| },
|
| "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"
|
| - },
|
| "DeleteBandingRequest": {
|
| "description": "Removes the banded range with the given ID from the spreadsheet.",
|
| "id": "DeleteBandingRequest",
|
| @@ -3651,10 +3821,6 @@
|
| "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."
|
| - },
|
| "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"
|
| @@ -3662,6 +3828,10 @@
|
| "spreadsheetId": {
|
| "description": "The spreadsheet the updates were applied to.",
|
| "type": "string"
|
| + },
|
| + "updates": {
|
| + "$ref": "UpdateValuesResponse",
|
| + "description": "Information about the updates that were applied."
|
| }
|
| },
|
| "type": "object"
|
| @@ -3727,6 +3897,24 @@
|
| "description": "The specifications of a chart.",
|
| "id": "ChartSpec",
|
| "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"
|
| + },
|
| "backgroundColor": {
|
| "$ref": "Color",
|
| "description": "The background color of the entire chart.\nNot applicable to Org charts."
|
| @@ -3774,24 +3962,6 @@
|
| "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"
|
| - },
|
| - "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3800,6 +3970,10 @@
|
| "description": "The number format of a cell.",
|
| "id": "NumberFormat",
|
| "properties": {
|
| + "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": {
|
| "description": "The type of the number format.\nWhen writing, this field must be set.",
|
| "enum": [
|
| @@ -3825,10 +3999,6 @@
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3837,13 +4007,13 @@
|
| "description": "The domain of a CandlestickChart.",
|
| "id": "CandlestickDomain",
|
| "properties": {
|
| - "reversed": {
|
| - "description": "True to reverse the order of the domain values (horizontal axis).",
|
| - "type": "boolean"
|
| - },
|
| "data": {
|
| "$ref": "ChartData",
|
| "description": "The data of the CandlestickDomain."
|
| + },
|
| + "reversed": {
|
| + "description": "True to reverse the order of the domain values (horizontal axis).",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3878,10 +4048,6 @@
|
| "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."
|
| - },
|
| "sheetType": {
|
| "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
|
| "enum": [
|
| @@ -3895,6 +4061,10 @@
|
| "The sheet has no grid and instead has an object like a chart or image."
|
| ],
|
| "type": "string"
|
| + },
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -3996,6 +4166,19 @@
|
| "description": "A filter view.",
|
| "id": "FilterView",
|
| "properties": {
|
| + "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"
|
| + },
|
| + "filterViewId": {
|
| + "description": "The ID of the filter view.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "range": {
|
| + "$ref": "GridRange",
|
| + "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
|
| + },
|
| "criteria": {
|
| "additionalProperties": {
|
| "$ref": "FilterCriteria"
|
| @@ -4007,25 +4190,12 @@
|
| "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."
|
| - },
|
| "sortSpecs": {
|
| "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
|
| "items": {
|
| "$ref": "SortSpec"
|
| },
|
| "type": "array"
|
| - },
|
| - "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"
|
| - },
|
| - "filterViewId": {
|
| - "description": "The ID of the filter view.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4034,14 +4204,6 @@
|
| "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": {
|
| - "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)"
|
| @@ -4049,6 +4211,14 @@
|
| "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -4104,15 +4274,6 @@
|
| "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": {
|
| - "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": {
|
| @@ -4146,6 +4307,15 @@
|
| "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"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4154,11 +4324,6 @@
|
| "description": "The response when updating a range of values in a spreadsheet.",
|
| "id": "UpdateValuesResponse",
|
| "properties": {
|
| - "updatedColumns": {
|
| - "description": "The number of columns where at least one cell in the column was updated.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| "spreadsheetId": {
|
| "description": "The spreadsheet the updates were applied to.",
|
| "type": "string"
|
| @@ -4180,6 +4345,50 @@
|
| "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`."
|
| + },
|
| + "updatedColumns": {
|
| + "description": "The number of columns where at least one cell in the column was updated.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ErrorValue": {
|
| + "description": "An error in a cell.",
|
| + "id": "ErrorValue",
|
| + "properties": {
|
| + "message": {
|
| + "description": "A message with more information about the error\n(in the spreadsheet's locale).",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4188,6 +4397,10 @@
|
| "description": "The definition of how a value in a pivot table should be calculated.",
|
| "id": "PivotValue",
|
| "properties": {
|
| + "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": [
|
| @@ -4234,49 +4447,6 @@
|
| "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ErrorValue": {
|
| - "description": "An error in a cell.",
|
| - "id": "ErrorValue",
|
| - "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4296,17 +4466,17 @@
|
| "description": "Information about which values in a pivot group should be used for sorting.",
|
| "id": "PivotGroupSortValueBucket",
|
| "properties": {
|
| + "valuesIndex": {
|
| + "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| "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"
|
| - },
|
| - "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"
|
| @@ -4333,14 +4503,6 @@
|
| "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
|
| "id": "CandlestickData",
|
| "properties": {
|
| - "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."
|
| - },
|
| - "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."
|
| - },
|
| "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."
|
| @@ -4348,6 +4510,14 @@
|
| "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."
|
| + },
|
| + "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."
|
| + },
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -4371,176 +4541,6 @@
|
| }
|
| },
|
| "type": "object"
|
| - },
|
| - "DeleteProtectedRangeRequest": {
|
| - "description": "Deletes the protected range with the given ID.",
|
| - "id": "DeleteProtectedRangeRequest",
|
| - "properties": {
|
| - "protectedRangeId": {
|
| - "description": "The ID of the protected range to delete.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AutoFillRequest": {
|
| - "description": "Fills in more data based on existing data.",
|
| - "id": "AutoFillRequest",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "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."
|
| - },
|
| - "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."
|
| - }
|
| - },
|
| - "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",
|
| - "properties": {
|
| - "midpoint": {
|
| - "$ref": "InterpolationPoint",
|
| - "description": "An optional midway interpolation point."
|
| - },
|
| - "maxpoint": {
|
| - "$ref": "InterpolationPoint",
|
| - "description": "The final interpolation point."
|
| - },
|
| - "minpoint": {
|
| - "$ref": "InterpolationPoint",
|
| - "description": "The starting interpolation point."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ClearValuesRequest": {
|
| - "description": "The request for clearing a range of values in a spreadsheet.",
|
| - "id": "ClearValuesRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "SetBasicFilterRequest": {
|
| - "description": "Sets the basic filter associated with a sheet.",
|
| - "id": "SetBasicFilterRequest",
|
| - "properties": {
|
| - "filter": {
|
| - "$ref": "BasicFilter",
|
| - "description": "The filter to set."
|
| - }
|
| - },
|
| - "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": {
|
| - "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"
|
| - },
|
| - "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": "object"
|
| - },
|
| - "DeleteEmbeddedObjectRequest": {
|
| - "description": "Deletes the embedded object with the given ID.",
|
| - "id": "DeleteEmbeddedObjectRequest",
|
| - "properties": {
|
| - "objectId": {
|
| - "description": "The ID of the embedded object to delete.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "FindReplaceResponse": {
|
| - "description": "The result of the find/replace.",
|
| - "id": "FindReplaceResponse",
|
| - "properties": {
|
| - "valuesChanged": {
|
| - "description": "The number of non-formula cells changed.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "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"
|
| - },
|
| - "DeleteSheetRequest": {
|
| - "description": "Deletes the requested sheet.",
|
| - "id": "DeleteSheetRequest",
|
| - "properties": {
|
| - "sheetId": {
|
| - "description": "The ID of the sheet to delete.",
|
| - "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"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
