返回与指定数据过滤条件匹配的一个或多个值范围。调用方必须指定电子表格 ID 以及一个或多个 DataFilters
。系统将返回与请求中的任何数据过滤器匹配的范围。
HTTP 请求
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
spreadsheetId |
要从中检索数据的电子表格的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "dataFilters": [ { object ( |
字段 | |
---|---|
dataFilters[] |
数据过滤器,用于匹配要检索的值的范围。响应中包含与任意指定数据过滤器匹配的范围。 |
majorDimension |
结果应使用的主要维度。 例如,如果电子表格数据为 |
valueRenderOption |
值在输出中的表示方式。默认呈现选项为 |
dateTimeRenderOption |
日期、时间和时长在输出中的表示方式。如果 |
响应正文
在 DataFilters
选择的电子表格中检索多个值范围时的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"spreadsheetId": string,
"valueRanges": [
{
object ( |
字段 | |
---|---|
spreadsheetId |
从中检索数据的电子表格的 ID。 |
valueRanges[] |
请求的值以及匹配的数据过滤器列表。 |
授权范围
需要以下 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[] |
请求中与值范围匹配的 |