view release on metacpan or  search on metacpan

lib/Google/RestApi/SheetsApi4.pm  view on Meta::CPAN

Opens a new spreadsheet from the given id, uri, or name.

%args consists of any args passed to Spreadsheet->new routine (which see).

=item transaction();

Returns the last API transaction details (delegates to L<Google::RestApi>).

=item stats();

Returns API call statistics (delegates to L<Google::RestApi>).

=item reset_stats();

Resets API call statistics (delegates to L<Google::RestApi>).

=item rest_api();

Returns the underlying L<Google::RestApi> instance.

=back

=head1 REQUEST CLASSES

The Request classes provide methods for building Google Sheets API batchUpdate requests.
These are typically called on Range, Worksheet, or Spreadsheet objects which inherit from
the appropriate Request class. The requests are staged and then submitted via C<submit_requests()>.

=head2 Google::RestApi::SheetsApi4::Request::Spreadsheet

Spreadsheet-level requests (inherited by Spreadsheet objects):

=over

=item add_worksheet(%args)

Add a new worksheet. Args: C<name> or C<title>, C<grid_properties> (hashref with C<rows>/C<cols>), C<tab_color> (hashref with C<red>/C<blue>/C<green>).

=item update_spreadsheet_properties(properties => \%props, fields => $fields)

Update spreadsheet properties directly.

=item ss_title($title)

Set the spreadsheet title.

=item ss_locale($locale)

Set the spreadsheet locale (e.g., 'en_US').

=item ss_time_zone($tz)

Set the spreadsheet time zone (e.g., 'America/New_York').

=item ss_auto_recalc($mode)

Set auto recalculation mode ('ON_CHANGE', 'MINUTE', 'HOUR').

=item ss_iteration_count($count)

Set maximum iterations for circular references.

=item ss_iteration_threshold($threshold)

Set convergence threshold for iterative calculations.

=item ss_default_format($format)

Set the default cell format for the spreadsheet.

=item add_protected_range(%args)

Add a protected range. Args: C<range> (required hashref), C<description>, C<warning_only>, C<requesting_user>, C<editors>.

=item update_protected_range(%args)

Update a protected range. Args: C<id> (required), C<range>, C<description>, C<warning_only>, C<requesting_user>, C<editors>, C<fields>.

=item delete_protected_range($id)

Delete a protected range by ID.

=back

=head2 Google::RestApi::SheetsApi4::Request::Spreadsheet::Worksheet

Worksheet-level requests (inherited by Worksheet objects):

=head3 Worksheet Properties

=over

=item ws_rename($name)

Rename the worksheet.

=item ws_index($index)

Set the worksheet tab position (0-indexed).

=item ws_hide($bool) / ws_hidden($bool)

Hide or show the worksheet.

=item ws_right_to_left($bool) / ws_left_to_right($bool)

Set the text direction for the worksheet.

=item ws_tab_color($color_hashref)

Set the tab color. Color is a hashref with C<red>/C<blue>/C<green>/C<alpha> keys (0-1 values).

=item ws_tab_red($value) / ws_tab_blue($value) / ws_tab_green($value) / ws_tab_alpha($value)

Set individual tab color components (0-1 values).

=item ws_tab_black() / ws_tab_white()

Set tab color to black or white.

=item update_worksheet_properties(properties => \%props, fields => $fields)