Method: spreadsheets.values.batchGetByDataFilter

返回与指定数据过滤器匹配的一个或多个值范围。调用方必须指定电子表格 ID 以及一个或多个 DataFilters。系统将返回与请求中的任何数据过滤器匹配的范围。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

要从中检索数据的电子表格的 ID。

请求正文

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

JSON 表示法 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
字段
dataFilters[]

object (DataFilter)

用于匹配要提取的值范围的数据过滤器。响应中将包含匹配任何指定数据过滤器的范围。
majorDimension

enum (Dimension)

结果应使用的主要维度。

例如，如果电子表格数据为 A1=1,B1=2,A2=3,B2=4，则选择该范围并设置 majorDimension=ROWS 的请求会返回 [[1,2],[3,4]]，而设置 majorDimension=COLUMNS 的请求会返回 [[1,3],[2,4]]。
valueRenderOption

enum (ValueRenderOption)

应如何在输出中表示值。默认渲染选项为 FORMATTED_VALUE。
dateTimeRenderOption

enum (DateTimeRenderOption)

日期、时间和时长应如何在输出中表示。如果 valueRenderOption 为 FORMATTED_VALUE，系统会忽略此属性。默认的 dateTime 呈现选项为 SERIAL_NUMBER。

响应正文

在通过 DataFilters 选择的电子表格中检索多个值范围时的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
字段
spreadsheetId

string

从中检索数据的电子表格的 ID。
valueRanges[]

object (MatchedValueRange)

请求的值以及与其匹配的数据过滤器列表。

授权范围

需要以下 OAuth 范围之一：

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

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

MatchedValueRange

与一个或多个数据文件匹配的值范围。

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

object (ValueRange)

与 DataFilter 匹配的值。
dataFilters[]

object (DataFilter)

请求中与值范围匹配的 DataFilters。