Method: spreadsheets.values.batchUpdateByDataFilter

スプレッドシートの 1 つ以上の範囲に値を設定します。呼び出し元は、スプレッドシート ID、valueInputOption、1 つ以上の DataFilterValueRanges を指定する必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

更新するスプレッドシートの ID。

リクエスト本文

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

JSON 表現 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
フィールド
valueInputOption

enum (ValueInputOption)

入力データの解釈方法。
data[]

object (DataFilterValueRange)

スプレッドシートに適用する新しい値です。複数の範囲が指定した DataFilter と一致した場合、指定された範囲がすべての範囲に適用されます。
includeValuesInResponse

boolean

更新のセルに、更新されたセルの値を含めるかどうかを決定します。デフォルトでは、更新された値はレスポンスに含まれません。各 BatchUpdateValuesResponse.responses 内の updatedData フィールドに、更新された値が含まれています。書き込む範囲が実際に書き込まれる範囲より大きい場合、レスポンスには、リクエストされた範囲内のすべての値が含まれます（末尾の空の行と列を除く）。
responseValueRenderOption

enum (ValueRenderOption)

レスポンス内の値のレンダリング方法を指定します。デフォルトのレンダリング オプションは FORMATTED_VALUE です。
responseDateTimeRenderOption

enum (DateTimeRenderOption)

レスポンス内の日付、時刻、期間をレンダリングする方法を決定します。responseValueRenderOption が FORMATTED_VALUE の場合は無視されます。デフォルトの dateTime レンダリング オプションは SERIAL_NUMBER です。

レスポンスの本文

スプレッドシートの値の範囲を更新するときのレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
フィールド
spreadsheetId

string

更新が適用されたスプレッドシート。
totalUpdatedRows

integer

行内の 1 つ以上のセルが更新された行の合計数。
totalUpdatedColumns

integer

列内で少なくとも 1 つのセルが更新された列の合計数。
totalUpdatedCells

integer

更新されたセルの合計数。
totalUpdatedSheets

integer

シート内の少なくとも 1 つのセルが更新されたシートの合計数。
responses[]

object (UpdateValuesByDataFilterResponse)

各範囲のレスポンスが更新されました。

認可スコープ

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

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

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

DataFilterValueRange

ロケーションが DataFilter で指定される値の範囲。

JSON 表現 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
フィールド
dataFilter

object (DataFilter)

スプレッドシート内の値の場所を示すデータフィルタ。
majorDimension

enum (Dimension)

値のメジャー ディメンション。
values[]

array (ListValue format)

書き込まれるデータ。指定された値がデータフィルタに一致する範囲を超えると、リクエストは失敗します。指定された値が一致した範囲よりも小さい場合、指定した値のみが書き込まれ、一致した範囲内の既存の値には影響しません。

UpdateValuesByDataFilterResponse

スプレッドシートのデータフィルタによって値の範囲を更新する際のレスポンス。

JSON 表現 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
フィールド
updatedRange

string

更新が適用された範囲（A1 表記）。
updatedRows

integer

行内の 1 つ以上のセルが更新された行の数。
updatedColumns

integer

列内の 1 つ以上のセルが更新された列の数。
updatedCells

integer

更新されたセルの数。
dataFilter

object (DataFilter)

更新された範囲を選択したデータフィルタ。
updatedData

object (ValueRange)

すべての更新の適用後、dataFilter と一致する範囲内のセルの値。これは、リクエストの includeValuesInResponse フィールドが true の場合にのみ含まれます。