target.apidocs.com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Append.html Maven / Gradle / Ivy
Sheets.Spreadsheets.Values.Append (Google Sheets API v4-rev20240312-2.0.0)
com.google.api.services.sheets.v4
Class Sheets.Spreadsheets.Values.Append
- 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<AppendValuesResponse>
-
- com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Append
-
- Enclosing class:
- Sheets.Spreadsheets.Values
public class Sheets.Spreadsheets.Values.Append
extends SheetsRequest<AppendValuesResponse>
-
-
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
Append(String spreadsheetId,
String range,
ValueRange content)
Appends values to a spreadsheet.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Boolean
getIncludeValuesInResponse()
Determines if the update response should include the values of the cells that were appended.
String
getInsertDataOption()
How the input data should be inserted.
String
getRange()
The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of
data.
String
getResponseDateTimeRenderOption()
Determines how dates, times, and durations in the response should be rendered.
String
getResponseValueRenderOption()
Determines how values in the response should be rendered.
String
getSpreadsheetId()
The ID of the spreadsheet to update.
String
getValueInputOption()
How the input data should be interpreted.
Sheets.Spreadsheets.Values.Append
set(String parameterName,
Object value)
Sheets.Spreadsheets.Values.Append
set$Xgafv(String $Xgafv)
V1 error format.
Sheets.Spreadsheets.Values.Append
setAccessToken(String accessToken)
OAuth access token.
Sheets.Spreadsheets.Values.Append
setAlt(String alt)
Data format for response.
Sheets.Spreadsheets.Values.Append
setCallback(String callback)
JSONP
Sheets.Spreadsheets.Values.Append
setFields(String fields)
Selector specifying which fields to include in a partial response.
Sheets.Spreadsheets.Values.Append
setIncludeValuesInResponse(Boolean includeValuesInResponse)
Determines if the update response should include the values of the cells that were
appended.
Sheets.Spreadsheets.Values.Append
setInsertDataOption(String insertDataOption)
How the input data should be inserted.
Sheets.Spreadsheets.Values.Append
setKey(String key)
API key.
Sheets.Spreadsheets.Values.Append
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Sheets.Spreadsheets.Values.Append
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Sheets.Spreadsheets.Values.Append
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Sheets.Spreadsheets.Values.Append
setRange(String range)
The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical
table of data.
Sheets.Spreadsheets.Values.Append
setResponseDateTimeRenderOption(String responseDateTimeRenderOption)
Determines how dates, times, and durations in the response should be rendered.
Sheets.Spreadsheets.Values.Append
setResponseValueRenderOption(String responseValueRenderOption)
Determines how values in the response should be rendered.
Sheets.Spreadsheets.Values.Append
setSpreadsheetId(String spreadsheetId)
The ID of the spreadsheet to update.
Sheets.Spreadsheets.Values.Append
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Append
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Append
setValueInputOption(String valueInputOption)
How the input data should be interpreted.
-
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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
-
Append
protected Append(String spreadsheetId,
String range,
ValueRange content)
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 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 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
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Sheets.Spreadsheets.Values.Append set$Xgafv(String $Xgafv)
Description copied from class: SheetsRequest
V1 error format.
- Overrides:
set$Xgafv
in class SheetsRequest<AppendValuesResponse>
-
setAccessToken
public Sheets.Spreadsheets.Values.Append setAccessToken(String accessToken)
Description copied from class: SheetsRequest
OAuth access token.
- Overrides:
setAccessToken
in class SheetsRequest<AppendValuesResponse>
-
setAlt
public Sheets.Spreadsheets.Values.Append setAlt(String alt)
Description copied from class: SheetsRequest
Data format for response.
- Overrides:
setAlt
in class SheetsRequest<AppendValuesResponse>
-
setCallback
public Sheets.Spreadsheets.Values.Append setCallback(String callback)
Description copied from class: SheetsRequest
JSONP
- Overrides:
setCallback
in class SheetsRequest<AppendValuesResponse>
-
setFields
public Sheets.Spreadsheets.Values.Append setFields(String fields)
Description copied from class: SheetsRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class SheetsRequest<AppendValuesResponse>
-
setKey
public Sheets.Spreadsheets.Values.Append 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<AppendValuesResponse>
-
setOauthToken
public Sheets.Spreadsheets.Values.Append setOauthToken(String oauthToken)
Description copied from class: SheetsRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class SheetsRequest<AppendValuesResponse>
-
setPrettyPrint
public Sheets.Spreadsheets.Values.Append setPrettyPrint(Boolean prettyPrint)
Description copied from class: SheetsRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class SheetsRequest<AppendValuesResponse>
-
setQuotaUser
public Sheets.Spreadsheets.Values.Append 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<AppendValuesResponse>
-
setUploadType
public Sheets.Spreadsheets.Values.Append setUploadType(String uploadType)
Description copied from class: SheetsRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class SheetsRequest<AppendValuesResponse>
-
setUploadProtocol
public Sheets.Spreadsheets.Values.Append setUploadProtocol(String uploadProtocol)
Description copied from class: SheetsRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class SheetsRequest<AppendValuesResponse>
-
getSpreadsheetId
public String getSpreadsheetId()
The ID of the spreadsheet to update.
-
setSpreadsheetId
public Sheets.Spreadsheets.Values.Append setSpreadsheetId(String spreadsheetId)
The ID of the spreadsheet to update.
-
getRange
public String getRange()
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.
-
setRange
public Sheets.Spreadsheets.Values.Append setRange(String 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.
-
getIncludeValuesInResponse
public Boolean getIncludeValuesInResponse()
Determines if the update response should include the values of the cells that were appended. By
default, responses do not include the updated values.
-
setIncludeValuesInResponse
public Sheets.Spreadsheets.Values.Append setIncludeValuesInResponse(Boolean includeValuesInResponse)
Determines if the update response should include the values of the cells that were
appended. By default, responses do not include the updated values.
-
getInsertDataOption
public String getInsertDataOption()
How the input data should be inserted.
-
setInsertDataOption
public Sheets.Spreadsheets.Values.Append setInsertDataOption(String insertDataOption)
How the input data should be inserted.
-
getResponseDateTimeRenderOption
public String getResponseDateTimeRenderOption()
Determines how dates, times, and durations in the response should be rendered. This is ignored if
response_value_render_option is FORMATTED_VALUE. The default dateTime render option is
SERIAL_NUMBER.
-
setResponseDateTimeRenderOption
public Sheets.Spreadsheets.Values.Append setResponseDateTimeRenderOption(String responseDateTimeRenderOption)
Determines how dates, times, and durations in the response should be rendered. This is
ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render
option is SERIAL_NUMBER.
-
getResponseValueRenderOption
public String getResponseValueRenderOption()
Determines how values in the response should be rendered. The default render option is
FORMATTED_VALUE.
-
setResponseValueRenderOption
public Sheets.Spreadsheets.Values.Append setResponseValueRenderOption(String responseValueRenderOption)
Determines how values in the response should be rendered. The default render option is
FORMATTED_VALUE.
-
getValueInputOption
public String getValueInputOption()
How the input data should be interpreted.
-
setValueInputOption
public Sheets.Spreadsheets.Values.Append setValueInputOption(String valueInputOption)
How the input data should be interpreted.
-
set
public Sheets.Spreadsheets.Values.Append set(String parameterName,
Object value)
- Overrides:
set
in class SheetsRequest<AppendValuesResponse>
Copyright © 2011–2024 Google. All rights reserved.