Method: spreadsheets.getByDataFilter

返回具有指定 ID 的电子表格。调用方必须指定电子表格 ID。

此方法与 spreadsheets.get 的不同之处在于，该方法允许通过指定 dataFilters 参数来选择要返回的电子表格数据的子集。您可以指定多个 DataFilters。指定一个或多个数据过滤器会返回电子表格中与任何过滤器匹配的范围相交的部分。

默认情况下，不会返回网格内的数据。您可以通过以下两种方式之一添加网格数据：

  • 在 HTTP 中使用 fields 网址参数指定字段掩码，列出您所需的字段

  • 将 includeGridData 参数设置为 true。如果设置了字段掩码，则系统会忽略 includeGridData 参数

对于大型电子表格，最佳做法是只检索您需要的特定电子表格字段。

HTTP 请求

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

要请求的电子表格。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
字段
dataFilters[]

object (DataFilter)

DataFilters 用于选择要从电子表格中检索的范围。
includeGridData

boolean

如果应返回网格数据，则为 true。如果在请求中设置了字段掩码，则忽略此参数。

响应正文

如果成功，则响应正文包含一个 Spreadsheet 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

有关详情，请参阅授权指南。