Method: spreadsheets.getByDataFilter

指定された ID のスプレッドシートを返します。呼び出し元はスプレッドシート ID を指定する必要があります。詳細については、メタデータの読み取り、書き込み、検索をご覧ください。

このメソッドは、dataFilters パラメータを指定して、返すスプレッドシート データのサブセットを選択できる点が spreadsheets.get と異なります。複数の 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

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