{"note":"OpenAPI conversion -- returning structured metadata","name":"google-sheets","description":"Google Sheets API","version":"v4","base_url":"https://sheets.googleapis.com/","endpoints":17,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Google Sheets API\n@base https://sheets.googleapis.com/\n@version v4\n@auth OAuth2 | OAuth2\n@common_fields {spreadsheetId: str # The ID of the spreadsheet. This field is read-only.}\n@endpoints 17\n@toc spreadsheets(17)\n\n@endpoint POST /v4/spreadsheets\n@desc Creates a spreadsheet, returning the newly created spreadsheet.\n@optional {dataSourceSchedules: [map{dailySchedule: map, enabled: bool, monthlySchedule: map, nextRun: map, refreshScope: str, weeklySchedule: map}] # Output only. A list of data source refresh schedules., dataSources: [map{calculatedColumns: [map], dataSourceId: str, sheetId: int(int32), spec: map}] # A list of external data sources connected with the spreadsheet., developerMetadata: [map{location: map, metadataId: int(int32), metadataKey: str, metadataValue: str, visibility: str}] # The developer metadata associated with a spreadsheet., namedRanges: [map{name: str, namedRangeId: str, range: map}] # The named ranges defined in a spreadsheet., properties: map{autoRecalc: str, defaultFormat: map, iterativeCalculationSettings: map, locale: str, spreadsheetTheme: map, timeZone: str, title: str} # Properties of a spreadsheet., sheets: [map{bandedRanges: [map], basicFilter: map, charts: [map], columnGroups: [map], conditionalFormats: [map], data: [map], developerMetadata: [map], filterViews: [map], merges: [map], properties: map, protectedRanges: [map], rowGroups: [map], slicers: [map]}] # The sheets that are part of a spreadsheet., spreadsheetUrl: str # The url of the spreadsheet. This field is read-only.}\n@returns(200) {dataSourceSchedules: [map], dataSources: [map], developerMetadata: [map], namedRanges: [map], properties: map{autoRecalc: str, defaultFormat: map{backgroundColor: map{alpha: num(float), blue: num(float), green: num(float), red: num(float)}, backgroundColorStyle: map{rgbColor: map, themeColor: str}, borders: map{bottom: map, left: map, right: map, top: map}, horizontalAlignment: str, hyperlinkDisplayType: str, numberFormat: map{pattern: str, type: str}, padding: map{bottom: int(int32), left: int(int32), right: int(int32), top: int(int32)}, textDirection: str, textFormat: map{bold: bool, fontFamily: str, fontSize: int(int32), foregroundColor: map, foregroundColorStyle: map, italic: bool, link: map, strikethrough: bool, underline: bool}, textRotation: map{angle: int(int32), vertical: bool}, verticalAlignment: str, wrapStrategy: str}, iterativeCalculationSettings: map{convergenceThreshold: num(double), maxIterations: int(int32)}, locale: str, spreadsheetTheme: map{primaryFontFamily: str, themeColors: [map]}, timeZone: str, title: str}, sheets: [map], spreadsheetId: str, spreadsheetUrl: str} # Successful response\n\n@endpoint GET /v4/spreadsheets/{spreadsheetId}\n@desc 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/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.\n@optional {includeGridData: bool # True if grid data should be returned. This parameter is ignored if a field mask was set in the request., ranges: [str] # The ranges to retrieve from the spreadsheet.}\n@returns(200) {dataSourceSchedules: [map], dataSources: [map], developerMetadata: [map], namedRanges: [map], properties: map{autoRecalc: str, defaultFormat: map{backgroundColor: map{alpha: num(float), blue: num(float), green: num(float), red: num(float)}, backgroundColorStyle: map{rgbColor: map, themeColor: str}, borders: map{bottom: map, left: map, right: map, top: map}, horizontalAlignment: str, hyperlinkDisplayType: str, numberFormat: map{pattern: str, type: str}, padding: map{bottom: int(int32), left: int(int32), right: int(int32), top: int(int32)}, textDirection: str, textFormat: map{bold: bool, fontFamily: str, fontSize: int(int32), foregroundColor: map, foregroundColorStyle: map, italic: bool, link: map, strikethrough: bool, underline: bool}, textRotation: map{angle: int(int32), vertical: bool}, verticalAlignment: str, wrapStrategy: str}, iterativeCalculationSettings: map{convergenceThreshold: num(double), maxIterations: int(int32)}, locale: str, spreadsheetTheme: map{primaryFontFamily: str, themeColors: [map]}, timeZone: str, title: str}, sheets: [map], spreadsheetId: str, spreadsheetUrl: str} # Successful response\n\n@endpoint GET /v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}\n@desc Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.\n@required {metadataId: int # The ID of the developer metadata to retrieve.}\n@returns(200) {location: map{dimensionRange: map{dimension: str, endIndex: int(int32), sheetId: int(int32), startIndex: int(int32)}, locationType: str, sheetId: int(int32), spreadsheet: bool}, metadataId: int(int32), metadataKey: str, metadataValue: str, visibility: str} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/developerMetadata:search\n@desc Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.\n@optional {dataFilters: [map{a1Range: str, developerMetadataLookup: map, gridRange: map}] # The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.}\n@returns(200) {matchedDeveloperMetadata: [map]} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo\n@desc Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.\n@required {sheetId: int # The ID of the sheet to copy.}\n@optional {destinationSpreadsheetId: str # The ID of the spreadsheet to copy the sheet to.}\n@returns(200) {dataSourceSheetProperties: map{columns: [map], dataExecutionStatus: map{errorCode: str, errorMessage: str, lastRefreshTime: str(google-datetime), state: str}, dataSourceId: str}, gridProperties: map{columnCount: int(int32), columnGroupControlAfter: bool, frozenColumnCount: int(int32), frozenRowCount: int(int32), hideGridlines: bool, rowCount: int(int32), rowGroupControlAfter: bool}, hidden: bool, index: int(int32), rightToLeft: bool, sheetId: int(int32), sheetType: str, tabColor: map{alpha: num(float), blue: num(float), green: num(float), red: num(float)}, tabColorStyle: map{rgbColor: map{alpha: num(float), blue: num(float), green: num(float), red: num(float)}, themeColor: str}, title: str} # Successful response\n\n@endpoint GET /v4/spreadsheets/{spreadsheetId}/values/{range}\n@desc Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.\n@required {range: str # The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.}\n@optional {dateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 option is SERIAL_NUMBER., majorDimension: str(DIMENSION_UNSPECIFIED/ROWS/COLUMNS) # 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?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`., valueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # How values should be represented in the output. The default render option is FORMATTED_VALUE.}\n@returns(200) {majorDimension: str, range: str, values: [[any]]} # Successful response\n\n@endpoint PUT /v4/spreadsheets/{spreadsheetId}/values/{range}\n@desc Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.\n@required {range: str # The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.}\n@optional {includeValuesInResponse: bool # 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 range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns)., responseDateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 dateTime render option is SERIAL_NUMBER., responseValueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE., valueInputOption: str(INPUT_VALUE_OPTION_UNSPECIFIED/RAW/USER_ENTERED) # How the input data should be interpreted., majorDimension: str(DIMENSION_UNSPECIFIED/ROWS/COLUMNS) # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS., range: str # The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended., values: [[any]] # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.}\n@returns(200) {spreadsheetId: str, updatedCells: int(int32), updatedColumns: int(int32), updatedData: map{majorDimension: str, range: str, values: [[any]]}, updatedRange: str, updatedRows: int(int32)} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values/{range}:append\n@desc 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](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.\n@required {range: str # The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.}\n@optional {includeValuesInResponse: bool # Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values., insertDataOption: str(OVERWRITE/INSERT_ROWS) # How the input data should be inserted., responseDateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 dateTime render option is SERIAL_NUMBER., responseValueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE., valueInputOption: str(INPUT_VALUE_OPTION_UNSPECIFIED/RAW/USER_ENTERED) # How the input data should be interpreted., majorDimension: str(DIMENSION_UNSPECIFIED/ROWS/COLUMNS) # The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS., range: str # The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended., values: [[any]] # The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.}\n@returns(200) {spreadsheetId: str, tableRange: str, updates: map{spreadsheetId: str, updatedCells: int(int32), updatedColumns: int(int32), updatedData: map{majorDimension: str, range: str, values: [[any]]}, updatedRange: str, updatedRows: int(int32)}} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values/{range}:clear\n@desc 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.\n@required {range: str # The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.}\n@returns(200) {clearedRange: str, spreadsheetId: str} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values:batchClear\n@desc 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.\n@optional {ranges: [str] # The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell).}\n@returns(200) {clearedRanges: [str], spreadsheetId: str} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter\n@desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.\n@optional {dataFilters: [map{a1Range: str, developerMetadataLookup: map, gridRange: map}] # The DataFilters used to determine which ranges to clear.}\n@returns(200) {clearedRanges: [str], spreadsheetId: str} # Successful response\n\n@endpoint GET /v4/spreadsheets/{spreadsheetId}/values:batchGet\n@desc Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.\n@optional {dateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 option is SERIAL_NUMBER., majorDimension: str(DIMENSION_UNSPECIFIED/ROWS/COLUMNS) # 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=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`., ranges: [str] # The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from., valueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.}\n@returns(200) {spreadsheetId: str, valueRanges: [map]} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter\n@desc Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.\n@optional {dataFilters: [map{a1Range: str, developerMetadataLookup: map, gridRange: map}] # The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response., dateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 option is SERIAL_NUMBER., majorDimension: str(DIMENSION_UNSPECIFIED/ROWS/COLUMNS) # The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`., valueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # How values should be represented in the output. The default render option is FORMATTED_VALUE.}\n@returns(200) {spreadsheetId: str, valueRanges: [map]} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdate\n@desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.\n@optional {data: [map{majorDimension: str, range: str, values: [[any]]}] # The new values to apply to the spreadsheet., includeValuesInResponse: bool # Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns)., responseDateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 dateTime render option is SERIAL_NUMBER., responseValueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE., valueInputOption: str(INPUT_VALUE_OPTION_UNSPECIFIED/RAW/USER_ENTERED) # How the input data should be interpreted.}\n@returns(200) {responses: [map], spreadsheetId: str, totalUpdatedCells: int(int32), totalUpdatedColumns: int(int32), totalUpdatedRows: int(int32), totalUpdatedSheets: int(int32)} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter\n@desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.\n@optional {data: [map{dataFilter: map, majorDimension: str, values: [[any]]}] # The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges., includeValuesInResponse: bool # Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns)., responseDateTimeRenderOption: str(SERIAL_NUMBER/FORMATTED_STRING) # 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 dateTime render option is SERIAL_NUMBER., responseValueRenderOption: str(FORMATTED_VALUE/UNFORMATTED_VALUE/FORMULA) # Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE., valueInputOption: str(INPUT_VALUE_OPTION_UNSPECIFIED/RAW/USER_ENTERED) # How the input data should be interpreted.}\n@returns(200) {responses: [map], spreadsheetId: str, totalUpdatedCells: int(int32), totalUpdatedColumns: int(int32), totalUpdatedRows: int(int32), totalUpdatedSheets: int(int32)} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}:batchUpdate\n@desc 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 requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.\n@optional {includeSpreadsheetInResponse: bool # Determines if the update response should include the spreadsheet resource., requests: [map{addBanding: map, addChart: map, addConditionalFormatRule: map, addDataSource: map, addDimensionGroup: map, addFilterView: map, addNamedRange: map, addProtectedRange: map, addSheet: map, addSlicer: map, appendCells: map, appendDimension: map, autoFill: map, autoResizeDimensions: map, clearBasicFilter: map, copyPaste: map, createDeveloperMetadata: map, cutPaste: map, deleteBanding: map, deleteConditionalFormatRule: map, deleteDataSource: map, deleteDeveloperMetadata: map, deleteDimension: map, deleteDimensionGroup: map, deleteDuplicates: map, deleteEmbeddedObject: map, deleteFilterView: map, deleteNamedRange: map, deleteProtectedRange: map, deleteRange: map, deleteSheet: map, duplicateFilterView: map, duplicateSheet: map, findReplace: map, insertDimension: map, insertRange: map, mergeCells: map, moveDimension: map, pasteData: map, randomizeRange: map, refreshDataSource: map, repeatCell: map, setBasicFilter: map, setDataValidation: map, sortRange: map, textToColumns: map, trimWhitespace: map, unmergeCells: map, updateBanding: map, updateBorders: map, updateCells: map, updateChartSpec: map, updateConditionalFormatRule: map, updateDataSource: map, updateDeveloperMetadata: map, updateDimensionGroup: map, updateDimensionProperties: map, updateEmbeddedObjectBorder: map, updateEmbeddedObjectPosition: map, updateFilterView: map, updateNamedRange: map, updateProtectedRange: map, updateSheetProperties: map, updateSlicerSpec: map, updateSpreadsheetProperties: map}] # A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied., responseIncludeGridData: bool # True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request., responseRanges: [str] # Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.}\n@returns(200) {replies: [map], spreadsheetId: str, updatedSpreadsheet: map{dataSourceSchedules: [map], dataSources: [map], developerMetadata: [map], namedRanges: [map], properties: map{autoRecalc: str, defaultFormat: map{backgroundColor: map, backgroundColorStyle: map, borders: map, horizontalAlignment: str, hyperlinkDisplayType: str, numberFormat: map, padding: map, textDirection: str, textFormat: map, textRotation: map, verticalAlignment: str, wrapStrategy: str}, iterativeCalculationSettings: map{convergenceThreshold: num(double), maxIterations: int(int32)}, locale: str, spreadsheetTheme: map{primaryFontFamily: str, themeColors: [map]}, timeZone: str, title: str}, sheets: [map], spreadsheetId: str, spreadsheetUrl: str}} # Successful response\n\n@endpoint POST /v4/spreadsheets/{spreadsheetId}:getByDataFilter\n@desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.\n@optional {dataFilters: [map{a1Range: str, developerMetadataLookup: map, gridRange: map}] # The DataFilters used to select which ranges to retrieve from the spreadsheet., includeGridData: bool # True if grid data should be returned. This parameter is ignored if a field mask was set in the request.}\n@returns(200) {dataSourceSchedules: [map], dataSources: [map], developerMetadata: [map], namedRanges: [map], properties: map{autoRecalc: str, defaultFormat: map{backgroundColor: map{alpha: num(float), blue: num(float), green: num(float), red: num(float)}, backgroundColorStyle: map{rgbColor: map, themeColor: str}, borders: map{bottom: map, left: map, right: map, top: map}, horizontalAlignment: str, hyperlinkDisplayType: str, numberFormat: map{pattern: str, type: str}, padding: map{bottom: int(int32), left: int(int32), right: int(int32), top: int(int32)}, textDirection: str, textFormat: map{bold: bool, fontFamily: str, fontSize: int(int32), foregroundColor: map, foregroundColorStyle: map, italic: bool, link: map, strikethrough: bool, underline: bool}, textRotation: map{angle: int(int32), vertical: bool}, verticalAlignment: str, wrapStrategy: str}, iterativeCalculationSettings: map{convergenceThreshold: num(double), maxIterations: int(int32)}, locale: str, spreadsheetTheme: map{primaryFontFamily: str, themeColors: [map]}, timeZone: str, title: str}, sheets: [map], spreadsheetId: str, spreadsheetUrl: str} # Successful response\n\n@end\n"}