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 . Параметр отображения даты и времени по умолчанию — 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 )

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