Method: spreadsheets.values.batchUpdateByDataFilter

Устанавливает значения в одном или нескольких диапазонах электронной таблицы. Вызывающая сторона должна указать идентификатор электронной таблицы, valueInputOption и один или несколько DataFilterValueRanges .

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
spreadsheetId

string

Идентификатор таблицы, которую необходимо обновить.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Поля
valueInputOption

enum ( ValueInputOption )

Как следует интерпретировать входные данные.

data[]

object ( DataFilterValueRange )

Новые значения, которые будут применены к электронной таблице. Если указанному DataFilter соответствует более одного диапазона, указанные значения применяются ко всем этим диапазонам.

includeValuesInResponse

boolean

Определяет, должен ли ответ на обновление включать значения обновленных ячеек. По умолчанию ответы не включают обновленные значения. Поле updatedData в каждом из BatchUpdateValuesResponse.responses содержит обновленные значения. Если диапазон для записи был больше, чем фактически записанный диапазон, ответ включает все значения в запрошенном диапазоне (исключая конечные пустые строки и столбцы).

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

Общее количество строк, в которых была обновлена ​​хотя бы одна ячейка.

totalUpdatedColumns

integer

Общее количество столбцов, в которых была обновлена ​​хотя бы одна ячейка.

totalUpdatedCells

integer

Общее количество обновленных ячеек.

totalUpdatedSheets

integer

Общее количество листов, на которых была обновлена ​​хотя бы одна ячейка листа.

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

Количество строк, в которых была обновлена ​​хотя бы одна ячейка.

updatedColumns

integer

Количество столбцов, в которых была обновлена ​​хотя бы одна ячейка.

updatedCells

integer

Количество обновленных ячеек.

dataFilter

object ( DataFilter )

Фильтр данных, выбравший обновленный диапазон.

updatedData

object ( ValueRange )

Значения ячеек в диапазоне, сопоставленном dataFilter после применения всех обновлений. Это включается только в том случае, если поле includeValuesInResponse запроса имеет true .