list method

Future<ListCreativeStatusBreakdownByDetailResponse> list(String filterSetName, int creativeStatusId, { int? pageSize, String? pageToken, String? $fields, })

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

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/\[^/\]+/filterSets/\[^/\]+$.

creativeStatusId - The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.

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 ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.

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

Completes with a ListCreativeStatusBreakdownByDetailResponse.

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<ListCreativeStatusBreakdownByDetailResponse> list(
  core.String filterSetName,
  core.int creativeStatusId, {
  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') +
      '/filteredBids/' +
      commons.escapeVariable('$creativeStatusId') +
      '/details';

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