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
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<BatchGetValuesResponse>
SheetsBaseServiceRequest<BatchGetValuesResponse>
SpreadsheetsResource.ValuesResource.BatchGetRequest
Implements
Google.Apis.Requests.IClientServiceRequest<BatchGetValuesResponse>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Sheets.v4
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class 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
Google.Apis.Services.IClientService service
System.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
System.Nullable<SpreadsheetsResource.ValuesResource.BatchGetRequest.DateTimeRenderOptionEnum>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.HttpMethod

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=[&quot;A1:B2&quot;],majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting ranges=[&quot;A1:B2&quot;],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
System.Nullable<SpreadsheetsResource.ValuesResource.BatchGetRequest.MajorDimensionEnum>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.MethodName

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
Google.Apis.Util.Repeatable<System.String>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.RestPath

SpreadsheetId

The ID of the spreadsheet to retrieve data from.

Declaration
[RequestParameter("spreadsheetId", RequestParameterType.Path)]
public virtual string SpreadsheetId { get; }
Property Value
Type Description
System.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
System.Nullable<SpreadsheetsResource.ValuesResource.BatchGetRequest.ValueRenderOptionEnum>

Methods

InitParameters()

Initializes BatchGet parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Sheets.v4.SheetsBaseServiceRequest<Google.Apis.Sheets.v4.Data.BatchGetValuesResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest