target.apidocs.com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sheets Show documentation

There is a newer version: v4-rev20240826-2.0.0

Show newest version







Sheets.Spreadsheets.Values (Google Sheets API v4-rev20220322-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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.BatchClear 


class 
Sheets.Spreadsheets.Values.BatchClearByDataFilter 


class 
Sheets.Spreadsheets.Values.BatchGet 


class 
Sheets.Spreadsheets.Values.BatchGetByDataFilter 


class 
Sheets.Spreadsheets.Values.BatchUpdate 


class 
Sheets.Spreadsheets.Values.BatchUpdateByDataFilter 


class 
Sheets.Spreadsheets.Values.Clear 


class 
Sheets.Spreadsheets.Values.Get 


class 
Sheets.Spreadsheets.Values.Update 









Constructor Summary

Constructors 

Constructor and Description


Values() 









Method Summary

All Methods Instance Methods Concrete 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.BatchClear
batchClear(String spreadsheetId,
          BatchClearValuesRequest content)
Clears one or more ranges of values from a spreadsheet.



Sheets.Spreadsheets.Values.BatchClearByDataFilter
batchClearByDataFilter(String spreadsheetId,
                      BatchClearValuesByDataFilterRequest content)
Clears one or more ranges of values from a spreadsheet.



Sheets.Spreadsheets.Values.BatchGet
batchGet(String spreadsheetId)
Returns one or more ranges of values from a spreadsheet.



Sheets.Spreadsheets.Values.BatchGetByDataFilter
batchGetByDataFilter(String spreadsheetId,
                    BatchGetValuesByDataFilterRequest content)
Returns one or more ranges of values that match the specified data filters.



Sheets.Spreadsheets.Values.BatchUpdate
batchUpdate(String spreadsheetId,
           BatchUpdateValuesRequest content)
Sets values in one or more ranges of a spreadsheet.



Sheets.Spreadsheets.Values.BatchUpdateByDataFilter
batchUpdateByDataFilter(String spreadsheetId,
                       BatchUpdateValuesByDataFilterRequest content)
Sets values in one or more ranges of a spreadsheet.



Sheets.Spreadsheets.Values.Clear
clear(String spreadsheetId,
     String range,
     ClearValuesRequest content)
Clears values from 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





Values
public 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/api/guides/values#appending_values) and
 [sample code](/sheets/api/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](/sheets/api/guides/concepts#cell) of a range to search for a logical table of
        data. Values are appended after the last row of the table.
content - the ValueRange
Returns:
the request
Throws:
IOException








batchClear
public Sheets.Spreadsheets.Values.BatchClear batchClear(String spreadsheetId,
                                                        BatchClearValuesRequest content)
                                                 throws IOException
Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet
 ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as
 formatting and data validation) are kept.

 Create a request for the method "values.batchClear".

 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 BatchClearValuesRequest
Returns:
the request
Throws:
IOException








batchClearByDataFilter
public Sheets.Spreadsheets.Values.BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId,
                                                                                BatchClearValuesByDataFilterRequest content)
                                                                         throws IOException
Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet
 ID and one or more DataFilters. Ranges matching any of the specified data filters will be
 cleared. Only values are cleared -- all other properties of the cell (such as formatting, data
 validation, etc..) are kept.

 Create a request for the method "values.batchClearByDataFilter".

 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 BatchClearValuesByDataFilterRequest
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








batchGetByDataFilter
public Sheets.Spreadsheets.Values.BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId,
                                                                            BatchGetValuesByDataFilterRequest content)
                                                                     throws IOException
Returns one or more ranges of values that match the specified data filters. The caller must
 specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters
 in the request will be returned.

 Create a request for the method "values.batchGetByDataFilter".

 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.
content - the BatchGetValuesByDataFilterRequest
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








batchUpdateByDataFilter
public Sheets.Spreadsheets.Values.BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId,
                                                                                  BatchUpdateValuesByDataFilterRequest 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 DataFilterValueRanges.

 Create a request for the method "values.batchUpdateByDataFilter".

 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 BatchUpdateValuesByDataFilterRequest
Returns:
the request
Throws:
IOException








clear
public Sheets.Spreadsheets.Values.Clear clear(String spreadsheetId,
                                              String range,
                                              ClearValuesRequest content)
                                       throws IOException
Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only
 values are cleared -- all other properties of the cell (such as formatting, data validation,
 etc..) are kept.

 Create a request for the method "values.clear".

 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 or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
content - the ClearValuesRequest
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 or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values
        from.
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](/sheets/api/guides/concepts#cell) of the values to update.
content - the ValueRange
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Sheets.Spreadsheets.Values.Append`
`class`	`Sheets.Spreadsheets.Values.BatchClear`
`class`	`Sheets.Spreadsheets.Values.BatchClearByDataFilter`
`class`	`Sheets.Spreadsheets.Values.BatchGet`
`class`	`Sheets.Spreadsheets.Values.BatchGetByDataFilter`
`class`	`Sheets.Spreadsheets.Values.BatchUpdate`
`class`	`Sheets.Spreadsheets.Values.BatchUpdateByDataFilter`
`class`	`Sheets.Spreadsheets.Values.Clear`
`class`	`Sheets.Spreadsheets.Values.Get`
`class`	`Sheets.Spreadsheets.Values.Update`

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.BatchClear`	`batchClear(String spreadsheetId, BatchClearValuesRequest content)` Clears one or more ranges of values from a spreadsheet.
`Sheets.Spreadsheets.Values.BatchClearByDataFilter`	`batchClearByDataFilter(String spreadsheetId, BatchClearValuesByDataFilterRequest content)` Clears one or more ranges of values from a spreadsheet.
`Sheets.Spreadsheets.Values.BatchGet`	`batchGet(String spreadsheetId)` Returns one or more ranges of values from a spreadsheet.
`Sheets.Spreadsheets.Values.BatchGetByDataFilter`	`batchGetByDataFilter(String spreadsheetId, BatchGetValuesByDataFilterRequest content)` Returns one or more ranges of values that match the specified data filters.
`Sheets.Spreadsheets.Values.BatchUpdate`	`batchUpdate(String spreadsheetId, BatchUpdateValuesRequest content)` Sets values in one or more ranges of a spreadsheet.
`Sheets.Spreadsheets.Values.BatchUpdateByDataFilter`	`batchUpdateByDataFilter(String spreadsheetId, BatchUpdateValuesByDataFilterRequest content)` Sets values in one or more ranges of a spreadsheet.
`Sheets.Spreadsheets.Values.Clear`	`clear(String spreadsheetId, String range, ClearValuesRequest content)` Clears values from 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.