Class SpreadsheetsResource.GetByDataFilterRequest
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information,
see Read, write, and search metadata.
This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to
return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more
data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By
default, data within grids is not returned. You can include grid data in one of two ways: * Specify a field
mask listing your desired fields
using the fields URL parameter in HTTP. * Set the includeGridData parameter to true. If a field mask is
set, the includeGridData parameter is ignored. For large spreadsheets, as a best practice, retrieve only
the specific spreadsheet fields that you want.
Inheritance
Inherited Members
Namespace: Google.Apis.Sheets.v4
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class SpreadsheetsResource.GetByDataFilterRequest : SheetsBaseServiceRequest<Spreadsheet>, IClientServiceRequest<Spreadsheet>, IClientServiceRequest
Constructors
GetByDataFilterRequest(IClientService, GetSpreadsheetByDataFilterRequest, string)
Constructs a new GetByDataFilter request.
Declaration
public GetByDataFilterRequest(IClientService service, GetSpreadsheetByDataFilterRequest body, string spreadsheetId)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| GetSpreadsheetByDataFilterRequest | body | |
| string | spreadsheetId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
SpreadsheetId
The spreadsheet to request.
Declaration
[RequestParameter("spreadsheetId", RequestParameterType.Path)]
public virtual string SpreadsheetId { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
| Type | Description |
|---|---|
| object |
Overrides
InitParameters()
Initializes GetByDataFilter parameter list.
Declaration
protected override void InitParameters()