Method: bidders.filterSets.bidMetrics.list

  • This document provides reference information for listing bid metrics.

  • The list operation uses a GET HTTP request.

  • The request includes a filterSetName path parameter to specify the filter set.

  • Optional query parameters like pageSize and pageToken can be used for pagination.

  • The response body contains a ListBidMetricsResponse object.

Lists all metrics that are measured in terms of number of bids.

HTTP request

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

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 ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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