search method

Future<SearchDeveloperMetadataResponse> search(
  1. SearchDeveloperMetadataRequest request,
  2. String spreadsheetId, {
  3. String? $fields,
})

Returns all developer metadata matching the specified DataFilter.

If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.

request - The metadata request object.

Request parameters:

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

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

Completes with a SearchDeveloperMetadataResponse.

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<SearchDeveloperMetadataResponse> search(
  SearchDeveloperMetadataRequest 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') +
      '/developerMetadata:search';

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