Method: spreadsheets.getByDataFilter

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

このメソッドが spreadsheets.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

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