Method: bidders.filterSets.filteredBids.list

  • This page provides details on how to list all reasons for which bids were filtered, along with the count for each reason.

  • The HTTP GET request uses a URL structure that includes the filter set name.

  • Path parameters are used to specify the filterSetName which can be at the bidder or account level.

  • Query parameters like pageSize and pageToken are available for pagination of results.

  • The request body for this method should be empty.

  • The response body will contain a ListFilteredBidsResponse instance upon success.

  • The request requires the https://www.googleapis.com/auth/adexchange.buyer authorization scope.

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

HTTP request

GET https://adexchangebuyer.googleapis.com/v2beta1/{filterSetName=bidders/*/filterSets/*}/filteredBids

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
filterSetName

string

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

Query parameters

Parameters
pageSize

integer

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

pageToken

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListFilteredBidsResponse.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adexchange.buyer