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,
  "excludeTablesInBandedRanges": boolean
}
欄位
dataFilters[]

object (DataFilter)

DataFilters：用於選取要從試算表擷取的範圍。
includeGridData

boolean

如果應傳回格線資料，則為 True。如果要求中已設定欄位遮罩，系統會忽略這個參數。
excludeTablesInBandedRanges

boolean

如果應在帶狀範圍中排除資料表，則為 True。如未設定，則為 False。

回應主體

如果成功，回應主體會包含 Spreadsheet 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。