blob: 75362947865e6d31a1d73676aa23f4aaf2b84044 [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001<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="realtimebidding_v1.html">Real-time Bidding API</a> . <a href="realtimebidding_v1.bidders.html">bidders</a> . <a href="realtimebidding_v1.bidders.pretargetingConfigs.html">pretargetingConfigs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Activates a pretargeting configuration.</p>
80<p class="toc_element">
81 <code><a href="#addTargetedApps">addTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Adds targeted apps to the pretargeting configuration.</p>
83<p class="toc_element">
84 <code><a href="#addTargetedPublishers">addTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Adds targeted publishers to the pretargeting config.</p>
86<p class="toc_element">
87 <code><a href="#addTargetedSites">addTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Adds targeted sites to the pretargeting configuration.</p>
89<p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91<p class="firstline">Close httplib2 connections.</p>
92<p class="toc_element">
93 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.</p>
95<p class="toc_element">
96 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Deletes a pretargeting configuration.</p>
98<p class="toc_element">
99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
100<p class="firstline">Gets a pretargeting configuration.</p>
101<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800102 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700103<p class="firstline">Lists all pretargeting configurations for a single bidder.</p>
104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Updates a pretargeting configuration.</p>
110<p class="toc_element">
111 <code><a href="#removeTargetedApps">removeTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
112<p class="firstline">Removes targeted apps from the pretargeting configuration.</p>
113<p class="toc_element">
114 <code><a href="#removeTargetedPublishers">removeTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Removes targeted publishers from the pretargeting config.</p>
116<p class="toc_element">
117 <code><a href="#removeTargetedSites">removeTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</a></code></p>
118<p class="firstline">Removes targeted sites from the pretargeting configuration.</p>
119<p class="toc_element">
120 <code><a href="#suspend">suspend(name, body=None, x__xgafv=None)</a></code></p>
121<p class="firstline">Suspends a pretargeting configuration.</p>
122<h3>Method Details</h3>
123<div class="method">
124 <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>
125 <pre>Activates a pretargeting configuration.
126
127Args:
128 name: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
129 body: object, The request body.
130 The object takes the form of:
131
132{ # A request to activate a pretargeting configuration. Sets the configuration&#x27;s state to ACTIVE.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700134
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
145 &quot;A String&quot;,
146 ],
147 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
148 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
149 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
150 &quot;A String&quot;,
151 ],
152 &quot;includedIds&quot;: [ # The IDs included in a configuration.
153 &quot;A String&quot;,
154 ],
155 },
156 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800157 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
158 &quot;values&quot;: [ # The values specified.
159 &quot;A String&quot;,
160 ],
161 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 },
163 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
164 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
165 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
166 &quot;A String&quot;,
167 ],
168 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
169 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800170 &quot;A String&quot;,
171 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800172 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800173 &quot;A String&quot;,
174 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 },
176 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
177 { # The dimensions of a creative. This applies to only HTML and Native creatives.
178 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
179 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800180 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800181 ],
182 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
183 &quot;A String&quot;,
184 ],
185 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
186 &quot;A String&quot;,
187 ],
188 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
189 &quot;A String&quot;,
190 ],
191 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
192 &quot;A String&quot;,
193 ],
194 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
195 &quot;A String&quot;,
196 ],
197 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
198 &quot;A String&quot;,
199 ],
200 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
201 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
202 &quot;A String&quot;,
203 ],
204 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
205 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
206 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
207 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
208 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
209 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800210 &quot;A String&quot;,
211 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800212 },
213 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
214 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
215 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800216 &quot;A String&quot;,
217 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800218 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800219 &quot;A String&quot;,
220 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800221 },
222 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
223 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
224 &quot;A String&quot;,
225 ],
226 &quot;includedIds&quot;: [ # The IDs included in a configuration.
227 &quot;A String&quot;,
228 ],
229 },
230 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
231 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
232 &quot;values&quot;: [ # The values specified.
233 &quot;A String&quot;,
234 ],
235 },
236}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700237</div>
238
239<div class="method">
240 <code class="details" id="addTargetedApps">addTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</code>
241 <pre>Adds targeted apps to the pretargeting configuration.
242
243Args:
244 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
245 body: object, The request body.
246 The object takes the form of:
247
248{ # A request to start targeting the provided app IDs in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 &quot;appIds&quot;: [ # A list of app IDs to target in the pretargeting configuration. These values will be added to the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.
250 &quot;A String&quot;,
251 ],
252 &quot;targetingMode&quot;: &quot;A String&quot;, # Required. The targeting mode that should be applied to the list of app IDs. If there are existing targeted app IDs, must be equal to the existing PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400 bad request error will be returned.
253}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700254
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800264 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
265 &quot;A String&quot;,
266 ],
267 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
268 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
269 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
270 &quot;A String&quot;,
271 ],
272 &quot;includedIds&quot;: [ # The IDs included in a configuration.
273 &quot;A String&quot;,
274 ],
275 },
276 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800277 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
278 &quot;values&quot;: [ # The values specified.
279 &quot;A String&quot;,
280 ],
281 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800282 },
283 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
284 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
285 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
286 &quot;A String&quot;,
287 ],
288 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
289 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800290 &quot;A String&quot;,
291 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800292 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800293 &quot;A String&quot;,
294 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800295 },
296 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
297 { # The dimensions of a creative. This applies to only HTML and Native creatives.
298 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
299 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800300 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800301 ],
302 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
303 &quot;A String&quot;,
304 ],
305 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
306 &quot;A String&quot;,
307 ],
308 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
309 &quot;A String&quot;,
310 ],
311 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
312 &quot;A String&quot;,
313 ],
314 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
315 &quot;A String&quot;,
316 ],
317 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
318 &quot;A String&quot;,
319 ],
320 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
321 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
322 &quot;A String&quot;,
323 ],
324 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
325 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
326 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
327 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
328 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
329 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800330 &quot;A String&quot;,
331 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800332 },
333 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
334 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
335 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800336 &quot;A String&quot;,
337 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800338 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800339 &quot;A String&quot;,
340 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800341 },
342 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
343 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
344 &quot;A String&quot;,
345 ],
346 &quot;includedIds&quot;: [ # The IDs included in a configuration.
347 &quot;A String&quot;,
348 ],
349 },
350 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
351 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
352 &quot;values&quot;: [ # The values specified.
353 &quot;A String&quot;,
354 ],
355 },
356}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700357</div>
358
359<div class="method">
360 <code class="details" id="addTargetedPublishers">addTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</code>
361 <pre>Adds targeted publishers to the pretargeting config.
362
363Args:
364 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
365 body: object, The request body.
366 The object takes the form of:
367
368{ # A request to start targeting the provided publishers in a specific pretargeting configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;publisherIds&quot;: [ # A list of publisher IDs to target in the pretargeting configuration. These values will be added to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
370 &quot;A String&quot;,
371 ],
372 &quot;targetingMode&quot;: &quot;A String&quot;, # Required. The targeting mode that should be applied to the list of publisher IDs. If are existing publisher IDs, must be equal to the existing PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be returned.
373}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700374
375 x__xgafv: string, V1 error format.
376 Allowed values
377 1 - v1 error format
378 2 - v2 error format
379
380Returns:
381 An object of the form:
382
383 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
385 &quot;A String&quot;,
386 ],
387 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
388 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
389 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
390 &quot;A String&quot;,
391 ],
392 &quot;includedIds&quot;: [ # The IDs included in a configuration.
393 &quot;A String&quot;,
394 ],
395 },
396 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800397 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
398 &quot;values&quot;: [ # The values specified.
399 &quot;A String&quot;,
400 ],
401 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800402 },
403 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
404 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
405 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
406 &quot;A String&quot;,
407 ],
408 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
409 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800410 &quot;A String&quot;,
411 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800412 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800413 &quot;A String&quot;,
414 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800415 },
416 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
417 { # The dimensions of a creative. This applies to only HTML and Native creatives.
418 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
419 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800420 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800421 ],
422 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
423 &quot;A String&quot;,
424 ],
425 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
426 &quot;A String&quot;,
427 ],
428 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
429 &quot;A String&quot;,
430 ],
431 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
432 &quot;A String&quot;,
433 ],
434 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
435 &quot;A String&quot;,
436 ],
437 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
438 &quot;A String&quot;,
439 ],
440 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
441 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
442 &quot;A String&quot;,
443 ],
444 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
445 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
446 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
447 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
448 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
449 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800450 &quot;A String&quot;,
451 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800452 },
453 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
454 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
455 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800456 &quot;A String&quot;,
457 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800458 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800459 &quot;A String&quot;,
460 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461 },
462 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
463 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
464 &quot;A String&quot;,
465 ],
466 &quot;includedIds&quot;: [ # The IDs included in a configuration.
467 &quot;A String&quot;,
468 ],
469 },
470 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
471 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
472 &quot;values&quot;: [ # The values specified.
473 &quot;A String&quot;,
474 ],
475 },
476}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700477</div>
478
479<div class="method">
480 <code class="details" id="addTargetedSites">addTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</code>
481 <pre>Adds targeted sites to the pretargeting configuration.
482
483Args:
484 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
485 body: object, The request body.
486 The object takes the form of:
487
488{ # A request to start targeting the provided sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800489 &quot;sites&quot;: [ # A list of site URLs to target in the pretargeting configuration. These values will be added to the list of targeted URLs in PretargetingConfig.webTargeting.values.
490 &quot;A String&quot;,
491 ],
492 &quot;targetingMode&quot;: &quot;A String&quot;, # Required. The targeting mode that should be applied to the list of site URLs. If there are existing targeted sites, must be equal to the existing PretargetingConfig.webTargeting.targetingMode or a 400 bad request error will be returned.
493}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700494
495 x__xgafv: string, V1 error format.
496 Allowed values
497 1 - v1 error format
498 2 - v2 error format
499
500Returns:
501 An object of the form:
502
503 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800504 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
505 &quot;A String&quot;,
506 ],
507 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
508 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
509 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
510 &quot;A String&quot;,
511 ],
512 &quot;includedIds&quot;: [ # The IDs included in a configuration.
513 &quot;A String&quot;,
514 ],
515 },
516 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800517 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
518 &quot;values&quot;: [ # The values specified.
519 &quot;A String&quot;,
520 ],
521 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800522 },
523 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
524 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
525 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
526 &quot;A String&quot;,
527 ],
528 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
529 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800530 &quot;A String&quot;,
531 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800532 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800533 &quot;A String&quot;,
534 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800535 },
536 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
537 { # The dimensions of a creative. This applies to only HTML and Native creatives.
538 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
539 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800540 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800541 ],
542 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
543 &quot;A String&quot;,
544 ],
545 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
546 &quot;A String&quot;,
547 ],
548 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
549 &quot;A String&quot;,
550 ],
551 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
552 &quot;A String&quot;,
553 ],
554 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
555 &quot;A String&quot;,
556 ],
557 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
558 &quot;A String&quot;,
559 ],
560 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
561 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
562 &quot;A String&quot;,
563 ],
564 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
565 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
566 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
567 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
568 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
569 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800570 &quot;A String&quot;,
571 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800572 },
573 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
574 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
575 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800576 &quot;A String&quot;,
577 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800578 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800579 &quot;A String&quot;,
580 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800581 },
582 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
583 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
584 &quot;A String&quot;,
585 ],
586 &quot;includedIds&quot;: [ # The IDs included in a configuration.
587 &quot;A String&quot;,
588 ],
589 },
590 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
591 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
592 &quot;values&quot;: [ # The values specified.
593 &quot;A String&quot;,
594 ],
595 },
596}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700597</div>
598
599<div class="method">
600 <code class="details" id="close">close()</code>
601 <pre>Close httplib2 connections.</pre>
602</div>
603
604<div class="method">
605 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
606 <pre>Creates a pretargeting configuration. A pretargeting configuration&#x27;s state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.
607
608Args:
609 parent: string, Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId} (required)
610 body: object, The request body.
611 The object takes the form of:
612
613{ # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800614 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
615 &quot;A String&quot;,
616 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800617 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800618 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
619 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
620 &quot;A String&quot;,
621 ],
622 &quot;includedIds&quot;: [ # The IDs included in a configuration.
623 &quot;A String&quot;,
624 ],
625 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800626 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
627 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
628 &quot;values&quot;: [ # The values specified.
629 &quot;A String&quot;,
630 ],
631 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800632 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800633 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
634 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
635 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800636 &quot;A String&quot;,
637 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800638 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800639 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
640 &quot;A String&quot;,
641 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800642 &quot;includedIds&quot;: [ # The IDs included in a configuration.
643 &quot;A String&quot;,
644 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800645 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800646 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
647 { # The dimensions of a creative. This applies to only HTML and Native creatives.
648 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
649 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
650 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800651 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800652 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
653 &quot;A String&quot;,
654 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800655 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
656 &quot;A String&quot;,
657 ],
658 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
659 &quot;A String&quot;,
660 ],
661 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
662 &quot;A String&quot;,
663 ],
664 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
665 &quot;A String&quot;,
666 ],
667 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
668 &quot;A String&quot;,
669 ],
670 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
671 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
672 &quot;A String&quot;,
673 ],
674 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
675 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
676 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
677 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
678 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
679 &quot;values&quot;: [ # The values specified.
680 &quot;A String&quot;,
681 ],
682 },
683 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
684 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
685 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
686 &quot;A String&quot;,
687 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800688 &quot;includedIds&quot;: [ # The IDs included in a configuration.
689 &quot;A String&quot;,
690 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800691 },
692 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800693 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
694 &quot;A String&quot;,
695 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800696 &quot;includedIds&quot;: [ # The IDs included in a configuration.
697 &quot;A String&quot;,
698 ],
699 },
700 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
701 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
702 &quot;values&quot;: [ # The values specified.
703 &quot;A String&quot;,
704 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800705 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700706}
707
708 x__xgafv: string, V1 error format.
709 Allowed values
710 1 - v1 error format
711 2 - v2 error format
712
713Returns:
714 An object of the form:
715
716 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800717 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
718 &quot;A String&quot;,
719 ],
720 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
721 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
722 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
723 &quot;A String&quot;,
724 ],
725 &quot;includedIds&quot;: [ # The IDs included in a configuration.
726 &quot;A String&quot;,
727 ],
728 },
729 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800730 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
731 &quot;values&quot;: [ # The values specified.
732 &quot;A String&quot;,
733 ],
734 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800735 },
736 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
737 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
738 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
739 &quot;A String&quot;,
740 ],
741 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
742 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800743 &quot;A String&quot;,
744 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800745 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800746 &quot;A String&quot;,
747 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800748 },
749 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
750 { # The dimensions of a creative. This applies to only HTML and Native creatives.
751 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
752 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800753 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800754 ],
755 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
756 &quot;A String&quot;,
757 ],
758 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
759 &quot;A String&quot;,
760 ],
761 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
762 &quot;A String&quot;,
763 ],
764 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
765 &quot;A String&quot;,
766 ],
767 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
768 &quot;A String&quot;,
769 ],
770 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
771 &quot;A String&quot;,
772 ],
773 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
774 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
775 &quot;A String&quot;,
776 ],
777 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
778 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
779 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
780 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
781 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
782 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800783 &quot;A String&quot;,
784 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800785 },
786 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
787 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
788 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800789 &quot;A String&quot;,
790 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800791 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800792 &quot;A String&quot;,
793 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800794 },
795 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
796 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
797 &quot;A String&quot;,
798 ],
799 &quot;includedIds&quot;: [ # The IDs included in a configuration.
800 &quot;A String&quot;,
801 ],
802 },
803 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
804 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
805 &quot;values&quot;: [ # The values specified.
806 &quot;A String&quot;,
807 ],
808 },
809}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700810</div>
811
812<div class="method">
813 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
814 <pre>Deletes a pretargeting configuration.
815
816Args:
817 name: string, Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
818 x__xgafv: string, V1 error format.
819 Allowed values
820 1 - v1 error format
821 2 - v2 error format
822
823Returns:
824 An object of the form:
825
826 { # 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 -0800827}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700828</div>
829
830<div class="method">
831 <code class="details" id="get">get(name, x__xgafv=None)</code>
832 <pre>Gets a pretargeting configuration.
833
834Args:
835 name: string, Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
836 x__xgafv: string, V1 error format.
837 Allowed values
838 1 - v1 error format
839 2 - v2 error format
840
841Returns:
842 An object of the form:
843
844 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800845 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
846 &quot;A String&quot;,
847 ],
848 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
849 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
850 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
851 &quot;A String&quot;,
852 ],
853 &quot;includedIds&quot;: [ # The IDs included in a configuration.
854 &quot;A String&quot;,
855 ],
856 },
857 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800858 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
859 &quot;values&quot;: [ # The values specified.
860 &quot;A String&quot;,
861 ],
862 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800863 },
864 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
865 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
866 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
867 &quot;A String&quot;,
868 ],
869 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
870 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800871 &quot;A String&quot;,
872 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800873 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800874 &quot;A String&quot;,
875 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800876 },
877 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
878 { # The dimensions of a creative. This applies to only HTML and Native creatives.
879 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
880 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800881 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800882 ],
883 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
884 &quot;A String&quot;,
885 ],
886 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
887 &quot;A String&quot;,
888 ],
889 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
890 &quot;A String&quot;,
891 ],
892 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
893 &quot;A String&quot;,
894 ],
895 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
896 &quot;A String&quot;,
897 ],
898 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
899 &quot;A String&quot;,
900 ],
901 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
902 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
903 &quot;A String&quot;,
904 ],
905 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
906 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
907 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
908 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
909 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
910 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800911 &quot;A String&quot;,
912 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800913 },
914 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
915 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
916 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800917 &quot;A String&quot;,
918 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800919 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800920 &quot;A String&quot;,
921 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800922 },
923 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
924 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
925 &quot;A String&quot;,
926 ],
927 &quot;includedIds&quot;: [ # The IDs included in a configuration.
928 &quot;A String&quot;,
929 ],
930 },
931 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
932 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
933 &quot;values&quot;: [ # The values specified.
934 &quot;A String&quot;,
935 ],
936 },
937}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700938</div>
939
940<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800941 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700942 <pre>Lists all pretargeting configurations for a single bidder.
943
944Args:
945 parent: string, Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId} (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800946 pageSize: integer, The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800947 pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListPretargetingConfigs` call in ListPretargetingConfigsResponse.nextPageToken.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700948 x__xgafv: string, V1 error format.
949 Allowed values
950 1 - v1 error format
951 2 - v2 error format
952
953Returns:
954 An object of the form:
955
956 { # A response containing pretargeting configurations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800957 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken.
958 &quot;pretargetingConfigs&quot;: [ # List of pretargeting configurations.
959 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
960 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
961 &quot;A String&quot;,
962 ],
963 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
964 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
965 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
966 &quot;A String&quot;,
967 ],
968 &quot;includedIds&quot;: [ # The IDs included in a configuration.
969 &quot;A String&quot;,
970 ],
971 },
972 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800973 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
974 &quot;values&quot;: [ # The values specified.
975 &quot;A String&quot;,
976 ],
977 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700978 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800979 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
980 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
981 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
982 &quot;A String&quot;,
983 ],
984 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
985 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
986 &quot;A String&quot;,
987 ],
988 &quot;includedIds&quot;: [ # The IDs included in a configuration.
989 &quot;A String&quot;,
990 ],
991 },
992 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
993 { # The dimensions of a creative. This applies to only HTML and Native creatives.
994 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
995 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
996 },
997 ],
998 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
999 &quot;A String&quot;,
1000 ],
1001 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1002 &quot;A String&quot;,
1003 ],
1004 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1005 &quot;A String&quot;,
1006 ],
1007 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1008 &quot;A String&quot;,
1009 ],
1010 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1011 &quot;A String&quot;,
1012 ],
1013 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1014 &quot;A String&quot;,
1015 ],
1016 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1017 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1018 &quot;A String&quot;,
1019 ],
1020 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1021 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1022 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1023 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1024 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1025 &quot;values&quot;: [ # The values specified.
1026 &quot;A String&quot;,
1027 ],
1028 },
1029 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1030 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1031 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1032 &quot;A String&quot;,
1033 ],
1034 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1035 &quot;A String&quot;,
1036 ],
1037 },
1038 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1039 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1040 &quot;A String&quot;,
1041 ],
1042 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1043 &quot;A String&quot;,
1044 ],
1045 },
1046 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1047 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1048 &quot;values&quot;: [ # The values specified.
1049 &quot;A String&quot;,
1050 ],
1051 },
1052 },
1053 ],
1054}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001055</div>
1056
1057<div class="method">
1058 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1059 <pre>Retrieves the next page of results.
1060
1061Args:
1062 previous_request: The request for the previous page. (required)
1063 previous_response: The response from the request for the previous page. (required)
1064
1065Returns:
1066 A request object that you can call &#x27;execute()&#x27; on to request the next
1067 page. Returns None if there are no more items in the collection.
1068 </pre>
1069</div>
1070
1071<div class="method">
1072 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
1073 <pre>Updates a pretargeting configuration.
1074
1075Args:
1076 name: string, Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` (required)
1077 body: object, The request body.
1078 The object takes the form of:
1079
1080{ # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001081 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1082 &quot;A String&quot;,
1083 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001084 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001085 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1086 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1087 &quot;A String&quot;,
1088 ],
1089 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1090 &quot;A String&quot;,
1091 ],
1092 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001093 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
1094 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1095 &quot;values&quot;: [ # The values specified.
1096 &quot;A String&quot;,
1097 ],
1098 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001099 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001100 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1101 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1102 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001103 &quot;A String&quot;,
1104 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001105 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001106 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1107 &quot;A String&quot;,
1108 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001109 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1110 &quot;A String&quot;,
1111 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001112 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001113 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1114 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1115 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1116 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
1117 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001118 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001119 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1120 &quot;A String&quot;,
1121 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001122 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1123 &quot;A String&quot;,
1124 ],
1125 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1126 &quot;A String&quot;,
1127 ],
1128 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1129 &quot;A String&quot;,
1130 ],
1131 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1132 &quot;A String&quot;,
1133 ],
1134 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1135 &quot;A String&quot;,
1136 ],
1137 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1138 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1139 &quot;A String&quot;,
1140 ],
1141 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1142 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1143 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1144 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1145 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1146 &quot;values&quot;: [ # The values specified.
1147 &quot;A String&quot;,
1148 ],
1149 },
1150 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1151 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1152 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1153 &quot;A String&quot;,
1154 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001155 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1156 &quot;A String&quot;,
1157 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001158 },
1159 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001160 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1161 &quot;A String&quot;,
1162 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001163 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1164 &quot;A String&quot;,
1165 ],
1166 },
1167 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1168 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1169 &quot;values&quot;: [ # The values specified.
1170 &quot;A String&quot;,
1171 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001172 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001173}
1174
1175 updateMask: string, Field mask to use for partial in-place updates.
1176 x__xgafv: string, V1 error format.
1177 Allowed values
1178 1 - v1 error format
1179 2 - v2 error format
1180
1181Returns:
1182 An object of the form:
1183
1184 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001185 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1186 &quot;A String&quot;,
1187 ],
1188 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
1189 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1190 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1191 &quot;A String&quot;,
1192 ],
1193 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1194 &quot;A String&quot;,
1195 ],
1196 },
1197 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001198 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1199 &quot;values&quot;: [ # The values specified.
1200 &quot;A String&quot;,
1201 ],
1202 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001203 },
1204 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1205 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1206 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
1207 &quot;A String&quot;,
1208 ],
1209 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
1210 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001211 &quot;A String&quot;,
1212 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001213 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001214 &quot;A String&quot;,
1215 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001216 },
1217 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1218 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1219 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1220 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001221 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001222 ],
1223 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1224 &quot;A String&quot;,
1225 ],
1226 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1227 &quot;A String&quot;,
1228 ],
1229 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1230 &quot;A String&quot;,
1231 ],
1232 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1233 &quot;A String&quot;,
1234 ],
1235 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1236 &quot;A String&quot;,
1237 ],
1238 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1239 &quot;A String&quot;,
1240 ],
1241 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1242 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1243 &quot;A String&quot;,
1244 ],
1245 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1246 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1247 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1248 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1249 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1250 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001251 &quot;A String&quot;,
1252 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001253 },
1254 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1255 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1256 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001257 &quot;A String&quot;,
1258 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001259 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001260 &quot;A String&quot;,
1261 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001262 },
1263 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1264 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1265 &quot;A String&quot;,
1266 ],
1267 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1268 &quot;A String&quot;,
1269 ],
1270 },
1271 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1272 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1273 &quot;values&quot;: [ # The values specified.
1274 &quot;A String&quot;,
1275 ],
1276 },
1277}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001278</div>
1279
1280<div class="method">
1281 <code class="details" id="removeTargetedApps">removeTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</code>
1282 <pre>Removes targeted apps from the pretargeting configuration.
1283
1284Args:
1285 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
1286 body: object, The request body.
1287 The object takes the form of:
1288
1289{ # A request to stop targeting the provided apps in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001290 &quot;appIds&quot;: [ # A list of app IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.
1291 &quot;A String&quot;,
1292 ],
1293}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001294
1295 x__xgafv: string, V1 error format.
1296 Allowed values
1297 1 - v1 error format
1298 2 - v2 error format
1299
1300Returns:
1301 An object of the form:
1302
1303 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001304 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1305 &quot;A String&quot;,
1306 ],
1307 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
1308 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1309 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1310 &quot;A String&quot;,
1311 ],
1312 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1313 &quot;A String&quot;,
1314 ],
1315 },
1316 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001317 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1318 &quot;values&quot;: [ # The values specified.
1319 &quot;A String&quot;,
1320 ],
1321 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001322 },
1323 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1324 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1325 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
1326 &quot;A String&quot;,
1327 ],
1328 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
1329 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001330 &quot;A String&quot;,
1331 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001332 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001333 &quot;A String&quot;,
1334 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001335 },
1336 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1337 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1338 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1339 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001340 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001341 ],
1342 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1343 &quot;A String&quot;,
1344 ],
1345 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1346 &quot;A String&quot;,
1347 ],
1348 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1349 &quot;A String&quot;,
1350 ],
1351 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1352 &quot;A String&quot;,
1353 ],
1354 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1355 &quot;A String&quot;,
1356 ],
1357 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1358 &quot;A String&quot;,
1359 ],
1360 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1361 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1362 &quot;A String&quot;,
1363 ],
1364 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1365 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1366 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1367 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1368 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1369 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001370 &quot;A String&quot;,
1371 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001372 },
1373 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1374 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1375 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001376 &quot;A String&quot;,
1377 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001378 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001379 &quot;A String&quot;,
1380 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001381 },
1382 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1383 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1384 &quot;A String&quot;,
1385 ],
1386 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1387 &quot;A String&quot;,
1388 ],
1389 },
1390 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1391 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1392 &quot;values&quot;: [ # The values specified.
1393 &quot;A String&quot;,
1394 ],
1395 },
1396}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001397</div>
1398
1399<div class="method">
1400 <code class="details" id="removeTargetedPublishers">removeTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</code>
1401 <pre>Removes targeted publishers from the pretargeting config.
1402
1403Args:
1404 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
1405 body: object, The request body.
1406 The object takes the form of:
1407
1408{ # A request to stop targeting publishers in a specific configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001409 &quot;publisherIds&quot;: [ # A list of publisher IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
1410 &quot;A String&quot;,
1411 ],
1412}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001413
1414 x__xgafv: string, V1 error format.
1415 Allowed values
1416 1 - v1 error format
1417 2 - v2 error format
1418
1419Returns:
1420 An object of the form:
1421
1422 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001423 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1424 &quot;A String&quot;,
1425 ],
1426 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
1427 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1428 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1429 &quot;A String&quot;,
1430 ],
1431 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1432 &quot;A String&quot;,
1433 ],
1434 },
1435 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001436 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1437 &quot;values&quot;: [ # The values specified.
1438 &quot;A String&quot;,
1439 ],
1440 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001441 },
1442 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1443 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1444 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
1445 &quot;A String&quot;,
1446 ],
1447 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
1448 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001449 &quot;A String&quot;,
1450 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001451 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001452 &quot;A String&quot;,
1453 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001454 },
1455 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1456 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1457 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1458 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001459 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001460 ],
1461 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1462 &quot;A String&quot;,
1463 ],
1464 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1465 &quot;A String&quot;,
1466 ],
1467 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1468 &quot;A String&quot;,
1469 ],
1470 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1471 &quot;A String&quot;,
1472 ],
1473 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1474 &quot;A String&quot;,
1475 ],
1476 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1477 &quot;A String&quot;,
1478 ],
1479 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1480 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1481 &quot;A String&quot;,
1482 ],
1483 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1484 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1485 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1486 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1487 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1488 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001489 &quot;A String&quot;,
1490 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001491 },
1492 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1493 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1494 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001495 &quot;A String&quot;,
1496 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001497 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001498 &quot;A String&quot;,
1499 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001500 },
1501 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1502 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1503 &quot;A String&quot;,
1504 ],
1505 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1506 &quot;A String&quot;,
1507 ],
1508 },
1509 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1510 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1511 &quot;values&quot;: [ # The values specified.
1512 &quot;A String&quot;,
1513 ],
1514 },
1515}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001516</div>
1517
1518<div class="method">
1519 <code class="details" id="removeTargetedSites">removeTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</code>
1520 <pre>Removes targeted sites from the pretargeting configuration.
1521
1522Args:
1523 pretargetingConfig: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
1524 body: object, The request body.
1525 The object takes the form of:
1526
1527{ # A request to stop targeting sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001528 &quot;sites&quot;: [ # A list of site URLs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted URLs in PretargetingConfig.webTargeting.values.
1529 &quot;A String&quot;,
1530 ],
1531}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001532
1533 x__xgafv: string, V1 error format.
1534 Allowed values
1535 1 - v1 error format
1536 2 - v2 error format
1537
1538Returns:
1539 An object of the form:
1540
1541 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001542 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1543 &quot;A String&quot;,
1544 ],
1545 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
1546 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1547 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1548 &quot;A String&quot;,
1549 ],
1550 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1551 &quot;A String&quot;,
1552 ],
1553 },
1554 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001555 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1556 &quot;values&quot;: [ # The values specified.
1557 &quot;A String&quot;,
1558 ],
1559 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001560 },
1561 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1562 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1563 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
1564 &quot;A String&quot;,
1565 ],
1566 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
1567 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001568 &quot;A String&quot;,
1569 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001570 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001571 &quot;A String&quot;,
1572 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001573 },
1574 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1575 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1576 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1577 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001578 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001579 ],
1580 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1581 &quot;A String&quot;,
1582 ],
1583 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1584 &quot;A String&quot;,
1585 ],
1586 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1587 &quot;A String&quot;,
1588 ],
1589 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1590 &quot;A String&quot;,
1591 ],
1592 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1593 &quot;A String&quot;,
1594 ],
1595 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1596 &quot;A String&quot;,
1597 ],
1598 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1599 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1600 &quot;A String&quot;,
1601 ],
1602 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1603 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1604 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1605 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1606 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1607 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001608 &quot;A String&quot;,
1609 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001610 },
1611 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1612 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1613 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001614 &quot;A String&quot;,
1615 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001616 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001617 &quot;A String&quot;,
1618 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001619 },
1620 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1621 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1622 &quot;A String&quot;,
1623 ],
1624 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1625 &quot;A String&quot;,
1626 ],
1627 },
1628 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1629 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1630 &quot;values&quot;: [ # The values specified.
1631 &quot;A String&quot;,
1632 ],
1633 },
1634}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001635</div>
1636
1637<div class="method">
1638 <code class="details" id="suspend">suspend(name, body=None, x__xgafv=None)</code>
1639 <pre>Suspends a pretargeting configuration.
1640
1641Args:
1642 name: string, Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
1643 body: object, The request body.
1644 The object takes the form of:
1645
1646{ # A request to suspend a pretargeting configuration. Sets the configuration&#x27;s state to SUSPENDED.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001647}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001648
1649 x__xgafv: string, V1 error format.
1650 Allowed values
1651 1 - v1 error format
1652 2 - v2 error format
1653
1654Returns:
1655 An object of the form:
1656
1657 { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001658 &quot;allowedUserTargetingModes&quot;: [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
1659 &quot;A String&quot;,
1660 ],
1661 &quot;appTargeting&quot;: { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
1662 &quot;mobileAppCategoryTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
1663 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1664 &quot;A String&quot;,
1665 ],
1666 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1667 &quot;A String&quot;,
1668 ],
1669 },
1670 &quot;mobileAppTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001671 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1672 &quot;values&quot;: [ # The values specified.
1673 &quot;A String&quot;,
1674 ],
1675 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001676 },
1677 &quot;billingId&quot;: &quot;A String&quot;, # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
1678 &quot;displayName&quot;: &quot;A String&quot;, # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
1679 &quot;excludedContentLabelIds&quot;: [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
1680 &quot;A String&quot;,
1681 ],
1682 &quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
1683 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001684 &quot;A String&quot;,
1685 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001686 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001687 &quot;A String&quot;,
1688 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001689 },
1690 &quot;includedCreativeDimensions&quot;: [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
1691 { # The dimensions of a creative. This applies to only HTML and Native creatives.
1692 &quot;height&quot;: &quot;A String&quot;, # The height of the creative in pixels.
1693 &quot;width&quot;: &quot;A String&quot;, # The width of the creative in pixels.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001694 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001695 ],
1696 &quot;includedEnvironments&quot;: [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
1697 &quot;A String&quot;,
1698 ],
1699 &quot;includedFormats&quot;: [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
1700 &quot;A String&quot;,
1701 ],
1702 &quot;includedLanguages&quot;: [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
1703 &quot;A String&quot;,
1704 ],
1705 &quot;includedMobileOperatingSystemIds&quot;: [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
1706 &quot;A String&quot;,
1707 ],
1708 &quot;includedPlatforms&quot;: [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
1709 &quot;A String&quot;,
1710 ],
1711 &quot;includedUserIdTypes&quot;: [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
1712 &quot;A String&quot;,
1713 ],
1714 &quot;interstitialTargeting&quot;: &quot;A String&quot;, # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
1715 &quot;invalidGeoIds&quot;: [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
1716 &quot;A String&quot;,
1717 ],
1718 &quot;maximumQps&quot;: &quot;A String&quot;, # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
1719 &quot;minimumViewabilityDecile&quot;: 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values &gt; 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
1720 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
1721 &quot;publisherTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
1722 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1723 &quot;values&quot;: [ # The values specified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001724 &quot;A String&quot;,
1725 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001726 },
1727 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this pretargeting configuration.
1728 &quot;userListTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList.
1729 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001730 &quot;A String&quot;,
1731 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001732 &quot;includedIds&quot;: [ # The IDs included in a configuration.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -08001733 &quot;A String&quot;,
1734 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001735 },
1736 &quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
1737 &quot;excludedIds&quot;: [ # The IDs excluded in a configuration.
1738 &quot;A String&quot;,
1739 ],
1740 &quot;includedIds&quot;: [ # The IDs included in a configuration.
1741 &quot;A String&quot;,
1742 ],
1743 },
1744 &quot;webTargeting&quot;: { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
1745 &quot;targetingMode&quot;: &quot;A String&quot;, # How the items in this list should be targeted.
1746 &quot;values&quot;: [ # The values specified.
1747 &quot;A String&quot;,
1748 ],
1749 },
1750}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001751</div>
1752
1753</body></html>