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,
  "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

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