Class SpreadsheetsResource

The "spreadsheets" collection of methods.

Inheritance

object

SpreadsheetsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Sheets.v4

Assembly: Google.Apis.Sheets.v4.dll

Syntax

public class SpreadsheetsResource

Constructors

SpreadsheetsResource(IClientService)

Constructs a new resource.

Declaration

public SpreadsheetsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

DeveloperMetadata

Gets the DeveloperMetadata resource.

Declaration

public virtual SpreadsheetsResource.DeveloperMetadataResource DeveloperMetadata { get; }

Property Value

Type	Description
SpreadsheetsResource.DeveloperMetadataResource

Sheets

Gets the Sheets resource.

Declaration

public virtual SpreadsheetsResource.SheetsResource Sheets { get; }

Property Value

Type	Description
SpreadsheetsResource.SheetsResource

Values

Gets the Values resource.

Declaration

public virtual SpreadsheetsResource.ValuesResource Values { get; }

Property Value

Type	Description
SpreadsheetsResource.ValuesResource

Methods

BatchUpdate(BatchUpdateSpreadsheetRequest, string)

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.

Declaration

public virtual SpreadsheetsResource.BatchUpdateRequest BatchUpdate(BatchUpdateSpreadsheetRequest body, string spreadsheetId)

Parameters

Type	Name	Description
BatchUpdateSpreadsheetRequest	body	The body of the request.
string	spreadsheetId	The spreadsheet to apply the updates to.

Returns

Type	Description
SpreadsheetsResource.BatchUpdateRequest

Create(Spreadsheet)

Creates a spreadsheet, returning the newly created spreadsheet.

Declaration

public virtual SpreadsheetsResource.CreateRequest Create(Spreadsheet body)

Parameters

Type	Name	Description
Spreadsheet	body	The body of the request.

Returns

Type	Description
SpreadsheetsResource.CreateRequest

Get(string)

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 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, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using A1 notation. You can define a single cell (for example, A1) or multiple cells (for example, A1:D5). You can also get cells from other sheets within the same spreadsheet (for example, Sheet2!A1:C4) or retrieve multiple ranges at once (for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.

Declaration

public virtual SpreadsheetsResource.GetRequest Get(string spreadsheetId)

Parameters

Type	Name	Description
string	spreadsheetId	The spreadsheet to request.

Returns

Type	Description
SpreadsheetsResource.GetRequest

GetByDataFilter(GetSpreadsheetByDataFilterRequest, string)

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 returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 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, as a best practice, retrieve only the specific spreadsheet fields that you want.

Declaration

public virtual SpreadsheetsResource.GetByDataFilterRequest GetByDataFilter(GetSpreadsheetByDataFilterRequest body, string spreadsheetId)

Parameters

Type	Name	Description
GetSpreadsheetByDataFilterRequest	body	The body of the request.
string	spreadsheetId	The spreadsheet to request.

Returns

Type	Description
SpreadsheetsResource.GetByDataFilterRequest