List all details associated with a specific reason for which bids were
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.
list(filterSetName=None, 123=None, creativeStatusId=None, pageSize=None, pageToken=None, x__xgafv=None)
List all details associated with a specific reason for which bids were
filtered, with the number of bids filtered for each detail.
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)
creativeStatusId: integer, The ID of the creative status for which to retrieve a breakdown by detail.
See
[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. (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
ListCreativeStatusBreakdownByDetailResponse.nextPageToken
returned from the previous call to the filteredBids.details.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 all details associated with a given filtered bid
# reason.
"nextPageToken": "A String", # A token to retrieve the next page of results.
# Pass this value in the
# ListCreativeStatusBreakdownByDetailRequest.pageToken
# field in the subsequent call to the filteredBids.details.list
# method to retrieve the next page of results.
"detailType": "A String", # The type of detail that the detail IDs represent.
"filteredBidDetailRows": [ # List of rows, with counts of bids with a given creative status aggregated
# by detail.
{ # The number of filtered bids with the specified dimension values, among those
# filtered due to the requested filtering reason (i.e. creative status), that
# have the specified detail.
"detailId": 42, # The ID of the detail. The associated value can be looked up in the
# dictionary file corresponding to the DetailType in the response message.
"bidCount": { # A metric value, with an expected value and a variance; represents a count # The number of bids with the specified detail.
# 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.