Method: spreadsheets.values.batchUpdate

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

HTTP-запрос

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

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

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

Параметры
spreadsheetId

string

Идентификатор электронной таблицы для обновления.

Тело запроса

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

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

enum ( ValueInputOption )

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

data[]

object ( ValueRange )

Новые значения, применяемые к электронной таблице.

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 (UpdateValuesResponse)
    }
  ]
}
Поля
spreadsheetId

string

Электронная таблица, к которой были применены обновления.

totalUpdatedRows

integer

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

totalUpdatedColumns

integer

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

totalUpdatedCells

integer

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

totalUpdatedSheets

integer

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

responses[]

object ( UpdateValuesResponse )

Один ответ UpdateValuesResponse на запрошенный диапазон в том же порядке, в котором появлялись запросы.

Области авторизации

Требуется одна из следующих областей действия OAuth:

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

Дополнительные сведения см. в руководстве по авторизации .