Show / Hide Table of Contents

Class SpreadsheetsResource.GetByDataFilterRequest

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 one of 2 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
object
ClientServiceRequest
ClientServiceRequest<Spreadsheet>
SheetsBaseServiceRequest<Spreadsheet>
SpreadsheetsResource.GetByDataFilterRequest
Implements
IClientServiceRequest<Spreadsheet>
IClientServiceRequest
Inherited Members
SheetsBaseServiceRequest<Spreadsheet>.Xgafv
SheetsBaseServiceRequest<Spreadsheet>.AccessToken
SheetsBaseServiceRequest<Spreadsheet>.Alt
SheetsBaseServiceRequest<Spreadsheet>.Callback
SheetsBaseServiceRequest<Spreadsheet>.Fields
SheetsBaseServiceRequest<Spreadsheet>.Key
SheetsBaseServiceRequest<Spreadsheet>.OauthToken
SheetsBaseServiceRequest<Spreadsheet>.PrettyPrint
SheetsBaseServiceRequest<Spreadsheet>.QuotaUser
SheetsBaseServiceRequest<Spreadsheet>.UploadType
SheetsBaseServiceRequest<Spreadsheet>.UploadProtocol
ClientServiceRequest<Spreadsheet>.Execute()
ClientServiceRequest<Spreadsheet>.ExecuteAsStream()
ClientServiceRequest<Spreadsheet>.ExecuteAsync()
ClientServiceRequest<Spreadsheet>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Spreadsheet>.ExecuteAsStreamAsync()
ClientServiceRequest<Spreadsheet>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Spreadsheet>.CreateRequest(bool?)
ClientServiceRequest<Spreadsheet>.GenerateRequestUri()
ClientServiceRequest<Spreadsheet>.GetDefaultETagAction(string)
ClientServiceRequest<Spreadsheet>.ETagAction
ClientServiceRequest<Spreadsheet>.ModifyRequest
ClientServiceRequest<Spreadsheet>.ValidateParameters
ClientServiceRequest<Spreadsheet>.ApiVersion
ClientServiceRequest<Spreadsheet>.RequestParameters
ClientServiceRequest<Spreadsheet>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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
ClientServiceRequest<Spreadsheet>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Spreadsheet>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Spreadsheet>.RestPath

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
ClientServiceRequest<Spreadsheet>.GetBody()

InitParameters()

Initializes GetByDataFilter parameter list.

Declaration
protected override void InitParameters()
Overrides
SheetsBaseServiceRequest<Spreadsheet>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX