Class SpreadsheetsResource.GetRequest
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within
grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your
desired fields using the fields
URL parameter in HTTP * Set the includeGridData URL parameter to true. If
a field mask is set, the includeGridData
parameter is ignored For large spreadsheets, it is recommended to
retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the
spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return
only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1
notation.
Inheritance
Inherited Members
Namespace: Google.Apis.Sheets.v4
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class GetRequest : SheetsBaseServiceRequest<Spreadsheet>, IClientServiceRequest<Spreadsheet>, IClientServiceRequest
Constructors
GetRequest(IClientService, String)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, string spreadsheetId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
System.String | spreadsheetId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
IncludeGridData
True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
Declaration
[RequestParameter("includeGridData", RequestParameterType.Query)]
public virtual bool? IncludeGridData { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Ranges
The ranges to retrieve from the spreadsheet.
Declaration
[RequestParameter("ranges", RequestParameterType.Query)]
public virtual Repeatable<string> Ranges { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<System.String> |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
SpreadsheetId
The spreadsheet to request.
Declaration
[RequestParameter("spreadsheetId", RequestParameterType.Path)]
public virtual string SpreadsheetId { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()