Api-roll 43: 2016-12-13

discovery/googleapis/sheets__v4.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/drive.readonly": {
                     "description": "View the files in your Google Drive"
                 },
                 "https://www.googleapis.com/auth/spreadsheets.readonly": {
                     "description": "View your Google Spreadsheets"
                 },
@@ skipping 248 matching lines @@
                                     "required": true,
                                     "type": "string"
                                 },
                                 "ranges": {
                                     "description": "The A1 notation of the values to retrieve.",
                                     "location": "query",
                                     "repeated": true,
                                     "type": "string"
                                 },
                                 "valueRenderOption": {
-                                    "description": "How values should be represented in the output.",
+                                    "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"
                                 },
                                 "dateTimeRenderOption": {
-                                    "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.",
+                                    "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"
                                 },
                                 "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": [
@@ skipping 52 matching lines @@
                                 "range"
                             ],
                             "parameters": {
                                 "spreadsheetId": {
                                     "description": "The ID of the spreadsheet to retrieve data from.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
                                 "valueRenderOption": {
-                                    "description": "How values should be represented in the output.",
+                                    "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"
                                 },
                                 "dateTimeRenderOption": {
-                                    "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.",
+                                    "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"
                                 },
                                 "range": {
                                     "description": "The A1 notation of the values to retrieve.",
                                     "location": "path",
@@ skipping 24 matching lines @@
                         },
                         "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/guides/values#appending_values)\nand\n[sample code](/sheets/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",
                             "id": "sheets.spreadsheets.values.append",
                             "parameterOrder": [
                                 "spreadsheetId",
                                 "range"
                             ],
                             "parameters": {
+                                "responseValueRenderOption": {
+                                    "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+                                    "enum": [
+                                        "FORMATTED_VALUE",
+                                        "UNFORMATTED_VALUE",
+                                        "FORMULA"
+                                    ],
+                                    "location": "query",
+                                    "type": "string"
+                                },
                                 "valueInputOption": {
                                     "description": "How the input data should be interpreted.",
                                     "enum": [
                                         "INPUT_VALUE_OPTION_UNSPECIFIED",
                                         "RAW",
                                         "USER_ENTERED"
                                     ],
                                     "location": "query",
                                     "type": "string"
                                 },
+                                "responseDateTimeRenderOption": {
+                                    "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+                                    "enum": [
+                                        "SERIAL_NUMBER",
+                                        "FORMATTED_STRING"
+                                    ],
+                                    "location": "query",
+                                    "type": "string"
+                                },
+                                "includeValuesInResponse": {
+                                    "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+                                    "location": "query",
+                                    "type": "boolean"
+                                },
                                 "spreadsheetId": {
                                     "description": "The ID of the spreadsheet to update.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
+                                "range": {
+                                    "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
+                                    "location": "path",
+                                    "required": true,
+                                    "type": "string"
+                                },
                                 "insertDataOption": {
                                     "description": "How the input data should be inserted.",
                                     "enum": [
                                         "OVERWRITE",
                                         "INSERT_ROWS"
                                     ],
                                     "location": "query",
                                     "type": "string"
-                                },
-                                "range": {
-                                    "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
-                                    "location": "path",
-                                    "required": true,
-                                    "type": "string"
                                 }
                             },
                             "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
                             "request": {
                                 "$ref": "ValueRange"
                             },
                             "response": {
                                 "$ref": "AppendValuesResponse"
                             },
                             "scopes": [
                                 "https://www.googleapis.com/auth/drive",
                                 "https://www.googleapis.com/auth/spreadsheets"
                             ]
                         },
                         "update": {
                             "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
                             "httpMethod": "PUT",
                             "id": "sheets.spreadsheets.values.update",
                             "parameterOrder": [
                                 "spreadsheetId",
                                 "range"
                             ],
                             "parameters": {
+                                "responseValueRenderOption": {
+                                    "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+                                    "enum": [
+                                        "FORMATTED_VALUE",
+                                        "UNFORMATTED_VALUE",
+                                        "FORMULA"
+                                    ],
+                                    "location": "query",
+                                    "type": "string"
+                                },
                                 "valueInputOption": {
                                     "description": "How the input data should be interpreted.",
                                     "enum": [
                                         "INPUT_VALUE_OPTION_UNSPECIFIED",
                                         "RAW",
                                         "USER_ENTERED"
                                     ],
                                     "location": "query",
                                     "type": "string"
                                 },
+                                "responseDateTimeRenderOption": {
+                                    "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+                                    "enum": [
+                                        "SERIAL_NUMBER",
+                                        "FORMATTED_STRING"
+                                    ],
+                                    "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"
+                                },
                                 "spreadsheetId": {
                                     "description": "The ID of the spreadsheet to update.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
                                 "range": {
                                     "description": "The A1 notation of the values to update.",
                                     "location": "path",
                                     "required": true,
@@ skipping 76 matching lines @@
                             "scopes": [
                                 "https://www.googleapis.com/auth/drive",
                                 "https://www.googleapis.com/auth/spreadsheets"
                             ]
                         }
                     }
                 }
             }
         }
     },
