Ad Exchange Buyer API II . bidders . filterSets . impressionMetrics

Instance Methods

list(filterSetName=None, 123=None, pageSize=None, pageToken=None, x__xgafv=None)

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

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Method Details

list(filterSetName=None, 123=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all metrics that are measured in terms of number of impressions.

Args:
  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` (required)
  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
ListImpressionMetricsResponse.nextPageToken
returned from the previous call to the impressionMetrics.list
method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for listing the metrics that are measured in number of
      # impressions.
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # ListImpressionMetricsRequest.pageToken
        # field in the subsequent call to the impressionMetrics.list
        # method to retrieve the next page of results.
    "impressionMetricsRows": [ # List of rows, each containing a set of impression metrics.
      { # 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.
        "responsesWithBids": { # A metric value, with an expected value and a variance; represents a count # The number of impressions for which Ad Exchange received a response from
            # the buyer that contained at least one applicable bid.
            # that may be either exact or estimated (i.e. when sampled).
          "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value.
              # If value is exact, variance is 0.
              # Can be used to calculate margin of error as a percentage of value, using
              # the following formula, where Z is the standard constant that depends on the
              # desired size of the confidence interval (e.g. for 90% confidence interval,
              # use Z = 1.645):
              #
              #   marginOfError = 100 * Z * sqrt(variance) / value
          "value": "A String", # The expected value of the metric.
        },
        "successfulResponses": { # A metric value, with an expected value and a variance; represents a count # The number of impressions for which the buyer successfully sent a response
            # to Ad Exchange.
            # that may be either exact or estimated (i.e. when sampled).
          "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value.
              # If value is exact, variance is 0.
              # Can be used to calculate margin of error as a percentage of value, using
              # the following formula, where Z is the standard constant that depends on the
              # desired size of the confidence interval (e.g. for 90% confidence interval,
              # use Z = 1.645):
              #
              #   marginOfError = 100 * Z * sqrt(variance) / value
          "value": "A String", # The expected value of the metric.
        },
        "inventoryMatches": { # A metric value, with an expected value and a variance; represents a count # The number of impressions that match the buyer's inventory pretargeting.
            # that may be either exact or estimated (i.e. when sampled).
          "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value.
              # If value is exact, variance is 0.
              # Can be used to calculate margin of error as a percentage of value, using
              # the following formula, where Z is the standard constant that depends on the
              # desired size of the confidence interval (e.g. for 90% confidence interval,
              # use Z = 1.645):
              #
              #   marginOfError = 100 * Z * sqrt(variance) / value
          "value": "A String", # The expected value of the metric.
        },
        "bidRequests": { # A metric value, with an expected value and a variance; represents a count # The number of impressions for which Ad Exchange sent the buyer a bid
            # request.
            # that may be either exact or estimated (i.e. when sampled).
          "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value.
              # If value is exact, variance is 0.
              # Can be used to calculate margin of error as a percentage of value, using
              # the following formula, where Z is the standard constant that depends on the
              # desired size of the confidence interval (e.g. for 90% confidence interval,
              # use Z = 1.645):
              #
              #   marginOfError = 100 * Z * sqrt(variance) / value
          "value": "A String", # The expected value of the metric.
        },
        "availableImpressions": { # A metric value, with an expected value and a variance; represents a count # The number of impressions available to the buyer on Ad Exchange.
            # In some cases this value may be unavailable.
            # that may be either exact or estimated (i.e. when sampled).
          "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value.
              # If value is exact, variance is 0.
              # Can be used to calculate margin of error as a percentage of value, using
              # the following formula, where Z is the standard constant that depends on the
              # desired size of the confidence interval (e.g. for 90% confidence interval,
              # use Z = 1.645):
              #
              #   marginOfError = 100 * Z * sqrt(variance) / value
          "value": "A String", # The expected value of the metric.
        },
        "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. # The values of all dimensions associated with metric values in this row.
            # Encapsulates the values of all dimensions for a given row.
          "timeInterval": { # An interval of time, with an absolute start and end. # The time interval that this row represents.
            "endTime": "A String", # The timestamp marking the end of the range (exclusive) for which data is
                # included.
            "startTime": "A String", # The timestamp marking the start of the range (inclusive) for which data is
                # included.
          },
          "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by
              # [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension)
              # was requested.
        },
      },
    ],
  }
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.