Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
Arguments
Parameters | |
---|---|
range |
Required. The A1 notation or R1C1 notation of the range to retrieve values from. |
spreadsheetId |
Required. The ID of the spreadsheet to retrieve data from. |
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. |
Enum type. Can be one of the following: | |
SERIAL_NUMBER |
Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year. |
FORMATTED_STRING |
Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). |
majorDimension |
The major dimension that results should use. For example, if the spreadsheet data is: |
Enum type. Can be one of the following: | |
DIMENSION_UNSPECIFIED |
The default value, do not use. |
ROWS |
Operates on the rows of a sheet. |
COLUMNS |
Operates on the columns of a sheet. |
valueRenderOption |
How values should be represented in the output. The default render option is FORMATTED_VALUE. |
Enum type. Can be one of the following: | |
FORMATTED_VALUE |
Values will be calculated & formatted in the reply according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "$1.23" . |
UNFORMATTED_VALUE |
Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23 . |
FORMULA |
Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1" . |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of ValueRange
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- get: call: googleapis.sheets.v4.spreadsheets.values.get args: range: ... spreadsheetId: ... dateTimeRenderOption: ... majorDimension: ... valueRenderOption: ... result: getResult
JSON
[ { "get": { "call": "googleapis.sheets.v4.spreadsheets.values.get", "args": { "range": "...", "spreadsheetId": "...", "dateTimeRenderOption": "...", "majorDimension": "...", "valueRenderOption": "..." }, "result": "getResult" } } ]