Method: bidders.filterSets.bidMetrics.list
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["Lists all metrics measured by the number of bids, filtered by a specified filter set."],["Uses an HTTP GET request with path and query parameters to define the scope of the data retrieved."],["Requires `https://www.googleapis.com/auth/adexchange.buyer` authorization scope for access."],["Returns a paginated list of bid metrics within a `ListBidMetricsResponse` object upon successful execution."]]],["This document details how to retrieve bid metrics using the `bidMetrics.list` method. It utilizes a `GET` HTTP request to a specific URL with a `filterSetName` path parameter, identifying the desired filter set. Optional query parameters, `pageSize` and `pageToken`, manage result pagination. The request body must be empty. Successful responses are returned in `ListBidMetricsResponse` format, and authorization requires the `adexchange.buyer` OAuth scope. Metrics are calculated by number of bids.\n"]]
