Spreadsheets
class Spreadsheets extends Resource (View source)
The "spreadsheets" collection of methods.
Typical usage is:
$sheetsService = new Google\Service\Sheets(...);
$spreadsheets = $sheetsService->spreadsheets;Methods
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)
Creates a spreadsheet, returning the newly created spreadsheet.
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID. By default, data within grids is not returned. You can
include grid data in one of 2 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, as a best
practice, retrieve only the specific spreadsheet fields that you want. To
retrieve only subsets of spreadsheet data, use the ranges URL parameter.
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 returns the portions of the spreadsheet that intersect
ranges matched by any of the filters. By default, data within grids is not
returned. You can include grid data one of 2 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, as a best
practice, retrieve only the specific spreadsheet fields that you want.
Details
BatchUpdateSpreadsheetResponse
batchUpdate(string $spreadsheetId, BatchUpdateSpreadsheetRequest $postBody, array $optParams = [])
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)
Spreadsheet
create(Spreadsheet $postBody, array $optParams = [])
Creates a spreadsheet, returning the newly created spreadsheet.
(spreadsheets.create)
Spreadsheet
get(string $spreadsheetId, array $optParams = [])
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID. By default, data within grids is not returned. You can
include grid data in one of 2 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, as a best
practice, retrieve only the specific spreadsheet fields that you want. To
retrieve only subsets of spreadsheet data, use the ranges URL parameter.
Ranges are specified using A1 notation.
You can define a single cell (for example, A1) or multiple cells (for
example, A1:D5). You can also get cells from other sheets within the same
spreadsheet (for example, Sheet2!A1:C4) or retrieve multiple ranges at once
(for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiting the range
returns only the portions of the spreadsheet that intersect the requested
ranges. (spreadsheets.get)
Spreadsheet
getByDataFilter(string $spreadsheetId, GetSpreadsheetByDataFilterRequest $postBody, array $optParams = [])
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 returns the portions of the spreadsheet that intersect
ranges matched by any of the filters. By default, data within grids is not
returned. You can include grid data one of 2 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, as a best
practice, retrieve only the specific spreadsheet fields that you want.
(spreadsheets.getByDataFilter)