/v4/spreadsheets/{spreadsheetId}:getByDataFilter

POST

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 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.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Successful response

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://sheets.googleapis.com//v4/spreadsheets/:getByDataFilter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dataFilters": [
        {
            "a1Range": "string",
            "developerMetadataLookup": {},
            "gridRange": {}
        }
    ],
    "includeGridData": true
}'

Response Example

Modified at 2023-08-15 07:09:28

/v4/spreadsheets/{spreadsheetId}:batchUpdate

AddBandingRequest