-    "revision": "20161021",
+    "revision": "20161209",
     "rootUrl": "https://sheets.googleapis.com/",
     "schemas": {
         "AddNamedRangeResponse": {
             "description": "The result of adding a named range.",
             "id": "AddNamedRangeResponse",
             "properties": {
                 "namedRange": {
                     "$ref": "NamedRange",
                     "description": "The named range to add."
                 }
@@ skipping 283 matching lines @@
                     "$ref": "NamedRange",
                     "description": "The named range to update with the new properties."
                 }
             },
             "type": "object"
         },
         "UpdateValuesResponse": {
             "description": "The response when updating a range of values in a spreadsheet.",
             "id": "UpdateValuesResponse",
             "properties": {
-                "updatedRange": {
-                    "description": "The range (in A1 notation) that updates were applied to.",
-                    "type": "string"
-                },
                 "updatedColumns": {
                     "description": "The number of columns where at least one cell in the column was updated.",
                     "format": "int32",
                     "type": "integer"
                 },
+                "updatedCells": {
+                    "description": "The number of cells updated.",
+                    "format": "int32",
+                    "type": "integer"
+                },
+                "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`."
+                },
+                "updatedRange": {
+                    "description": "The range (in A1 notation) that updates were applied to.",
+                    "type": "string"
+                },
                 "spreadsheetId": {
                     "description": "The spreadsheet the updates were applied to.",
                     "type": "string"
                 },
                 "updatedRows": {
                     "description": "The number of rows where at least one cell in the row was updated.",
                     "format": "int32",
                     "type": "integer"
-                },
-                "updatedCells": {
-                    "description": "The number of cells updated.",
-                    "format": "int32",
-                    "type": "integer"
                 }
             },
             "type": "object"
         },
         "SpreadsheetProperties": {
             "description": "Properties of a spreadsheet.",
             "id": "SpreadsheetProperties",
             "properties": {
                 "timeZone": {
                     "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
@@ skipping 621 matching lines @@
                         "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
                     ],
                     "type": "string"
                 },
                 "data": {
                     "description": "The new values to apply to the spreadsheet.",
                     "items": {
                         "$ref": "ValueRange"
                     },
                     "type": "array"
+                },
+                "responseValueRenderOption": {
+                    "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+                    "enum": [
+                        "FORMATTED_VALUE",
+                        "UNFORMATTED_VALUE",
+                        "FORMULA"
+                    ],
+                    "enumDescriptions": [
+                        "Values will be calculated & formatted in the reply according to the\ncell's formatting.  Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+                        "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+                        "Values will not be calculated.  The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+                    ],
+                    "type": "string"
+                },
+                "responseDateTimeRenderOption": {
+                    "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+                    "enum": [
+                        "SERIAL_NUMBER",
+                        "FORMATTED_STRING"
+                    ],
+                    "enumDescriptions": [
+                        "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nDays are counted from December 31st 1899 and are incremented by 1,\nand times are fractions of a day.  For example, January 1st 1900 at noon\nwould be 1.5, 1 because it's 1 day offset from December 31st 1899,\nand .5 because noon is half a day.  February 1st 1900 at 3pm would\nbe 32.625. This correctly treats the year 1900 as not a leap year.",
+                        "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+                    ],
+                    "type": "string"
+                },
+                "includeValuesInResponse": {
+                    "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+                    "type": "boolean"
                 }
             },
             "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.",
@@ skipping 564 matching lines @@
                     "format": "int32",
                     "type": "integer"
                 }
             },
             "type": "object"
         },
         "BatchUpdateSpreadsheetRequest": {
             "description": "The request for updating any aspect of a spreadsheet.",
             "id": "BatchUpdateSpreadsheetRequest",
             "properties": {
+                "includeSpreadsheetInResponse": {
+                    "description": "Determines if the update response should include the spreadsheet\nresource.",
+                    "type": "boolean"
+                },
                 "requests": {
                     "description": "A list of updates to apply to the spreadsheet.",
                     "items": {
                         "$ref": "Request"
                     },
                     "type": "array"
+                },
+                "responseRanges": {
+                    "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "responseIncludeGridData": {
+                    "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
+                    "type": "boolean"
                 }
             },
             "type": "object"
         },
         "SheetProperties": {
             "description": "Properties of a sheet.",
             "id": "SheetProperties",
             "properties": {
                 "title": {
                     "description": "The name of the sheet.",
                     "type": "string"
                 },
                 "index": {
-                    "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list.",
+                    "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "hidden": {
                     "description": "True if the sheet is hidden in the UI, false if it's visible.",
                     "type": "boolean"
                 },
                 "gridProperties": {
                     "$ref": "GridProperties",
                     "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
@@ skipping 421 matching lines @@
             "id": "Spreadsheet",
             "properties": {
                 "spreadsheetId": {
                     "description": "The ID of the spreadsheet.\nThis field is read-only.",
                     "type": "string"
                 },
                 "properties": {
                     "$ref": "SpreadsheetProperties",
                     "description": "Overall properties of a spreadsheet."
                 },
+                "spreadsheetUrl": {
+                    "description": "The url of the spreadsheet.\nThis field is read-only.",
+                    "type": "string"
+                },
                 "sheets": {
                     "description": "The sheets that are part of a spreadsheet.",
                     "items": {
                         "$ref": "Sheet"
                     },
                     "type": "array"
                 },
                 "namedRanges": {
                     "description": "The named ranges defined in a spreadsheet.",
                     "items": {
@@ skipping 817 matching lines @@
             "type": "object"
         },
         "BatchUpdateSpreadsheetResponse": {
             "description": "The reply for batch updating a spreadsheet.",
             "id": "BatchUpdateSpreadsheetResponse",
             "properties": {
                 "spreadsheetId": {
                     "description": "The spreadsheet the updates were applied to.",
                     "type": "string"
                 },
+                "updatedSpreadsheet": {
+                    "$ref": "Spreadsheet",
+                    "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+                },
                 "replies": {
                     "description": "The reply of the updates.  This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
                     "items": {
                         "$ref": "Response"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
@@ skipping 563 matching lines @@
                     "description": "The rule that was deleted."
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Sheets API",
     "version": "v4"
 }