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。