Google::RestApi::SheetsApi4::Spreadsheet - Represents a Google Spreadsheet.
See the description and synopsis at Google::RestApi::SheetsApi4.
Google::RestApi::SheetsApi4
Google::RestApi::SheetsApi4::Spreadsheet
Google::RestApi::SheetsApi4::Worksheet
Google::RestApi::SheetsApi4::Range
Google::RestApi::SheetsApi4::Range::All
Google::RestApi::SheetsApi4::Range::Col
Google::RestApi::SheetsApi4::Range::Row
Google::RestApi::SheetsApi4::Range::Cell
Google::RestApi::SheetsApi4::RangeGroup
Google::RestApi::SheetsApi4::RangeGroup::Iterator
Google::RestApi::SheetsApi4::RangeGroup::Tie
Google::RestApi::SheetsApi4::RangeGroup::Tie::Iterator
Google::RestApi::SheetsApi4::Request::Spreadsheet
Google::RestApi::SheetsApi4::Request::Spreadsheet::Worksheet
Google::RestApi::SheetsApi4::Request::Spreadsheet::Worksheet::Range
Creates a new instance of a Spreadsheet object.
%args consists of:
sheets_api <SheetsApi4>: The parent SheetsApi4 object.
sheets_api
id <string>: The id of the spreadsheet (Google Drive file ID).
id
name <string>: The name of the spreadsheet (as shown in Google Drive).
name
title <string>: An alias for name.
title
uri <string>: The spreadsheet ID extracted from the overall URI.
uri
cache_seconds <int>: Cache information for this many seconds (default to 5, 0 disables).
cache_seconds
You would not normally call this directly, you would obtain it from the SheetsApi4::open_spreadsheet routine.
Only one of id/name/title/uri should be specified and this API will derive the others as necessary.
The cache exists so that repeated calls for the same attributes or worksheet properties doesn't keep hammering the Google API over and over. The default is 5 seconds. See 'cache_seconds' below.
Calls the parent SheetsApi4's 'api' routine adding the sheet file ID, and passing through any args such as content, params, headers, etc.
You would not normally call this directly unless you were making a Google API call not currently supported by this API framework.
Returns the response hash from Google API.
Returns the spreadsheet id (the Google Drive file id).
Returns the URI of this spreadsheet.
Returns the name of the spreadsheet.
An alias for 'spreadsheet_name'.
Returns the spreadsheet attributes of the specified fields.
Returns the spreadsheet property attributes of the specified fields.
Returns an array ref of the properties of the worksheets owned by this spreadsheet.
Sets the caching time in seconds. Calling will always delete the existing cache. 0 disables the cache (not recommended).
Deletes all the protected ranges from all the worksheets owned by this spreadsheet.
Returns the properties of the named range passed, or if false is passed, all the named ranges for this spreadsheet.
Creates a copy of this spreadsheet and passes any args to the Google Drive file copy routine.
Deletes this spreadsheet from Google Drive.
Creates a range group with the contained ranges. See the RangeGroup object.
%args is a hash of key => Range object pairs.
Ties the given 'key => range' pairs into a tied range group. The range group can be used to send batch values (API batchUpdate) and batch requests (API batchRequests) as a single call once all the changes have been made to the overall hash.
Turning on the 'fetch_range' property will return the underlying ranges on fetch so that formatting for the ranges can be set. You would normally only turn this on for a short time, and turn it off when the underlying batch requests have been submitted.
$tied = $ss->tie(id => $range_cell); tied(%$tied)->fetch_range(1); $tied->{id}->bold()->red()->background_blue(); tied(%$tied)->fetch_range(0)->submit_requests();
See also Worksheet::tie.
ranges <arrayref>: The ranges that have requests to be sent in one batchUpdate Google API call.
ranges
content <hashref>: Any additional content to be sent to the Google API for this batch submit, for any customized content that needs to be passed.
content
Submits the batch values (Google API's batchUpdate) for the specified ranges. Content is passed to the SheetsApi4's 'api' call for any customized content you may need to pass.
ranges <arrayref>: The ranges that have requests to be sent in one batchRequest Google API call.
Submits the batch requests (Google API's batchRequest) for the specified ranges. Content is passed to the SheetsApi4's 'api' call for any customized content you may need to pass.
Returns all the protected ranges for this spreadsheet.
Creates a new Worksheet object, passing the args to that object's 'new' routine (which see).
Returns the SheetsApi4 object.
Robin Murray mvsjes@cpan.org
Copyright (c) 2021, Robin Murray. All rights reserved.
This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.
To install Google::RestApi, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Google::RestApi
CPAN shell
perl -MCPAN -e shell install Google::RestApi
For more information on module installation, please visit the detailed CPAN module installation guide.