com.google.api.services.sheets.v4

Class Sheets.Spreadsheets.Values

java.lang.Object

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values

Enclosing class:

Sheets.Spreadsheets

public class Sheets.Spreadsheets.Values
extends Object

The "values" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Sheets.Spreadsheets.Values.Append
class	Sheets.Spreadsheets.Values.BatchGet
class	Sheets.Spreadsheets.Values.BatchUpdate
class	Sheets.Spreadsheets.Values.Get
class	Sheets.Spreadsheets.Values.Update

Constructor Summary

Constructors

Constructor and Description
Sheets.Spreadsheets.Values()

Method Summary

Methods

Modifier and Type	Method and Description
Sheets.Spreadsheets.Values.Append	append(String spreadsheetId, String range, ValueRange content) Appends values to a spreadsheet.
Sheets.Spreadsheets.Values.BatchGet	batchGet(String spreadsheetId) Returns one or more ranges of values from a spreadsheet.
Sheets.Spreadsheets.Values.BatchUpdate	batchUpdate(String spreadsheetId, BatchUpdateValuesRequest content) Sets values in one or more ranges of a spreadsheet.
Sheets.Spreadsheets.Values.Get	get(String spreadsheetId, String range) Returns a range of values from a spreadsheet.
Sheets.Spreadsheets.Values.Update	update(String spreadsheetId, String range, ValueRange content) Sets values in a range of a spreadsheet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sheets.Spreadsheets.Values

public Sheets.Spreadsheets.Values()

Method Detail

append

public Sheets.Spreadsheets.Values.Append append(String spreadsheetId,
                                       String range,
                                       ValueRange content)
                                         throws IOException

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/guides/values#appending_values) and [sample code](/sheets/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. Create a request for the method "values.append". This request holds the parameters needed by the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

spreadsheetId - The ID of the spreadsheet to update.

range - The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.

content - the ValueRange

Returns:

the request

Throws:

IOException

batchGet

public Sheets.Spreadsheets.Values.BatchGet batchGet(String spreadsheetId)
                                             throws IOException

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Create a request for the method "values.batchGet". This request holds the parameters needed by the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

spreadsheetId - The ID of the spreadsheet to retrieve data from.

Returns:

the request

Throws:

IOException

batchUpdate

public Sheets.Spreadsheets.Values.BatchUpdate batchUpdate(String spreadsheetId,
                                                 BatchUpdateValuesRequest content)
                                                   throws IOException

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. Create a request for the method "values.batchUpdate". This request holds the parameters needed by the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

spreadsheetId - The ID of the spreadsheet to update.

content - the BatchUpdateValuesRequest

Returns:

the request

Throws:

IOException

get

public Sheets.Spreadsheets.Values.Get get(String spreadsheetId,
                                 String range)
                                   throws IOException

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. Create a request for the method "values.get". This request holds the parameters needed by the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

spreadsheetId - The ID of the spreadsheet to retrieve data from.

range - The A1 notation of the values to retrieve.

Returns:

the request

Throws:

IOException

update

public Sheets.Spreadsheets.Values.Update update(String spreadsheetId,
                                       String range,
                                       ValueRange content)
                                         throws IOException

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. Create a request for the method "values.update". This request holds the parameters needed by the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

spreadsheetId - The ID of the spreadsheet to update.

range - The A1 notation of the values to update.

content - the ValueRange

Returns:

the request

Throws:

IOException