Methods summary
public
Google_Service_Sheets_AppendValuesResponse
|
#
append( string $spreadsheetId, string $range, Google_Service_Sheets_ValueRange $postBody, array $optParams = array() )
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](/sheets/api/samples/writing#append_values) for specific details of how
tables are detected and data is appended.
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](/sheets/api/samples/writing#append_values) 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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $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.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool includeValuesInResponse Determines if the update response should include
the values of the cells that were appended. By default, responses do not include
the updated values.
string responseValueRenderOption Determines how values in the response should be
rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
string insertDataOption How the input data should be inserted.
string valueInputOption How the input data should be interpreted.
string responseDateTimeRenderOption Determines how dates, times, and durations
in the response should be rendered. This is ignored if
response_value_render_option is FORMATTED_VALUE. The default dateTime render
option is [DateTimeRenderOption.SERIAL_NUMBER].
|
public
Google_Service_Sheets_BatchClearValuesResponse
|
#
batchClear( string $spreadsheetId, Google_Service_Sheets_BatchClearValuesRequest $postBody, array $optParams = array() )
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. (values.batchClear)
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. (values.batchClear)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_BatchClearValuesByDataFilterResponse
|
#
batchClearByDataFilter( string $spreadsheetId, Google_Service_Sheets_BatchClearValuesByDataFilterRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_BatchGetValuesResponse
|
#
batchGet( string $spreadsheetId, array $optParams = array() )
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 from a spreadsheet. The caller must
specify the spreadsheet ID and one or more ranges. (values.batchGet)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to retrieve data from.
- $optParams
- Optional parameters.
Returns
Opt_param
string ranges The A1 notation of the values to retrieve.
string majorDimension The major dimension that results should use. For example,
if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting
range=A1:B2,majorDimension=ROWS returns [[1,2],[3,4]],
whereas requesting range=A1:B2,majorDimension=COLUMNS returns
[[1,3],[2,4]].
string valueRenderOption How values should be represented in the output. The
default render option is ValueRenderOption.FORMATTED_VALUE.
string dateTimeRenderOption How dates, times, and durations should be
represented in the output. This is ignored if value_render_option is
FORMATTED_VALUE. The default dateTime render option is
[DateTimeRenderOption.SERIAL_NUMBER].
|
public
Google_Service_Sheets_BatchGetValuesByDataFilterResponse
|
#
batchGetByDataFilter( string $spreadsheetId, Google_Service_Sheets_BatchGetValuesByDataFilterRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to retrieve data from.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_BatchUpdateValuesResponse
|
#
batchUpdate( string $spreadsheetId, Google_Service_Sheets_BatchUpdateValuesRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_BatchUpdateValuesByDataFilterResponse
|
#
batchUpdateByDataFilter( string $spreadsheetId, Google_Service_Sheets_BatchUpdateValuesByDataFilterRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_ClearValuesResponse
|
#
clear( string $spreadsheetId, string $range, Google_Service_Sheets_ClearValuesRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $range
- The A1 notation of the values to clear.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_ValueRange
|
#
get( string $spreadsheetId, string $range, array $optParams = array() )
Returns a range of values from a spreadsheet. The caller must specify the
spreadsheet ID and a range. (values.get)
Returns a range of values from a spreadsheet. The caller must specify the
spreadsheet ID and a range. (values.get)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to retrieve data from.
- $range
- The A1 notation of the values to retrieve.
- $optParams
- Optional parameters.
Returns
Opt_param
string majorDimension The major dimension that results should use. For example,
if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting
range=A1:B2,majorDimension=ROWS returns [[1,2],[3,4]],
whereas requesting range=A1:B2,majorDimension=COLUMNS returns
[[1,3],[2,4]].
string valueRenderOption How values should be represented in the output. The
default render option is ValueRenderOption.FORMATTED_VALUE.
string dateTimeRenderOption How dates, times, and durations should be
represented in the output. This is ignored if value_render_option is
FORMATTED_VALUE. The default dateTime render option is
[DateTimeRenderOption.SERIAL_NUMBER].
|
public
Google_Service_Sheets_UpdateValuesResponse
|
#
update( string $spreadsheetId, string $range, Google_Service_Sheets_ValueRange $postBody, array $optParams = array() )
Sets values in a range of a spreadsheet. The caller must specify the
spreadsheet ID, range, and a valueInputOption. (values.update)
Sets values in a range of a spreadsheet. The caller must specify the
spreadsheet ID, range, and a valueInputOption. (values.update)
Parameters
- $spreadsheetId
- The ID of the spreadsheet to update.
- $range
- The A1 notation of the values to update.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string responseValueRenderOption Determines how values in the response should be
rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
string valueInputOption How the input data should be interpreted.
string responseDateTimeRenderOption Determines how dates, times, and durations
in the response should be rendered. This is ignored if
response_value_render_option is FORMATTED_VALUE. The default dateTime render
option is DateTimeRenderOption.SERIAL_NUMBER.
bool includeValuesInResponse Determines if the update response should include
the values of the cells that were updated. By default, responses do not include
the updated values. If the range to write was larger than the range actually
written, the response includes all values in the requested range (excluding
trailing empty rows and columns).
|
Google_Service_Sheets_SpreadsheetsValues_Resource