sheets  v4
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest Class Reference

Applies one or more updates to the spreadsheet. More...

Inheritance diagram for Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest:
Google.Apis.Sheets.v4.SheetsBaseServiceRequest< Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse >

Public Member Functions

 BatchUpdateRequest (Google.Apis.Services.IClientService service, Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetRequest body, string spreadsheetId)
 Constructs a new BatchUpdate request. More...
 

Protected Member Functions

override object GetBody ()
 summary>Gets the method name. More...
 
override void InitParameters ()
 Initializes BatchUpdate parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Sheets.v4.SheetsBaseServiceRequest< Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse >
 SheetsBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new SheetsBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Sheets parameter list. More...
 

Properties

virtual string SpreadsheetId [get]
 The spreadsheet to apply the updates to. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Sheets.v4.SheetsBaseServiceRequest< Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetResponse >
virtual System.Nullable< XgafvEnum > Xgafv [get, set]
 V1 error format. More...
 
virtual string AccessToken [get, set]
 OAuth access token. More...
 
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for response. More...
 
virtual string Callback [get, set]
 JSONP More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. More...
 
virtual string UploadType [get, set]
 Legacy upload protocol for media (e.g. "media", "multipart"). More...
 
virtual string UploadProtocol [get, set]
 Upload protocol for media (e.g. "raw", "multipart"). More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ BatchUpdateRequest()

Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.BatchUpdateRequest ( Google.Apis.Services.IClientService  service,
Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetRequest  body,
string  spreadsheetId 
)
inline

Constructs a new BatchUpdate request.

Member Function Documentation

◆ GetBody()

override object Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.GetBody ( )
inlineprotected

summary>Gets the method name.

◆ InitParameters()

override void Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.InitParameters ( )
inlineprotected

Initializes BatchUpdate parameter list.

Property Documentation

◆ HttpMethod

override string Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.HttpMethod
get

summary>Gets the REST path.

◆ MethodName

override string Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.MethodName
get

summary>Gets the HTTP method.

◆ SpreadsheetId

virtual string Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdateRequest.SpreadsheetId
get

The spreadsheet to apply the updates to.


The documentation for this class was generated from the following file: