ListImpressionMetricsResponse
Stay organized with collections
Save and categorize content based on your preferences.
Response message for listing the metrics that are measured in number of impressions.
| JSON representation |
{
"impressionMetricsRows": [
{
object (ImpressionMetricsRow)
}
],
"nextPageToken": string
} |
ImpressionMetricsRow
The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.
| Fields |
availableImpressions |
object (MetricValue)
The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable.
|
inventoryMatches |
object (MetricValue)
The number of impressions that match the buyer's inventory pretargeting.
|
bidRequests |
object (MetricValue)
The number of impressions for which Ad Exchange sent the buyer a bid request.
|
successfulResponses |
object (MetricValue)
The number of impressions for which the buyer successfully sent a response to Ad Exchange.
|
responsesWithBids |
object (MetricValue)
The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid.
|
rowDimensions |
object (RowDimensions)
The values of all dimensions associated with metric values in this row.
|
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."],[[["\u003cp\u003eThis documentation outlines the JSON response for listing impression metrics, providing insights into the bidding funnel stages.\u003c/p\u003e\n"],["\u003cp\u003eEach response includes impression metrics rows and a token for retrieving the next page of results.\u003c/p\u003e\n"],["\u003cp\u003eImpression metrics are measured in numbers, showing how many impressions were eligible at each stage, from available impressions to responses with bids.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eImpressionMetricsRow\u003c/code\u003e includes the number of impressions for various stages, like available impressions, inventory matches, bid requests, successful responses, and responses with bids.\u003c/p\u003e\n"],["\u003cp\u003eRow dimensions provide context for the metric values by associating them with specific characteristics of the impressions.\u003c/p\u003e\n"]]],["The core content describes `ImpressionMetricsRow`, which tracks impression metrics during the bidding process. Key metrics include `availableImpressions`, `inventoryMatches`, `bidRequests`, `successfulResponses`, and `responsesWithBids`, each represented as a `MetricValue` object. These metrics quantify impressions at various bidding funnel stages. Results are paginated, using `nextPageToken` for retrieving subsequent pages via `impressionMetrics.list`. The `impressionMetricsRows` field contains these rows and `rowDimensions` are included for associated dimension values.\n"],null,["# ListImpressionMetricsResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ImpressionMetricsRow](#ImpressionMetricsRow)\n - [JSON representation](#ImpressionMetricsRow.SCHEMA_REPRESENTATION)\n\nResponse message for listing the metrics that are measured in number of impressions.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"impressionMetricsRows\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/ListImpressionMetricsResponse#ImpressionMetricsRow) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `impressionMetricsRows[]` | `object (`[ImpressionMetricsRow](/authorized-buyers/apis/reference/rest/v2beta1/ListImpressionMetricsResponse#ImpressionMetricsRow)`)` List of rows, each containing a set of impression metrics. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListImpressionMetricsRequest.pageToken](/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets.impressionMetrics/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the [impressionMetrics.list](/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets.impressionMetrics/list#google.ads.adexchange.buyer.v2beta1.RtbTroubleshooting.ListImpressionMetrics) method to retrieve the next page of results. |\n\nImpressionMetricsRow\n--------------------\n\nThe set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"availableImpressions\": { object (/authorized-buyers/apis/reference/rest/v2beta1/MetricValue) }, \"inventoryMatches\": { object (/authorized-buyers/apis/reference/rest/v2beta1/MetricValue) }, \"bidRequests\": { object (/authorized-buyers/apis/reference/rest/v2beta1/MetricValue) }, \"successfulResponses\": { object (/authorized-buyers/apis/reference/rest/v2beta1/MetricValue) }, \"responsesWithBids\": { object (/authorized-buyers/apis/reference/rest/v2beta1/MetricValue) }, \"rowDimensions\": { object (/authorized-buyers/apis/reference/rest/v2beta1/RowDimensions) } } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `availableImpressions` | `object (`[MetricValue](/authorized-buyers/apis/reference/rest/v2beta1/MetricValue)`)` The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. |\n| `inventoryMatches` | `object (`[MetricValue](/authorized-buyers/apis/reference/rest/v2beta1/MetricValue)`)` The number of impressions that match the buyer's inventory pretargeting. |\n| `bidRequests` | `object (`[MetricValue](/authorized-buyers/apis/reference/rest/v2beta1/MetricValue)`)` The number of impressions for which Ad Exchange sent the buyer a bid request. |\n| `successfulResponses` | `object (`[MetricValue](/authorized-buyers/apis/reference/rest/v2beta1/MetricValue)`)` The number of impressions for which the buyer successfully sent a response to Ad Exchange. |\n| `responsesWithBids` | `object (`[MetricValue](/authorized-buyers/apis/reference/rest/v2beta1/MetricValue)`)` The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. |\n| `rowDimensions` | `object (`[RowDimensions](/authorized-buyers/apis/reference/rest/v2beta1/RowDimensions)`)` The values of all dimensions associated with metric values in this row. |"]]
