Class Google_Service_Sheets_Spreadsheets_Resource
The "spreadsheets" collection of methods. Typical usage is:
$sheetsService = new Google_Service_Sheets(...);
$spreadsheets = $sheetsService->spreadsheets;
-
Google_Service_Resource
-
Google_Service_Sheets_Spreadsheets_Resource
Located at Sheets.php
Methods summary
public
Google_Service_Sheets_BatchUpdateSpreadsheetResponse
|
#
batchUpdate( string $spreadsheetId, Google_Service_Sheets_BatchUpdateSpreadsheetRequest $postBody, array $optParams = array() )
Applies one or more updates to the spreadsheet.
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.
(spreadsheets.batchUpdate)
Parameters
- $spreadsheetId
- The spreadsheet to apply the updates to.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_Spreadsheet
|
#
create( Google_Service_Sheets_Spreadsheet $postBody, array $optParams = array() )
Creates a spreadsheet, returning the newly created spreadsheet.
(spreadsheets.create)
Creates a spreadsheet, returning the newly created spreadsheet.
(spreadsheets.create)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Sheets_Spreadsheet
|
#
get( string $spreadsheetId, array $optParams = array() )
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID.
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID.
By default, data within grids will not be returned. You can include grid data
one of two 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, it is recommended to retrieve only the specific
fields of the spreadsheet that you want.
To retrieve only subsets of the spreadsheet, use the ranges URL parameter.
Multiple ranges can be specified. Limiting the range will return only the
portions of the spreadsheet that intersect the requested ranges. Ranges are
specified using A1 notation. (spreadsheets.get)
Parameters
- $spreadsheetId
- The spreadsheet to request.
- $optParams
- Optional parameters.
Returns
Opt_param
string ranges The ranges to retrieve from the spreadsheet.
bool includeGridData True if grid data should be returned. This parameter is
ignored if a field mask was set in the request.
|
public
Google_Service_Sheets_Spreadsheet
|
#
getByDataFilter( string $spreadsheetId, Google_Service_Sheets_GetSpreadsheetByDataFilterRequest $postBody, array $optParams = array() )
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID.
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 will
return the portions of the spreadsheet that intersect ranges matched by any of
the filters.
By default, data within grids will not be returned. You can include grid data
one of two 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, it is recommended to retrieve only the specific
fields of the spreadsheet that you want. (spreadsheets.getByDataFilter)
Parameters
- $spreadsheetId
- The spreadsheet to request.
- $postBody
- $optParams
- Optional parameters.
Returns
|