Method: spreadsheets.batchUpdate

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

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

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

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

HTTP-запрос

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

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

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

Параметры
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

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