指定したデータフィルタに一致する値の範囲を 1 つ以上返します。呼び出し元は、スプレッドシート ID と 1 つ以上の DataFilters
を指定する必要があります。リクエスト内のデータフィルタのいずれかに一致する範囲が返されます。
HTTP リクエスト
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
spreadsheetId |
データを取得するスプレッドシートの ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dataFilters": [ { object ( |
フィールド | |
---|---|
dataFilters[] |
取得する値の範囲を照合するために使用されるデータフィルタ。指定したデータフィルタのいずれかに一致する範囲がレスポンスに含まれます。 |
majorDimension |
結果で使用するメジャー ディメンション。 たとえば、スプレッドシートのデータが |
valueRenderOption |
出力での値の表現方法。デフォルトのレンダリング オプションは |
dateTimeRenderOption |
日付、時刻、期間を出力でどのように表現するか。 |
レスポンスの本文
DataFilters
が選択したスプレッドシートで複数の値の範囲を取得した場合のレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"spreadsheetId": string,
"valueRanges": [
{
object ( |
フィールド | |
---|---|
spreadsheetId |
データを取得したスプレッドシートの ID。 |
valueRanges[] |
リクエストされた値と、それに一致するデータフィルタのリスト。 |
認可スコープ
次の 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[] |
値の範囲と一致したリクエストの |