sheets  v4
Classes | Public Member Functions | List of all members
Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource Class Reference

The "values" collection of methods. More...

Classes

class  AppendRequest
 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. More...
 
class  BatchClearByDataFilterRequest
 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. More...
 
class  BatchClearRequest
 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, data validation, etc..) are kept. More...
 
class  BatchGetByDataFilterRequest
 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. More...
 
class  BatchGetRequest
 Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. More...
 
class  BatchUpdateByDataFilterRequest
 Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. More...
 
class  BatchUpdateRequest
 Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. More...
 
class  ClearRequest
 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. More...
 
class  GetRequest
 Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. More...
 
class  UpdateRequest
 Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. More...
 

Public Member Functions

 ValuesResource (Google.Apis.Services.IClientService service)
 Constructs a new resource. More...
 
virtual AppendRequest Append (Google.Apis.Sheets.v4.Data.ValueRange body, string spreadsheetId, string range)
 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. More...
 
virtual BatchClearRequest BatchClear (Google.Apis.Sheets.v4.Data.BatchClearValuesRequest body, string spreadsheetId)
 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, data validation, etc..) are kept. More...
 
virtual BatchClearByDataFilterRequest BatchClearByDataFilter (Google.Apis.Sheets.v4.Data.BatchClearValuesByDataFilterRequest body, string spreadsheetId)
 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. More...
 
virtual BatchGetRequest BatchGet (string spreadsheetId)
 Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. More...
 
virtual BatchGetByDataFilterRequest BatchGetByDataFilter (Google.Apis.Sheets.v4.Data.BatchGetValuesByDataFilterRequest body, string spreadsheetId)
 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. More...
 
virtual BatchUpdateRequest BatchUpdate (Google.Apis.Sheets.v4.Data.BatchUpdateValuesRequest body, string spreadsheetId)
 Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. More...
 
virtual BatchUpdateByDataFilterRequest BatchUpdateByDataFilter (Google.Apis.Sheets.v4.Data.BatchUpdateValuesByDataFilterRequest body, string spreadsheetId)
 Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. More...
 
virtual ClearRequest Clear (Google.Apis.Sheets.v4.Data.ClearValuesRequest body, string spreadsheetId, string range)
 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. More...
 
virtual GetRequest Get (string spreadsheetId, string range)
 Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. More...
 
virtual UpdateRequest Update (Google.Apis.Sheets.v4.Data.ValueRange body, string spreadsheetId, string range)
 Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. More...
 

Detailed Description

The "values" collection of methods.

Constructor & Destructor Documentation

◆ ValuesResource()

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

Constructs a new resource.

Member Function Documentation

◆ Append()

virtual AppendRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.Append ( Google.Apis.Sheets.v4.Data.ValueRange  body,
string  spreadsheetId,
string  range 
)
inlinevirtual

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.

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.
rangeThe A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.

◆ BatchClear()

virtual BatchClearRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.BatchClear ( Google.Apis.Sheets.v4.Data.BatchClearValuesRequest  body,
string  spreadsheetId 
)
inlinevirtual

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, data validation, etc..) are kept.

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.

◆ BatchClearByDataFilter()

virtual BatchClearByDataFilterRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.BatchClearByDataFilter ( Google.Apis.Sheets.v4.Data.BatchClearValuesByDataFilterRequest  body,
string  spreadsheetId 
)
inlinevirtual

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.

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.

◆ BatchGet()

virtual BatchGetRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.BatchGet ( string  spreadsheetId)
inlinevirtual

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

Parameters
spreadsheetIdThe ID of the spreadsheet to retrieve data from.

◆ BatchGetByDataFilter()

virtual BatchGetByDataFilterRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.BatchGetByDataFilter ( Google.Apis.Sheets.v4.Data.BatchGetValuesByDataFilterRequest  body,
string  spreadsheetId 
)
inlinevirtual

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.

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to retrieve data from.

◆ BatchUpdate()

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

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

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.

◆ BatchUpdateByDataFilter()

virtual BatchUpdateByDataFilterRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.BatchUpdateByDataFilter ( Google.Apis.Sheets.v4.Data.BatchUpdateValuesByDataFilterRequest  body,
string  spreadsheetId 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.

◆ Clear()

virtual ClearRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.Clear ( Google.Apis.Sheets.v4.Data.ClearValuesRequest  body,
string  spreadsheetId,
string  range 
)
inlinevirtual

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.

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.
rangeThe A1 notation of the values to clear.

◆ Get()

virtual GetRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.Get ( string  spreadsheetId,
string  range 
)
inlinevirtual

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

Parameters
spreadsheetIdThe ID of the spreadsheet to retrieve data from.
rangeThe A1 notation of the values to retrieve.

◆ Update()

virtual UpdateRequest Google.Apis.Sheets.v4.SpreadsheetsResource.ValuesResource.Update ( Google.Apis.Sheets.v4.Data.ValueRange  body,
string  spreadsheetId,
string  range 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
spreadsheetIdThe ID of the spreadsheet to update.
rangeThe A1 notation of the values to update.

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