1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.bidders.html">bidders</a> . <a href="adexchangebuyer2_v2beta1.bidders.filterSets.html">filterSets</a> . <a href="adexchangebuyer2_v2beta1.bidders.filterSets.bidMetrics.html">bidMetrics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(filterSetName=None, 123, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all metrics that are measured in terms of number of bids.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(filterSetName=None, 123, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all metrics that are measured in terms of number of bids.
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
ListBidMetricsResponse.nextPageToken
returned from the previous call to the bidMetrics.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 bids.
"nextPageToken": "A String", # A token to retrieve the next page of results.
# Pass this value in the
# ListBidMetricsRequest.pageToken
# field in the subsequent call to the bidMetrics.list
# method to retrieve the next page of results.
"bidMetricsRows": [ # List of rows, each containing a set of bid metrics.
{ # The set of metrics that are measured in numbers of bids, representing how
# many bids with the specified dimension values were considered eligible at
# each stage of the bidding funnel;
"impressionsWon": { # A metric value, with an expected value and a variance; represents a count # The number of bids that won an impression.
# 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.
},
"billedImpressions": { # A metric value, with an expected value and a variance; represents a count # The number of bids for which the buyer was billed.
# 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.
},
"measurableImpressions": { # A metric value, with an expected value and a variance; represents a count # The number of bids for which the corresponding impression was measurable
# for viewability (as defined by Active View).
# 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.
},
"bids": { # A metric value, with an expected value and a variance; represents a count # The number of bids that Ad Exchange received from the buyer.
# 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.
},
"viewableImpressions": { # A metric value, with an expected value and a variance; represents a count # The number of bids for which the corresponding impression was viewable (as
# defined by Active View).
# 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.
},
"bidsInAuction": { # A metric value, with an expected value and a variance; represents a count # The number of bids that were permitted to compete in the auction.
# 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.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>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.
</pre>
</div>
</body></html>
|
