Class SpreadsheetsResource.ValuesResource.BatchGetRequest

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<BatchGetValuesResponse>
SheetsBaseServiceRequest<BatchGetValuesResponse>
SpreadsheetsResource.ValuesResource.BatchGetRequest
Implements
Inherited Members
Namespace: Google.Apis.Sheets.v4
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class SpreadsheetsResource.ValuesResource.BatchGetRequest : SheetsBaseServiceRequest<BatchGetValuesResponse>, IClientServiceRequest<BatchGetValuesResponse>, IClientServiceRequest

Constructors

BatchGetRequest(IClientService, string)

Constructs a new BatchGet request.

Declaration
public BatchGetRequest(IClientService service, string spreadsheetId)
Parameters
Type Name Description
IClientService service
string spreadsheetId

Properties

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.

Declaration
[RequestParameter("dateTimeRenderOption", RequestParameterType.Query)]
public virtual SpreadsheetsResource.ValuesResource.BatchGetRequest.DateTimeRenderOptionEnum? DateTimeRenderOption { get; set; }
Property Value
Type Description
SpreadsheetsResource.ValuesResource.BatchGetRequest.DateTimeRenderOptionEnum?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MajorDimension

The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting ranges=["A1:B2"],majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting ranges=["A1:B2"],majorDimension=COLUMNS returns [[1,3],[2,4]].

Declaration
[RequestParameter("majorDimension", RequestParameterType.Query)]
public virtual SpreadsheetsResource.ValuesResource.BatchGetRequest.MajorDimensionEnum? MajorDimension { get; set; }
Property Value
Type Description
SpreadsheetsResource.ValuesResource.BatchGetRequest.MajorDimensionEnum?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Ranges

The A1 notation or R1C1 notation of the range to retrieve values from.

Declaration
[RequestParameter("ranges", RequestParameterType.Query)]
public virtual Repeatable<string> Ranges { get; set; }
Property Value
Type Description
Repeatable<string>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SpreadsheetId

The ID of the spreadsheet to retrieve data from.

Declaration
[RequestParameter("spreadsheetId", RequestParameterType.Path)]
public virtual string SpreadsheetId { get; }
Property Value
Type Description
string

ValueRenderOption

How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

Declaration
[RequestParameter("valueRenderOption", RequestParameterType.Query)]
public virtual SpreadsheetsResource.ValuesResource.BatchGetRequest.ValueRenderOptionEnum? ValueRenderOption { get; set; }
Property Value
Type Description
SpreadsheetsResource.ValuesResource.BatchGetRequest.ValueRenderOptionEnum?

Methods

InitParameters()

Initializes BatchGet parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements