Method: spreadsheets.batchUpdate

Вносит одно или несколько изменений в электронную таблицу.

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

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

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

HTTP-запрос

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

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

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

Параметры
spreadsheetId

string

Электронная таблица, в которую будут внесены обновления.

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

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

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

object ( Request )

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

includeSpreadsheetInResponse

boolean

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

responseRanges[]

string

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

responseIncludeGridData

boolean

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

commentsViewMode

enum ( CommentsViewMode )

Режим просмотра комментариев, применяемый к электронной таблице. Это позволяет просматривать электронную таблицу с комментариями, как включенными, так и опущенными. Если он не указан, используется COMMENTS_VIEW_MODE_OMITTED . Имеет значение только в том случае, если includeSpreadsheetInResponse имеет значение 'true'.

Ответный текст

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

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

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

string

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

replies[]

object ( Response )

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

updatedSpreadsheet

object ( Spreadsheet )

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

commentUpdateState

enum ( CommentUpdateState )

Были ли внесены изменения в комментарии в пакетном запросе.

Области полномочий

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

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

Для получения более подробной информации см. руководство по авторизации .

CommentUpdateState

Статус обновления комментариев в пакетном запросе.

Перечисления
COMMENT_UPDATE_STATE_UNSPECIFIED Статус обновлений комментариев не указан.
NO_UPDATES_REQUESTED В пакетном запросе не запрашивалось никаких обновлений комментариев.
ALL_SAVED Все запрошенные обновления комментариев были внесены в рамках пакетного запроса.
ALL_FAILED_UNKNOWN_REASON Все запрошенные обновления комментариев не удалось.