Stay organized with collections Save and categorize content based on your preferences.
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.
This method differs from spreadsheets.get 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.
HTTP requestPOST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter
The URL uses gRPC Transcoding syntax.
Path parameters ParametersspreadsheetId
string
The spreadsheet to request.
Request bodyThe request body contains data with the following structure:
JSON representation{
"dataFilters": [
{
object (DataFilter
)
}
],
"includeGridData": boolean,
"excludeTablesInBandedRanges": boolean
}
Fields dataFilters[]
object (
DataFilter
)
The DataFilters
used to select which ranges to retrieve from the spreadsheet.
includeGridData
boolean
True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
excludeTablesInBandedRanges
boolean
True if tables should be excluded in the banded ranges. False if not set.
Response bodyIf successful, the response body contains an instance of Spreadsheet
.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-29 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4