Class SpreadsheetsResource.ValuesResource.GetRequest

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<ValueRange>
SheetsBaseServiceRequest<ValueRange>
SpreadsheetsResource.ValuesResource.GetRequest
Implements
Google.Apis.Requests.IClientServiceRequest<ValueRange>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Sheets.v4.Data.ValueRange>.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 GetRequest : SheetsBaseServiceRequest<ValueRange>, IClientServiceRequest<ValueRange>, IClientServiceRequest

Constructors

GetRequest(IClientService, String, String)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string spreadsheetId, string range)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.String spreadsheetId
System.String range

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 [DateTimeRenderOption.SERIAL_NUMBER].

Declaration
[RequestParameter("dateTimeRenderOption", RequestParameterType.Query)]
public virtual SpreadsheetsResource.ValuesResource.GetRequest.DateTimeRenderOptionEnum? DateTimeRenderOption { get; set; }
Property Value
Type Description
System.Nullable<SpreadsheetsResource.ValuesResource.GetRequest.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.ValueRange>.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 range=A1:B2,majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS returns [[1,3],[2,4]].

Declaration
[RequestParameter("majorDimension", RequestParameterType.Query)]
public virtual SpreadsheetsResource.ValuesResource.GetRequest.MajorDimensionEnum? MajorDimension { get; set; }
Property Value
Type Description
System.Nullable<SpreadsheetsResource.ValuesResource.GetRequest.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.ValueRange>.MethodName

Range

The A1 notation of the values to retrieve.

Declaration
[RequestParameter("range", RequestParameterType.Path)]
public virtual string Range { get; }
Property Value
Type Description
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.ValueRange>.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.GetRequest.ValueRenderOptionEnum? ValueRenderOption { get; set; }
Property Value
Type Description
System.Nullable<SpreadsheetsResource.ValuesResource.GetRequest.ValueRenderOptionEnum>

Methods

InitParameters()

Initializes Get parameter list.

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

Implements

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