SpreadsheetsValues
class SpreadsheetsValues extends Resource (View source)
The "values" collection of methods.
Typical usage is:
$sheetsService = new Google\Service\Sheets(...);
$values = $sheetsService->spreadsheets_values;Methods
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.
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. (values.batchClear)
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. (values.batchClearByDataFilter)
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. (values.batchGet)
Returns one or more ranges of values that match the specified data filters.
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. (values.batchUpdateByDataFilter)
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. (values.clear)
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. (values.get)
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. (values.update)
Details
AppendValuesResponse
append(string $spreadsheetId, string $range, ValueRange $postBody, array $optParams = [])
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.
(values.append)
BatchClearValuesResponse
batchClear(string $spreadsheetId, BatchClearValuesRequest $postBody, array $optParams = [])
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. (values.batchClear)
BatchClearValuesByDataFilterResponse
batchClearByDataFilter(string $spreadsheetId, BatchClearValuesByDataFilterRequest $postBody, array $optParams = [])
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. (values.batchClearByDataFilter)
BatchGetValuesResponse
batchGet(string $spreadsheetId, array $optParams = [])
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. (values.batchGet)
BatchGetValuesByDataFilterResponse
batchGetByDataFilter(string $spreadsheetId, BatchGetValuesByDataFilterRequest $postBody, array $optParams = [])
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. (values.batchGetByDataFilter)
BatchUpdateValuesResponse
batchUpdate(string $spreadsheetId, BatchUpdateValuesRequest $postBody, array $optParams = [])
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
(values.batchUpdate)
BatchUpdateValuesByDataFilterResponse
batchUpdateByDataFilter(string $spreadsheetId, BatchUpdateValuesByDataFilterRequest $postBody, array $optParams = [])
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. (values.batchUpdateByDataFilter)
ClearValuesResponse
clear(string $spreadsheetId, string $range, ClearValuesRequest $postBody, array $optParams = [])
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. (values.clear)
ValueRange
get(string $spreadsheetId, string $range, array $optParams = [])
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. (values.get)
UpdateValuesResponse
update(string $spreadsheetId, string $range, ValueRange $postBody, array $optParams = [])
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. (values.update)