Google.Apis.Sheets.v4.SpreadsheetsResource Class Reference

The "spreadsheets" collection of methods. More...

Classes
class	BatchUpdateRequest
	Applies one or more updates to the spreadsheet. More...
class	CreateRequest
	Creates a spreadsheet, returning the newly created spreadsheet. More...
class	DeveloperMetadataResource
	The "developerMetadata" collection of methods. More...
class	GetByDataFilterRequest
	Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. More...
class	GetRequest
	Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. More...
class	SheetsResource
	The "sheets" collection of methods. More...
class	ValuesResource
	The "values" collection of methods. More...

Public Member Functions
	SpreadsheetsResource (Google.Apis.Services.IClientService service)
	Constructs a new resource. More...
virtual BatchUpdateRequest	BatchUpdate (Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetRequest body, string spreadsheetId)
	Applies one or more updates to the spreadsheet. More...
virtual CreateRequest	Create (Google.Apis.Sheets.v4.Data.Spreadsheet body)
	Creates a spreadsheet, returning the newly created spreadsheet. More...
virtual GetRequest	Get (string spreadsheetId)
	Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. More...
virtual GetByDataFilterRequest	GetByDataFilter (Google.Apis.Sheets.v4.Data.GetSpreadsheetByDataFilterRequest body, string spreadsheetId)
	Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. More...

Properties
virtual DeveloperMetadataResource	DeveloperMetadata [get]
	Gets the DeveloperMetadata resource. More...
virtual SheetsResource	Sheets [get]
	Gets the Sheets resource. More...
virtual ValuesResource	Values [get]
	Gets the Values resource. More...

Detailed Description

The "spreadsheets" collection of methods.

Constructor & Destructor Documentation

SpreadsheetsResource()

Google.Apis.Sheets.v4.SpreadsheetsResource.SpreadsheetsResource ( Google.Apis.Services.IClientService  service )

inline

Constructs a new resource.

Member Function Documentation

BatchUpdate()

virtual BatchUpdateRequest Google.Apis.Sheets.v4.SpreadsheetsResource.BatchUpdate ( Google.Apis.Sheets.v4.Data.BatchUpdateSpreadsheetRequest  body, string  spreadsheetId  )

inlinevirtual

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.

Parameters

body	The body of the request.
spreadsheetId	The spreadsheet to apply the updates to.

Create()

virtual CreateRequest Google.Apis.Sheets.v4.SpreadsheetsResource.Create ( Google.Apis.Sheets.v4.Data.Spreadsheet  body )

inlinevirtual

Creates a spreadsheet, returning the newly created spreadsheet.

Parameters

body	The body of the request.

Get()

virtual GetRequest Google.Apis.Sheets.v4.SpreadsheetsResource.Get ( string  spreadsheetId )

inlinevirtual

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.

By default, data within grids will not be returned. You can include grid data one of two ways:

• Specify a field mask listing your desired fields using the fields URL parameter in HTTP
• Set the includeGridData URL parameter to true. If a field mask is set, the includeGridData parameter is ignored

For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

Parameters

spreadsheetId

The spreadsheet to request.

GetByDataFilter()

virtual GetByDataFilterRequest Google.Apis.Sheets.v4.SpreadsheetsResource.GetByDataFilter ( Google.Apis.Sheets.v4.Data.GetSpreadsheetByDataFilterRequest  body, string  spreadsheetId  )

inlinevirtual

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.

This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters.

By default, data within grids will not be returned. You can include grid data one of two ways:

• Specify a field mask listing your desired fields using the fields URL parameter in HTTP
• Set the includeGridData parameter to true. If a field mask is set, the includeGridData parameter is ignored

For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

Parameters

body	The body of the request.
spreadsheetId	The spreadsheet to request.

Property Documentation

DeveloperMetadata

virtual DeveloperMetadataResource Google.Apis.Sheets.v4.SpreadsheetsResource.DeveloperMetadata

get

Gets the DeveloperMetadata resource.

Sheets

virtual SheetsResource Google.Apis.Sheets.v4.SpreadsheetsResource.Sheets

get

Gets the Sheets resource.

Values

virtual ValuesResource Google.Apis.Sheets.v4.SpreadsheetsResource.Values

get

Gets the Values resource.

---

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

• Google.Apis.Sheets.v4.cs