Show / Hide Table of Contents

Class SpreadsheetsResource.BatchUpdateRequest

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.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<BatchUpdateSpreadsheetResponse>
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>
SpreadsheetsResource.BatchUpdateRequest
Implements
Google.Apis.Requests.IClientServiceRequest<BatchUpdateSpreadsheetResponse>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.Xgafv
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.AccessToken
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.Alt
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.Callback
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.Fields
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.Key
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.OauthToken
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.PrettyPrint
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.QuotaUser
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.UploadType
SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>.UploadProtocol
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Sheets.v4
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class BatchUpdateRequest : SheetsBaseServiceRequest<BatchUpdateSpreadsheetResponse>, IClientServiceRequest<BatchUpdateSpreadsheetResponse>, IClientServiceRequest

Constructors

BatchUpdateRequest(IClientService, BatchUpdateSpreadsheetRequest, String)

Constructs a new BatchUpdate request.

Declaration
public BatchUpdateRequest(IClientService service, BatchUpdateSpreadsheetRequest body, string spreadsheetId)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
BatchUpdateSpreadsheetRequest body
System.String spreadsheetId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.RestPath

SpreadsheetId

The spreadsheet to apply the updates to.

Declaration
[RequestParameter("spreadsheetId", RequestParameterType.Path)]
public virtual string SpreadsheetId { get; }
Property Value
Type Description
System.String

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.GetBody()

InitParameters()

Initializes BatchUpdate parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Sheets.v4.SheetsBaseServiceRequest<Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest
In This Article
Back to top