NAME
Net::Google::Spreadsheets::Worksheet - Representation of worksheet.
SYNOPSIS
my $service = Net::Google::Spreadsheets->new(
username => 'mygoogleaccount@example.com',
password => 'mypassword',
);
my $ss = $service->spreadsheet(
{
key => 'key_of_a_spreasheet'
}
);
my $worksheet = $ss->worksheet({title => 'Sheet1'});
# update cell by batch request
$worksheet->batchupdate_cell(
{col => 1, row => 1, input_value => 'name'},
{col => 2, row => 1, input_value => 'nick'},
{col => 3, row => 1, input_value => 'mail'},
{col => 4, row => 1, input_value => 'age'},
);
# get a cell object
my $cell = $worksheet->cell({col => 1, row => 1});
# add a row
my $new_row = $worksheet->add_row(
{
name => 'Nobuo Danjou',
nick => 'lopnor',
mail => 'danjou@soffritto.org',
age => '33',
}
);
# get rows
my @rows = $worksheet->rows;
# search rows
@rows = $worksheet->rows({sq => 'age > 20'});
# search a row
my $row = $worksheet->row({sq => 'name = "Nobuo Danjou"'});
# delete the worksheet
# Note that this will fail if the worksheet is the only one
# within the spreadsheet.
$worksheet->delete;
METHODS
rows(\%condition)
Returns a list of Net::Google::Spreadsheets::Row objects. Acceptable arguments are:
sq
Structured query on the full text in the worksheet. see the URL below for detail.
orderby
Set column name to use for ordering.
reverse
Set 'true' or 'false'. The default is 'false'.
See http://code.google.com/intl/en/apis/spreadsheets/docs/3.0/reference.html#ListParameters for details. Note that 'the first row of the worksheet' you can see with the browser is 'header' for the rows, so you can't get it with this method. Use cell(s) method instead if you need to access them.
row(\%condition)
Returns first item of rows(\%condition) if available.
add_row(\%contents)
Creates new row and returns a Net::Google::Spreadsheets::Row object representing it. Arguments are contents of a row as a hashref.
my $row = $ws->add_row(
{
name => 'Nobuo Danjou',
nick => 'lopnor',
mail => 'danjou@soffritto.org',
age => '33',
}
);
cells(\%args)
Returns a list of Net::Google::Spreadsheets::Cell objects. Acceptable arguments are:
min-row
max-row
min-col
max-col
range
return-empty
See http://code.google.com/intl/en/apis/spreadsheets/docs/3.0/reference.html#CellParameters for details.
cell(\%args)
Returns Net::Google::Spreadsheets::Cell object. Arguments are:
col
row
batchupdate_cell(@args)
update multiple cells with a batch request. Pass a list of hash references containing:
col
row
input_value
delete
Deletes the worksheet. Note that this will fail if the worksheet is only one within the spreadsheet.
SEE ALSO
https://developers.google.com/google-apps/spreadsheets/
AUTHOR
Nobuo Danjou <danjou@soffritto.org>