target.apidocs.com.google.api.services.sheets.v4.Sheets.Spreadsheets.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-rev20241008-2.0.0

Show newest version







Sheets.Spreadsheets (Google Sheets API v4-rev20230526-2.0.0)











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



java.lang.Object


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







Enclosing class:
Sheets




public class Sheets.Spreadsheets
extends Object
The "spreadsheets" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Sheets.Spreadsheets.BatchUpdate 


class 
Sheets.Spreadsheets.Create 


class 
Sheets.Spreadsheets.DeveloperMetadata
The "developerMetadata" collection of methods.



class 
Sheets.Spreadsheets.Get 


class 
Sheets.Spreadsheets.GetByDataFilter 


class 
Sheets.Spreadsheets.SheetsOperations
The "sheets" collection of methods.



class 
Sheets.Spreadsheets.Values
The "values" collection of methods.










Constructor Summary

Constructors 

Constructor and Description


Spreadsheets() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Sheets.Spreadsheets.BatchUpdate
batchUpdate(String spreadsheetId,
           BatchUpdateSpreadsheetRequest content)
Applies one or more updates to the spreadsheet.



Sheets.Spreadsheets.Create
create(Spreadsheet content)
Creates a spreadsheet, returning the newly created spreadsheet.



Sheets.Spreadsheets.DeveloperMetadata
developerMetadata()
An accessor for creating requests from the DeveloperMetadata collection.



Sheets.Spreadsheets.Get
get(String spreadsheetId)
Returns the spreadsheet at the given ID.



Sheets.Spreadsheets.GetByDataFilter
getByDataFilter(String spreadsheetId,
               GetSpreadsheetByDataFilterRequest content)
Returns the spreadsheet at the given ID.



Sheets.Spreadsheets.SheetsOperations
sheets()
An accessor for creating requests from the SheetsOperations collection.



Sheets.Spreadsheets.Values
values()
An accessor for creating requests from the Values collection.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Spreadsheets
public Spreadsheets()









Method Detail





batchUpdate
public Sheets.Spreadsheets.BatchUpdate batchUpdate(String spreadsheetId,
                                                   BatchUpdateSpreadsheetRequest content)
                                            throws IOException
Applies one or more updates to the spreadsheet. Each request is validated before being applied.
 If any request is not valid then the entire request will fail and nothing will be applied. Some
 requests have replies to give you some information about how they are applied. The replies will
 mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the
 response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due
 to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will
 reflect exactly your changes after this completes, however it is guaranteed that the updates in
 the request will be applied together atomically. Your changes may be altered with respect to
 collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

 Create a request for the method "spreadsheets.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 spreadsheet to apply the updates to.
content - the BatchUpdateSpreadsheetRequest
Returns:
the request
Throws:
IOException








create
public Sheets.Spreadsheets.Create create(Spreadsheet content)
                                  throws IOException
Creates a spreadsheet, returning the newly created spreadsheet.

 Create a request for the method "spreadsheets.create".

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








get
public Sheets.Spreadsheets.Get get(String spreadsheetId)
                            throws IOException
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default,
 data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field
 mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields
 using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a
 field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best
 practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets
 of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1
 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or
 multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same
 spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example,
 `?ranges=A1:D5=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet
 that intersect the requested ranges.

 Create a request for the method "spreadsheets.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 spreadsheet to request.
Returns:
the request
Throws:
IOException








getByDataFilter
public Sheets.Spreadsheets.GetByDataFilter getByDataFilter(String spreadsheetId,
                                                           GetSpreadsheetByDataFilterRequest content)
                                                    throws IOException
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method
 differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to
 return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying
 one or more data filters returns the portions of the spreadsheet that intersect ranges matched by
 any of the filters. By default, data within grids is not returned. You can include grid data one
 of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks)
 listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData
 parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large
 spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.

 Create a request for the method "spreadsheets.getByDataFilter".

 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 spreadsheet to request.
content - the GetSpreadsheetByDataFilterRequest
Returns:
the request
Throws:
IOException








developerMetadata
public Sheets.Spreadsheets.DeveloperMetadata developerMetadata()
An accessor for creating requests from the DeveloperMetadata collection.

 The typical use is:
     Sheets sheets = new Sheets(...);
    Sheets.DeveloperMetadata.List request = sheets.developerMetadata().list(parameters ...)
 

Returns:
the resource collection








sheets
public Sheets.Spreadsheets.SheetsOperations sheets()
An accessor for creating requests from the SheetsOperations collection.

 The typical use is:
     Sheets sheets = new Sheets(...);
    Sheets.SheetsOperations.List request = sheets.sheets().list(parameters ...)
 

Returns:
the resource collection








values
public Sheets.Spreadsheets.Values values()
An accessor for creating requests from the Values collection.

 The typical use is:
     Sheets sheets = new Sheets(...);
    Sheets.Values.List request = sheets.values().list(parameters ...)
 

Returns:
the resource collection














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–2023 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Sheets.Spreadsheets.BatchUpdate`
`class`	`Sheets.Spreadsheets.Create`
`class`	`Sheets.Spreadsheets.DeveloperMetadata` The "developerMetadata" collection of methods.
`class`	`Sheets.Spreadsheets.Get`
`class`	`Sheets.Spreadsheets.GetByDataFilter`
`class`	`Sheets.Spreadsheets.SheetsOperations` The "sheets" collection of methods.
`class`	`Sheets.Spreadsheets.Values` The "values" collection of methods.

Modifier and Type	Method and Description
`Sheets.Spreadsheets.BatchUpdate`	`batchUpdate(String spreadsheetId, BatchUpdateSpreadsheetRequest content)` Applies one or more updates to the spreadsheet.
`Sheets.Spreadsheets.Create`	`create(Spreadsheet content)` Creates a spreadsheet, returning the newly created spreadsheet.
`Sheets.Spreadsheets.DeveloperMetadata`	`developerMetadata()` An accessor for creating requests from the DeveloperMetadata collection.
`Sheets.Spreadsheets.Get`	`get(String spreadsheetId)` Returns the spreadsheet at the given ID.
`Sheets.Spreadsheets.GetByDataFilter`	`getByDataFilter(String spreadsheetId, GetSpreadsheetByDataFilterRequest content)` Returns the spreadsheet at the given ID.
`Sheets.Spreadsheets.SheetsOperations`	`sheets()` An accessor for creating requests from the SheetsOperations collection.
`Sheets.Spreadsheets.Values`	`values()` An accessor for creating requests from the Values collection.