傳回符合指定資料篩選器的一或多個值範圍。呼叫端必須指定試算表 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[] |
要求中符合任一值範圍的 |