list method

Future<ListBidResponsesWithoutBidsResponse> list(
  1. String filterSetName, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Request parameters:

filterSetName - Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc Value must have pattern ^bidders/\[^/\]+/accounts/\[^/\]+/filterSets/\[^/\]+$.

pageSize - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

pageToken - A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.

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

Completes with a ListBidResponsesWithoutBidsResponse.

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<ListBidResponsesWithoutBidsResponse> list(
  core.String filterSetName, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v2beta1/' +
      core.Uri.encodeFull('$filterSetName') +
      '/bidResponsesWithoutBids';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return ListBidResponsesWithoutBidsResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}