Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e4b5db2a4aeceb4b99f280e8a843c65284c2f9f / . / docs / dyn / adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.html
blob: 20c03a8feed80f4cce7e163c255c0e6a611210a1 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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.filteredBids.html">filteredBids</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.creatives.html">creatives()</a></code>
79</p>
80<p class="firstline">Returns the creatives Resource.</p>
81
82<p class="toc_element">
83 <code><a href="adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.details.html">details()</a></code>
84</p>
85<p class="firstline">Returns the details Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]91 <code><a href="#list">list(filterSetName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<p class="firstline">List all reasons for which bids were filtered, with the number of bids filtered for each reason.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
102<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]103 <code class="details" id="list">list(filterSetName, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104 <pre>List all reasons for which bids were filtered, with the number of bids filtered for each reason.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105
106Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107 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)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]108 pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 { # Response message for listing all reasons that bids were filtered from the auction.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]119 &quot;creativeStatusRows&quot;: [ # List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status).
120 { # The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.
121 &quot;bidCount&quot;: { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status.
122 &quot;value&quot;: &quot;A String&quot;, # The expected value of the metric.
123 &quot;variance&quot;: &quot;A String&quot;, # 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]125 &quot;creativeStatusId&quot;: 42, # The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
126 &quot;rowDimensions&quot;: { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row.
127 &quot;publisherIdentifier&quot;: &quot;A String&quot;, # 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.
128 &quot;timeInterval&quot;: { # An interval of time, with an absolute start and end. # The time interval that this row represents.
129 &quot;endTime&quot;: &quot;A String&quot;, # The timestamp marking the end of the range (exclusive) for which data is included.
130 &quot;startTime&quot;: &quot;A String&quot;, # The timestamp marking the start of the range (inclusive) for which data is included.
131 },
132 },
133 },
134 ],
135 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results.
136}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137</div>
138
139<div class="method">
140 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
141 <pre>Retrieves the next page of results.
142
143Args:
144 previous_request: The request for the previous page. (required)
145 previous_response: The response from the request for the previous page. (required)
146
147Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 page. Returns None if there are no more items in the collection.
150 </pre>
151</div>
152
153</body></html>