Method: spreadsheets.batchUpdate

Применяет одно или несколько обновлений к электронной таблице.

Каждый request проверяется перед применением. Если какой-либо запрос недействителен, то весь запрос не будет выполнен и ничего не будет применено.

Некоторые запросы имеют replies , чтобы дать вам некоторую информацию о том, как они применяются. Ответы будут зеркально отражать запросы. Например, если вы применили 4 обновления, а на 3-е был ответ, то ответ будет иметь 2 пустых ответа, фактический ответ и еще один пустой ответ, в таком порядке.

Из-за совместной природы электронных таблиц не гарантируется, что электронная таблица будет точно отражать ваши изменения после завершения этого, однако гарантируется, что обновления в запросе будут применены вместе атомарно. Ваши изменения могут быть изменены в отношении изменений соавторов. Если соавторов нет, электронная таблица должна отражать ваши изменения.

HTTP-запрос

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

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

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

Параметры
spreadsheetId

string

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

Текст запроса

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

JSON-представление
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
Поля
requests[]

object ( Request )

Список обновлений для применения к таблице. Запросы будут применены в том порядке, в котором они указаны. Если какой-либо запрос недействителен, запросы не будут применены.

includeSpreadsheetInResponse

boolean

Определяет, должен ли ответ на обновление включать ресурс электронной таблицы.

responseRanges[]

string

Ограничивает диапазоны, включаемые в таблицу ответов. Имеет смысл только если includeSpreadsheetInResponse имеет значение 'true'.

responseIncludeGridData

boolean

True, если должны быть возвращены данные сетки. Имеет смысл только если includeSpreadsheetInResponse имеет значение 'true'. Этот параметр игнорируется, если в запросе была задана маска поля.

Тело ответа

Ответ на пакетное обновление электронной таблицы.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
Поля
spreadsheetId

string

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

replies[]

object ( Response )

Ответ на обновления. Это соответствует 1:1 обновлениям, хотя ответы на некоторые запросы могут быть пустыми.

updatedSpreadsheet

object ( Spreadsheet )

Электронная таблица после применения обновлений. Устанавливается только если BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response имеет true .

Области действия авторизации

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

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

Более подробную информацию см. в Руководстве по авторизации .