Method: spreadsheets.getByDataFilter

傳回指定 ID 的試算表。呼叫端必須指定試算表 ID。

這種方法與 Sheets.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
}
欄位
dataFilters[]

object (DataFilter)

DataFilters,用來選取要從試算表擷取的範圍。

includeGridData

boolean

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

回應主體

如果成功,回應主體會包含 Spreadsheet 的執行例項。

授權範圍

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

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

詳情請參閱授權指南