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 .