Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cdf480e8145d58600a5224efc68ba2ace973ef62 / . / docs / dyn / adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html
blob: a0ce2cc79b431d646e41dec98051e42a0ba7ce64 [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.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html">filterSets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html">bidMetrics()</a></code>
79</p>
80<p class="firstline">Returns the bidMetrics Resource.</p>
81
82<p class="toc_element">
83 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html">bidResponseErrors()</a></code>
84</p>
85<p class="firstline">Returns the bidResponseErrors Resource.</p>
86
87<p class="toc_element">
88 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html">bidResponsesWithoutBids()</a></code>
89</p>
90<p class="firstline">Returns the bidResponsesWithoutBids Resource.</p>
91
92<p class="toc_element">
93 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html">filteredBidRequests()</a></code>
94</p>
95<p class="firstline">Returns the filteredBidRequests Resource.</p>
96
97<p class="toc_element">
98 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html">filteredBids()</a></code>
99</p>
100<p class="firstline">Returns the filteredBids Resource.</p>
101
102<p class="toc_element">
103 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html">impressionMetrics()</a></code>
104</p>
105<p class="firstline">Returns the impressionMetrics Resource.</p>
106
107<p class="toc_element">
108 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html">losingBids()</a></code>
109</p>
110<p class="firstline">Returns the losingBids Resource.</p>
111
112<p class="toc_element">
113 <code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html">nonBillableWinningBids()</a></code>
114</p>
115<p class="firstline">Returns the nonBillableWinningBids Resource.</p>
116
117<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 <code><a href="#close">close()</a></code></p>
119<p class="firstline">Close httplib2 connections.</p>
120<p class="toc_element">
121 <code><a href="#create">create(ownerName, body=None, isTransient=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122<p class="firstline">Creates the specified filter set for the account with the given account ID.</p>
123<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
125<p class="firstline">Deletes the requested filter set from the account with the given account ID.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
128<p class="firstline">Retrieves the requested filter set for the account with the given account ID.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 <code><a href="#list">list(ownerName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131<p class="firstline">Lists all filter sets for the account with the given account ID.</p>
132<p class="toc_element">
133 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
134<p class="firstline">Retrieves the next page of results.</p>
135<h3>Method Details</h3>
136<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 <code class="details" id="close">close()</code>
138 <pre>Close httplib2 connections.</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="create">create(ownerName, body=None, isTransient=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 <pre>Creates the specified filter set for the account with the given account ID.
144
145Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 ownerName: string, Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 The object takes the form of:
149
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150{ # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., &quot;format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)&quot;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]151 &quot;absoluteDateRange&quot;: { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
152 &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]153 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
154 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]155 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]157 &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]158 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
159 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]160 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]162 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]163 &quot;breakdownDimensions&quot;: [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
164 &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]165 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]166 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
167 &quot;dealId&quot;: &quot;A String&quot;, # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
168 &quot;environment&quot;: &quot;A String&quot;, # The environment on which to filter; optional.
169 &quot;format&quot;: &quot;A String&quot;, # Creative format bidded on or allowed to bid on, can be empty.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]170 &quot;formats&quot;: [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.
171 &quot;A String&quot;,
172 ],
173 &quot;name&quot;: &quot;A String&quot;, # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]174 &quot;platforms&quot;: [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
175 &quot;A String&quot;,
176 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]177 &quot;publisherIdentifiers&quot;: [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
178 &quot;A String&quot;,
179 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]180 &quot;realtimeTimeRange&quot;: { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp.
181 &quot;startTimestamp&quot;: &quot;A String&quot;, # The start timestamp of the real-time RTB metrics aggregation.
182 },
183 &quot;relativeDateRange&quot;: { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days &gt;= 0 duration_days &gt;= 1 offset_days + duration_days &lt;= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
184 &quot;durationDays&quot;: 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
185 &quot;offsetDays&quot;: 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
186 },
187 &quot;sellerNetworkIds&quot;: [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
188 42,
189 ],
190 &quot;timeSeriesGranularity&quot;: &quot;A String&quot;, # The granularity of time intervals if a time series breakdown is desired; optional.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]191}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 isTransient: boolean, Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., &quot;format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]203 &quot;absoluteDateRange&quot;: { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
204 &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
205 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
206 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
207 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]208 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]209 &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
210 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
211 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
212 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]213 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]214 },
215 &quot;breakdownDimensions&quot;: [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
216 &quot;A String&quot;,
217 ],
218 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
219 &quot;dealId&quot;: &quot;A String&quot;, # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
220 &quot;environment&quot;: &quot;A String&quot;, # The environment on which to filter; optional.
221 &quot;format&quot;: &quot;A String&quot;, # Creative format bidded on or allowed to bid on, can be empty.
222 &quot;formats&quot;: [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.
223 &quot;A String&quot;,
224 ],
225 &quot;name&quot;: &quot;A String&quot;, # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.
226 &quot;platforms&quot;: [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
227 &quot;A String&quot;,
228 ],
229 &quot;publisherIdentifiers&quot;: [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
230 &quot;A String&quot;,
231 ],
232 &quot;realtimeTimeRange&quot;: { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp.
233 &quot;startTimestamp&quot;: &quot;A String&quot;, # The start timestamp of the real-time RTB metrics aggregation.
234 },
235 &quot;relativeDateRange&quot;: { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days &gt;= 0 duration_days &gt;= 1 offset_days + duration_days &lt;= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
236 &quot;durationDays&quot;: 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
237 &quot;offsetDays&quot;: 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
238 },
239 &quot;sellerNetworkIds&quot;: [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
240 42,
241 ],
242 &quot;timeSeriesGranularity&quot;: &quot;A String&quot;, # The granularity of time intervals if a time series breakdown is desired; optional.
243}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244</div>
245
246<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]247 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
248 <pre>Deletes the requested filter set from the account with the given account ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249
250Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]251 name: string, Full name of the resource to delete. 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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]260 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]261}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262</div>
263
264<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]265 <code class="details" id="get">get(name, x__xgafv=None)</code>
266 <pre>Retrieves the requested filter set for the account with the given account ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267
268Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]269 name: string, Full name of the resource being requested. 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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]278 { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., &quot;format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]279 &quot;absoluteDateRange&quot;: { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
280 &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
281 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
282 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
283 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]284 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]285 &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
286 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
287 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
288 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]289 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]290 },
291 &quot;breakdownDimensions&quot;: [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
292 &quot;A String&quot;,
293 ],
294 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
295 &quot;dealId&quot;: &quot;A String&quot;, # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
296 &quot;environment&quot;: &quot;A String&quot;, # The environment on which to filter; optional.
297 &quot;format&quot;: &quot;A String&quot;, # Creative format bidded on or allowed to bid on, can be empty.
298 &quot;formats&quot;: [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.
299 &quot;A String&quot;,
300 ],
301 &quot;name&quot;: &quot;A String&quot;, # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.
302 &quot;platforms&quot;: [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
303 &quot;A String&quot;,
304 ],
305 &quot;publisherIdentifiers&quot;: [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
306 &quot;A String&quot;,
307 ],
308 &quot;realtimeTimeRange&quot;: { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp.
309 &quot;startTimestamp&quot;: &quot;A String&quot;, # The start timestamp of the real-time RTB metrics aggregation.
310 },
311 &quot;relativeDateRange&quot;: { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days &gt;= 0 duration_days &gt;= 1 offset_days + duration_days &lt;= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
312 &quot;durationDays&quot;: 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
313 &quot;offsetDays&quot;: 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
314 },
315 &quot;sellerNetworkIds&quot;: [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
316 42,
317 ],
318 &quot;timeSeriesGranularity&quot;: &quot;A String&quot;, # The granularity of time intervals if a time series breakdown is desired; optional.
319}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320</div>
321
322<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]323 <code class="details" id="list">list(ownerName, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 <pre>Lists all filter sets for the account with the given account ID.
325
326Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]327 ownerName: string, Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]328 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]329 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 x__xgafv: string, V1 error format.
331 Allowed values
332 1 - v1 error format
333 2 - v2 error format
334
335Returns:
336 An object of the form:
337
338 { # Response message for listing filter sets.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]339 &quot;filterSets&quot;: [ # The filter sets belonging to the buyer.
340 { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., &quot;format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)&quot;.
341 &quot;absoluteDateRange&quot;: { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
342 &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
343 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
344 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
345 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]346 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]347 &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
348 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
349 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
350 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]351 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]352 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]353 &quot;breakdownDimensions&quot;: [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
354 &quot;A String&quot;,
355 ],
356 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
357 &quot;dealId&quot;: &quot;A String&quot;, # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.
358 &quot;environment&quot;: &quot;A String&quot;, # The environment on which to filter; optional.
359 &quot;format&quot;: &quot;A String&quot;, # Creative format bidded on or allowed to bid on, can be empty.
360 &quot;formats&quot;: [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.
361 &quot;A String&quot;,
362 ],
363 &quot;name&quot;: &quot;A String&quot;, # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.
364 &quot;platforms&quot;: [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
365 &quot;A String&quot;,
366 ],
367 &quot;publisherIdentifiers&quot;: [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
368 &quot;A String&quot;,
369 ],
370 &quot;realtimeTimeRange&quot;: { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp.
371 &quot;startTimestamp&quot;: &quot;A String&quot;, # The start timestamp of the real-time RTB metrics aggregation.
372 },
373 &quot;relativeDateRange&quot;: { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days &gt;= 0 duration_days &gt;= 1 offset_days + duration_days &lt;= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
374 &quot;durationDays&quot;: 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
375 &quot;offsetDays&quot;: 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
376 },
377 &quot;sellerNetworkIds&quot;: [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
378 42,
379 ],
380 &quot;timeSeriesGranularity&quot;: &quot;A String&quot;, # The granularity of time intervals if a time series breakdown is desired; optional.
381 },
382 ],
383 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results.
384}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]385</div>
386
387<div class="method">
388 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
389 <pre>Retrieves the next page of results.
390
391Args:
392 previous_request: The request for the previous page. (required)
393 previous_response: The response from the request for the previous page. (required)
394
395Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]396 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]397 page. Returns None if there are no more items in the collection.
398 </pre>
399</div>
400
401</body></html>