Show / Hide Table of Contents

Class SpreadsheetsResource.ValuesResource

The "values" collection of methods.

Inheritance
System.Object
SpreadsheetsResource.ValuesResource
Inherited Members
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 ValuesResource

Constructors

ValuesResource(IClientService)

Constructs a new resource.

Declaration
public ValuesResource(IClientService service)
Parameters
Type Name Description
Google.Apis.Services.IClientService service

Methods

Append(ValueRange, String, String)

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The valueInputOption only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

Declaration
public virtual SpreadsheetsResource.ValuesResource.AppendRequest Append(ValueRange body, string spreadsheetId, string range)
Parameters
Type Name Description
ValueRange body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

System.String range

The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.

Returns
Type Description
SpreadsheetsResource.ValuesResource.AppendRequest

BatchClear(BatchClearValuesRequest, String)

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchClearRequest BatchClear(BatchClearValuesRequest body, string spreadsheetId)
Parameters
Type Name Description
BatchClearValuesRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchClearRequest

BatchClearByDataFilter(BatchClearValuesByDataFilterRequest, String)

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchClearByDataFilterRequest BatchClearByDataFilter(BatchClearValuesByDataFilterRequest body, string spreadsheetId)
Parameters
Type Name Description
BatchClearValuesByDataFilterRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchClearByDataFilterRequest

BatchGet(String)

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchGetRequest BatchGet(string spreadsheetId)
Parameters
Type Name Description
System.String spreadsheetId

The ID of the spreadsheet to retrieve data from.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchGetRequest

BatchGetByDataFilter(BatchGetValuesByDataFilterRequest, String)

Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchGetByDataFilterRequest BatchGetByDataFilter(BatchGetValuesByDataFilterRequest body, string spreadsheetId)
Parameters
Type Name Description
BatchGetValuesByDataFilterRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to retrieve data from.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchGetByDataFilterRequest

BatchUpdate(BatchUpdateValuesRequest, String)

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchUpdateRequest BatchUpdate(BatchUpdateValuesRequest body, string spreadsheetId)
Parameters
Type Name Description
BatchUpdateValuesRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchUpdateRequest

BatchUpdateByDataFilter(BatchUpdateValuesByDataFilterRequest, String)

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.

Declaration
public virtual SpreadsheetsResource.ValuesResource.BatchUpdateByDataFilterRequest BatchUpdateByDataFilter(BatchUpdateValuesByDataFilterRequest body, string spreadsheetId)
Parameters
Type Name Description
BatchUpdateValuesByDataFilterRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

Returns
Type Description
SpreadsheetsResource.ValuesResource.BatchUpdateByDataFilterRequest

Clear(ClearValuesRequest, String, String)

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Declaration
public virtual SpreadsheetsResource.ValuesResource.ClearRequest Clear(ClearValuesRequest body, string spreadsheetId, string range)
Parameters
Type Name Description
ClearValuesRequest body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

System.String range

The A1 notation or R1C1 notation of the values to clear.

Returns
Type Description
SpreadsheetsResource.ValuesResource.ClearRequest

Get(String, String)

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

Declaration
public virtual SpreadsheetsResource.ValuesResource.GetRequest Get(string spreadsheetId, string range)
Parameters
Type Name Description
System.String spreadsheetId

The ID of the spreadsheet to retrieve data from.

System.String range

The A1 notation or R1C1 notation of the range to retrieve values from.

Returns
Type Description
SpreadsheetsResource.ValuesResource.GetRequest

Update(ValueRange, String, String)

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.

Declaration
public virtual SpreadsheetsResource.ValuesResource.UpdateRequest Update(ValueRange body, string spreadsheetId, string range)
Parameters
Type Name Description
ValueRange body

The body of the request.

System.String spreadsheetId

The ID of the spreadsheet to update.

System.String range

The A1 notation of the values to update.

Returns
Type Description
SpreadsheetsResource.ValuesResource.UpdateRequest
In This Article
Back to top