batchGetByDataFilter method

Future<BatchGetValuesByDataFilterResponse> batchGetByDataFilter(BatchGetValuesByDataFilterRequest request, String spreadsheetId, { String? $fields, })

Returns one or more ranges of values that match the specified data filters.

The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.

request - The metadata request object.

Request parameters:

spreadsheetId - The ID of the spreadsheet to retrieve data from.

$fields - Selector specifying which fields to include in a partial response.

Completes with a BatchGetValuesByDataFilterResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<BatchGetValuesByDataFilterResponse> batchGetByDataFilter(
  BatchGetValuesByDataFilterRequest request,
  core.String spreadsheetId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v4/spreadsheets/' +
      commons.escapeVariable('$spreadsheetId') +
      '/values:batchGetByDataFilter';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return BatchGetValuesByDataFilterResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}