batchUpdate method

Future<BatchUpdateSpreadsheetResponse> batchUpdate(
  1. BatchUpdateSpreadsheetRequest request,
  2. String spreadsheetId, {
  3. String? $fields,
})

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.

request - The metadata request object.

Request parameters:

spreadsheetId - The spreadsheet to apply the updates to.

$fields - Selector specifying which fields to include in a partial response.

Completes with a BatchUpdateSpreadsheetResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<BatchUpdateSpreadsheetResponse> batchUpdate(
  BatchUpdateSpreadsheetRequest request,
  core.String spreadsheetId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v4/spreadsheets/' +
      commons.escapeVariable('$spreadsheetId') +
      ':batchUpdate';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return BatchUpdateSpreadsheetResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}