Method: spreadsheets.values.batchGetByDataFilter

指定されたデータフィルタに一致する値の範囲を 1 つ以上返します。呼び出し元は、スプレッドシート ID と 1 つ以上の DataFilters を指定する必要があります。リクエスト内のいずれかのデータフィルタに一致する範囲が返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

データを取得するスプレッドシートの ID。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
フィールド
dataFilters[]

object (DataFilter)

取得する値の範囲との照合に使用されるデータフィルタ。指定したデータフィルタのいずれかに一致する範囲がレスポンスに含まれます。
majorDimension

enum (Dimension)

結果で使用する主要なディメンション。

たとえば、スプレッドシートのデータが A1=1,B1=2,A2=3,B2=4 の場合、その範囲を選択して majorDimension=ROWS を設定するリクエストは [[1,2],[3,4]] を返しますが、majorDimension=COLUMNS を設定するリクエストは [[1,3],[2,4]] を返します。
valueRenderOption

enum (ValueRenderOption)

値が出力でどのように表されるか。デフォルトのレンダリング オプションは FORMATTED_VALUE です。
dateTimeRenderOption

enum (DateTimeRenderOption)

日付、時刻、期間が出力でどのように表されるか。valueRenderOption が FORMATTED_VALUE の場合、これは無視されます。デフォルトの dateTime レンダリング オプションは SERIAL_NUMBER です。

レスポンスの本文

DataFilters によって選択されたスプレッドシート内の複数の値範囲を取得した場合のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
フィールド
spreadsheetId

string

データが取得されたスプレッドシートの ID。
valueRanges[]

object (MatchedValueRange)

リクエストされた値と、それらに一致するデータフィルタのリスト。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

MatchedValueRange

1 つ以上のデータフィルタによって一致した値の範囲。

JSON 表現 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
フィールド
valueRange

object (ValueRange)

DataFilter と一致する値。
dataFilters[]

object (DataFilter)

値の範囲に一致したリクエストの DataFilters。