target.apidocs.com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Get.html Maven / Gradle / Ivy
Sheets.Spreadsheets.Values.Get (Google Sheets API v4-rev20240917-2.0.0)
com.google.api.services.sheets.v4
Class Sheets.Spreadsheets.Values.Get
- 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<ValueRange>
-
- com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Get
-
- Enclosing class:
- Sheets.Spreadsheets.Values
public class Sheets.Spreadsheets.Values.Get
extends SheetsRequest<ValueRange>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Get(String spreadsheetId,
String range)
Returns a range of values from a spreadsheet.
-
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()
String
getDateTimeRenderOption()
How dates, times, and durations should be represented in the output.
String
getMajorDimension()
The major dimension that results should use.
String
getRange()
The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve
values from.
String
getSpreadsheetId()
The ID of the spreadsheet to retrieve data from.
String
getValueRenderOption()
How values should be represented in the output.
Sheets.Spreadsheets.Values.Get
set(String parameterName,
Object value)
Sheets.Spreadsheets.Values.Get
set$Xgafv(String $Xgafv)
V1 error format.
Sheets.Spreadsheets.Values.Get
setAccessToken(String accessToken)
OAuth access token.
Sheets.Spreadsheets.Values.Get
setAlt(String alt)
Data format for response.
Sheets.Spreadsheets.Values.Get
setCallback(String callback)
JSONP
Sheets.Spreadsheets.Values.Get
setDateTimeRenderOption(String dateTimeRenderOption)
How dates, times, and durations should be represented in the output.
Sheets.Spreadsheets.Values.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
Sheets.Spreadsheets.Values.Get
setKey(String key)
API key.
Sheets.Spreadsheets.Values.Get
setMajorDimension(String majorDimension)
The major dimension that results should use.
Sheets.Spreadsheets.Values.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Sheets.Spreadsheets.Values.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Sheets.Spreadsheets.Values.Get
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Sheets.Spreadsheets.Values.Get
setRange(String range)
The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to
retrieve values from.
Sheets.Spreadsheets.Values.Get
setSpreadsheetId(String spreadsheetId)
The ID of the spreadsheet to retrieve data from.
Sheets.Spreadsheets.Values.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Get
setValueRenderOption(String valueRenderOption)
How values should be represented in the output.
-
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,
String range)
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 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 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.
- 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<ValueRange>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ValueRange>
- Throws:
IOException
-
set$Xgafv
public Sheets.Spreadsheets.Values.Get set$Xgafv(String $Xgafv)
Description copied from class: SheetsRequest
V1 error format.
- Overrides:
set$Xgafv
in class SheetsRequest<ValueRange>
-
setAccessToken
public Sheets.Spreadsheets.Values.Get setAccessToken(String accessToken)
Description copied from class: SheetsRequest
OAuth access token.
- Overrides:
setAccessToken
in class SheetsRequest<ValueRange>
-
setAlt
public Sheets.Spreadsheets.Values.Get setAlt(String alt)
Description copied from class: SheetsRequest
Data format for response.
- Overrides:
setAlt
in class SheetsRequest<ValueRange>
-
setCallback
public Sheets.Spreadsheets.Values.Get setCallback(String callback)
Description copied from class: SheetsRequest
JSONP
- Overrides:
setCallback
in class SheetsRequest<ValueRange>
-
setFields
public Sheets.Spreadsheets.Values.Get setFields(String fields)
Description copied from class: SheetsRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class SheetsRequest<ValueRange>
-
setKey
public Sheets.Spreadsheets.Values.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<ValueRange>
-
setOauthToken
public Sheets.Spreadsheets.Values.Get setOauthToken(String oauthToken)
Description copied from class: SheetsRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class SheetsRequest<ValueRange>
-
setPrettyPrint
public Sheets.Spreadsheets.Values.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: SheetsRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class SheetsRequest<ValueRange>
-
setQuotaUser
public Sheets.Spreadsheets.Values.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<ValueRange>
-
setUploadType
public Sheets.Spreadsheets.Values.Get setUploadType(String uploadType)
Description copied from class: SheetsRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class SheetsRequest<ValueRange>
-
setUploadProtocol
public Sheets.Spreadsheets.Values.Get setUploadProtocol(String uploadProtocol)
Description copied from class: SheetsRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class SheetsRequest<ValueRange>
-
getSpreadsheetId
public String getSpreadsheetId()
The ID of the spreadsheet to retrieve data from.
-
setSpreadsheetId
public Sheets.Spreadsheets.Values.Get setSpreadsheetId(String spreadsheetId)
The ID of the spreadsheet to retrieve data from.
-
getRange
public String getRange()
The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve
values from.
-
setRange
public Sheets.Spreadsheets.Values.Get setRange(String range)
The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to
retrieve values from.
-
getDateTimeRenderOption
public String getDateTimeRenderOption()
How dates, times, and durations should be represented in the output. This is ignored if
value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
-
setDateTimeRenderOption
public Sheets.Spreadsheets.Values.Get setDateTimeRenderOption(String dateTimeRenderOption)
How dates, times, and durations should be represented in the output. This is ignored if
value_render_option is FORMATTED_VALUE. The default dateTime render option is
SERIAL_NUMBER.
-
getMajorDimension
public String getMajorDimension()
The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is:
`A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns
`[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns
`[[1,3],[2,4]]`.
-
setMajorDimension
public Sheets.Spreadsheets.Values.Get setMajorDimension(String majorDimension)
The major dimension that results should use. For example, if the spreadsheet data in
Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting
`range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting
`range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
-
getValueRenderOption
public String getValueRenderOption()
How values should be represented in the output. The default render option is FORMATTED_VALUE.
-
setValueRenderOption
public Sheets.Spreadsheets.Values.Get setValueRenderOption(String valueRenderOption)
How values should be represented in the output. The default render option is
FORMATTED_VALUE.
-
set
public Sheets.Spreadsheets.Values.Get set(String parameterName,
Object value)
- Overrides:
set
in class SheetsRequest<ValueRange>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy