Method: googleapis.sheets.v4.spreadsheets.batchUpdate

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

Arguments

Parameters
spreadsheetId

string

Required. The spreadsheet to apply the updates to.
body

object (BatchUpdateSpreadsheetRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of BatchUpdateSpreadsheetResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- batchUpdate:
    call: googleapis.sheets.v4.spreadsheets.batchUpdate
    args:
        spreadsheetId: ...
        body:
            includeSpreadsheetInResponse: ...
            requests: ...
            responseIncludeGridData: ...
            responseRanges: ...
    result: batchUpdateResult

JSON

[
  {
    "batchUpdate": {
      "call": "googleapis.sheets.v4.spreadsheets.batchUpdate",
      "args": {
        "spreadsheetId": "...",
        "body": {
          "includeSpreadsheetInResponse": "...",
          "requests": "...",
          "responseIncludeGridData": "...",
          "responseRanges": "..."
        }
      },
      "result": "batchUpdateResult"
    }
  }
]