Method: spreadsheets.getByDataFilter

指定された ID のスプレッドシートを返します。呼び出し元はスプレッドシート ID を指定する必要があります。

このメソッドは spreadsheet.get と異なり、dataFilters パラメータを指定して返すスプレッドシート データのサブセットを選択できます。DataFilters は複数指定できます。1 つ以上のデータフィルタを指定すると、いずれかのフィルタによって一致した範囲と交差するスプレッドシートの部分が返されます。

デフォルトでは、グリッド内のデータは返されません。グリッドデータを含めるには、次の 2 つの方法があります。

  • HTTP の fields URL パラメータを使用して、目的のフィールドを一覧表示するフィールド マスクを指定します。

  • includeGridData パラメータを true に設定します。フィールド マスクが設定されている場合、includeGridData パラメータは無視されます。

サイズの大きなスプレッドシートの場合、必要な特定のスプレッドシート フィールドのみを取得することをおすすめします。

HTTP リクエスト

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳しくは、認可ガイドをご覧ください。