Sheets.Spreadsheets.Get (Google Sheets API v4-rev20241008-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.sheets.v4.SheetsRequest<Spreadsheet>
        
        com.google.api.services.sheets.v4.Sheets.Spreadsheets.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Sheets.Spreadsheets
```
public class Sheets.Spreadsheets.Get
extends SheetsRequest<Spreadsheet>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Get(String spreadsheetId)
Returns the spreadsheet at the given ID.

Constructors
Modifier	Constructor and Description
`protected`	`Get(String spreadsheetId)` Returns the spreadsheet at the given ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Boolean`	`getIncludeGridData()` True if grid data should be returned.
`List<String>`	`getRanges()` The ranges to retrieve from the spreadsheet.
`String`	`getSpreadsheetId()` The spreadsheet to request.
`Sheets.Spreadsheets.Get`	`set(String parameterName, Object value)`
`Sheets.Spreadsheets.Get`	`set$Xgafv(String $Xgafv)` V1 error format.
`Sheets.Spreadsheets.Get`	`setAccessToken(String accessToken)` OAuth access token.
`Sheets.Spreadsheets.Get`	`setAlt(String alt)` Data format for response.
`Sheets.Spreadsheets.Get`	`setCallback(String callback)` JSONP
`Sheets.Spreadsheets.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Sheets.Spreadsheets.Get`	`setIncludeGridData(Boolean includeGridData)` True if grid data should be returned.
`Sheets.Spreadsheets.Get`	`setKey(String key)` API key.
`Sheets.Spreadsheets.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Sheets.Spreadsheets.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Sheets.Spreadsheets.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Sheets.Spreadsheets.Get`	`setRanges(List<String> ranges)` The ranges to retrieve from the spreadsheet.
`Sheets.Spreadsheets.Get`	`setSpreadsheetId(String spreadsheetId)` The spreadsheet to request.
`Sheets.Spreadsheets.Get`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Sheets.Spreadsheets.Get`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.sheets.v4.SheetsRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Get
```
protected Get(String spreadsheetId)
```
    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&ranges=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 the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Sheets.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    spreadsheetId - The spreadsheet to request.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Spreadsheet>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Spreadsheet>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Sheets.Spreadsheets.Get set$Xgafv(String $Xgafv)
```
    Description copied from class: SheetsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SheetsRequest<Spreadsheet>
  - setAccessToken
```
public Sheets.Spreadsheets.Get setAccessToken(String accessToken)
```
    Description copied from class: SheetsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SheetsRequest<Spreadsheet>
  - setAlt
```
public Sheets.Spreadsheets.Get setAlt(String alt)
```
    Description copied from class: SheetsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SheetsRequest<Spreadsheet>
  - setCallback
```
public Sheets.Spreadsheets.Get setCallback(String callback)
```
    Description copied from class: SheetsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SheetsRequest<Spreadsheet>
  - setFields
```
public Sheets.Spreadsheets.Get setFields(String fields)
```
    Description copied from class: SheetsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SheetsRequest<Spreadsheet>
  - setKey
```
public Sheets.Spreadsheets.Get setKey(String key)
```
    Description copied from class: SheetsRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class SheetsRequest<Spreadsheet>
  - setOauthToken
```
public Sheets.Spreadsheets.Get setOauthToken(String oauthToken)
```
    Description copied from class: SheetsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SheetsRequest<Spreadsheet>
  - setPrettyPrint
```
public Sheets.Spreadsheets.Get setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SheetsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SheetsRequest<Spreadsheet>
  - setQuotaUser
```
public Sheets.Spreadsheets.Get setQuotaUser(String quotaUser)
```
    Description copied from class: SheetsRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class SheetsRequest<Spreadsheet>
  - setUploadType
```
public Sheets.Spreadsheets.Get setUploadType(String uploadType)
```
    Description copied from class: SheetsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SheetsRequest<Spreadsheet>
  - setUploadProtocol
```
public Sheets.Spreadsheets.Get setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SheetsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SheetsRequest<Spreadsheet>
  - getSpreadsheetId
```
public String getSpreadsheetId()
```
    The spreadsheet to request.
  - setSpreadsheetId
```
public Sheets.Spreadsheets.Get setSpreadsheetId(String spreadsheetId)
```
    The spreadsheet to request.
  - getIncludeGridData
```
public Boolean getIncludeGridData()
```
    True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
  - setIncludeGridData
```
public Sheets.Spreadsheets.Get setIncludeGridData(Boolean includeGridData)
```
    True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
  - getRanges
```
public List<String> getRanges()
```
    The ranges to retrieve from the spreadsheet.
  - setRanges
```
public Sheets.Spreadsheets.Get setRanges(List<String> ranges)
```
    The ranges to retrieve from the spreadsheet.
  - set
```
public Sheets.Spreadsheets.Get set(String parameterName,
                                   Object value)
```
    Overrides:
    
    set in class SheetsRequest<Spreadsheet>

Class Sheets.Spreadsheets.Get

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.sheets.v4.SheetsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSpreadsheetId

setSpreadsheetId

getIncludeGridData

setIncludeGridData

getRanges

setRanges

set