{"name":"sheets","version":"v4","revision":"20261014","title":"Google Sheets API","rootUrl":"https://sheets.googleapis.com/","servicePath":"","basePath":"","batchPath":"batch","methods":[{"id":"spreadsheets.batchUpdate","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}:batchUpdate","flatPath":"v4/spreadsheets/{spreadsheetId}:batchUpdate","description":"Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the r","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The spreadsheet to apply the updates to.","enum":null}]},{"id":"spreadsheets.create","httpMethod":"POST","path":"v4/spreadsheets","flatPath":"v4/spreadsheets","description":"Creates a spreadsheet, returning the newly created spreadsheet.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":[],"parameters":[]},{"id":"spreadsheets.developerMetadata.get","httpMethod":"GET","path":"v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}","flatPath":"v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}","description":"Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId","metadataId"],"parameters":[{"name":"metadataId","type":"integer","required":true,"repeated":false,"location":"path","description":"The ID of the developer metadata to retrieve.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to retrieve metadata from.","enum":null}]},{"id":"spreadsheets.developerMetadata.search","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/developerMetadata:search","flatPath":"v4/spreadsheets/{spreadsheetId}/developerMetadata:search","description":"Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMe","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to retrieve metadata from.","enum":null}]},{"id":"spreadsheets.get","httpMethod":"GET","path":"v4/spreadsheets/{spreadsheetId}","flatPath":"v4/spreadsheets/{spreadsheetId}","description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields ","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"],"required":["spreadsheetId"],"parameters":[{"name":"commentsViewMode","type":"string","required":false,"repeated":false,"location":"query","description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIE","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"]},{"name":"excludeTablesInBandedRanges","type":"boolean","required":false,"repeated":false,"location":"query","description":"True if tables should be excluded in the banded ranges. False if not set.","enum":null},{"name":"includeGridData","type":"boolean","required":false,"repeated":false,"location":"query","description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","enum":null},{"name":"ranges","type":"string","required":false,"repeated":true,"location":"query","description":"The ranges to retrieve from the spreadsheet.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The spreadsheet to request.","enum":null}]},{"id":"spreadsheets.getByDataFilter","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}:getByDataFilter","flatPath":"v4/spreadsheets/{spreadsheetId}:getByDataFilter","description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of ","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The spreadsheet to request.","enum":null}]},{"id":"spreadsheets.sheets.copyTo","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo","flatPath":"v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo","description":"Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId","sheetId"],"parameters":[{"name":"sheetId","type":"integer","required":true,"repeated":false,"location":"path","description":"The ID of the sheet to copy.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet containing the sheet to copy.","enum":null}]},{"id":"spreadsheets.values.append","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values/{range}:append","flatPath":"v4/spreadsheets/{spreadsheetId}/values/{range}:append","description":"Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/valu","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId","range"],"parameters":[{"name":"includeValuesInResponse","type":"boolean","required":false,"repeated":false,"location":"query","description":"Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.","enum":null},{"name":"insertDataOption","type":"string","required":false,"repeated":false,"location":"query","description":"How the input data should be inserted.","enum":["OVERWRITE","INSERT_ROWS"]},{"name":"range","type":"string","required":true,"repeated":false,"location":"path","description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended","enum":null},{"name":"responseDateTimeRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default d","enum":["SERIAL_NUMBER","FORMATTED_STRING"]},{"name":"responseValueRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"]},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null},{"name":"valueInputOption","type":"string","required":false,"repeated":false,"location":"query","description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"]}]},{"id":"spreadsheets.values.batchClear","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values:batchClear","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchClear","description":"Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null}]},{"id":"spreadsheets.values.batchClearByDataFilter","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter","description":"Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data ","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null}]},{"id":"spreadsheets.values.batchGet","httpMethod":"GET","path":"v4/spreadsheets/{spreadsheetId}/values:batchGet","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchGet","description":"Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.","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"],"required":["spreadsheetId"],"parameters":[{"name":"dateTimeRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render opti","enum":["SERIAL_NUMBER","FORMATTED_STRING"]},{"name":"majorDimension","type":"string","required":false,"repeated":false,"location":"query","description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=RO","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"]},{"name":"ranges","type":"string","required":false,"repeated":true,"location":"query","description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to retrieve data from.","enum":null},{"name":"valueRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"]}]},{"id":"spreadsheets.values.batchGetByDataFilter","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter","description":"Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any ","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to retrieve data from.","enum":null}]},{"id":"spreadsheets.values.batchUpdate","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values:batchUpdate","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchUpdate","description":"Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null}]},{"id":"spreadsheets.values.batchUpdateByDataFilter","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter","flatPath":"v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter","description":"Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId"],"parameters":[{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null}]},{"id":"spreadsheets.values.clear","httpMethod":"POST","path":"v4/spreadsheets/{spreadsheetId}/values/{range}:clear","flatPath":"v4/spreadsheets/{spreadsheetId}/values/{range}:clear","description":"Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId","range"],"parameters":[{"name":"range","type":"string","required":true,"repeated":false,"location":"path","description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null}]},{"id":"spreadsheets.values.get","httpMethod":"GET","path":"v4/spreadsheets/{spreadsheetId}/values/{range}","flatPath":"v4/spreadsheets/{spreadsheetId}/values/{range}","description":"Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.","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"],"required":["spreadsheetId","range"],"parameters":[{"name":"dateTimeRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render opti","enum":["SERIAL_NUMBER","FORMATTED_STRING"]},{"name":"majorDimension","type":"string","required":false,"repeated":false,"location":"query","description":"The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?major","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"]},{"name":"range","type":"string","required":true,"repeated":false,"location":"path","description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","enum":null},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to retrieve data from.","enum":null},{"name":"valueRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"]}]},{"id":"spreadsheets.values.update","httpMethod":"PUT","path":"v4/spreadsheets/{spreadsheetId}/values/{range}","flatPath":"v4/spreadsheets/{spreadsheetId}/values/{range}","description":"Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.","scopes":["https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/spreadsheets"],"required":["spreadsheetId","range"],"parameters":[{"name":"includeValuesInResponse","type":"boolean","required":false,"repeated":false,"location":"query","description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the rang","enum":null},{"name":"range","type":"string","required":true,"repeated":false,"location":"path","description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.","enum":null},{"name":"responseDateTimeRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default d","enum":["SERIAL_NUMBER","FORMATTED_STRING"]},{"name":"responseValueRenderOption","type":"string","required":false,"repeated":false,"location":"query","description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"]},{"name":"spreadsheetId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the spreadsheet to update.","enum":null},{"name":"valueInputOption","type":"string","required":false,"repeated":false,"location":"query","description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"]}]}]}