1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="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"> 102 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 103<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's state to ACTIVE. 133} 134 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. 144 "allowedUserTargetingModes": [ # 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 "A String", 146 ], 147 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 150 "A String", 151 ], 152 "includedIds": [ # The IDs included in a configuration. 153 "A String", 154 ], 155 }, 156 "mobileAppTargeting": { # 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. 157 "targetingMode": "A String", # How the items in this list should be targeted. 158 "values": [ # The values specified. 159 "A String", 160 ], 161 }, 162 }, 163 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 165 "excludedContentLabelIds": [ # 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 "A String", 167 ], 168 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 170 "A String", 171 ], 172 "includedIds": [ # The IDs included in a configuration. 173 "A String", 174 ], 175 }, 176 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 179 "width": "A String", # The width of the creative in pixels. 180 }, 181 ], 182 "includedEnvironments": [ # 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 "A String", 184 ], 185 "includedFormats": [ # 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 "A String", 187 ], 188 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 189 "A String", 190 ], 191 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 192 "A String", 193 ], 194 "includedPlatforms": [ # 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 "A String", 196 ], 197 "includedUserIdTypes": [ # 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 "A String", 199 ], 200 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 202 "A String", 203 ], 204 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 207 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 209 "values": [ # The values specified. 210 "A String", 211 ], 212 }, 213 "state": "A String", # Output only. The state of this pretargeting configuration. 214 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 216 "A String", 217 ], 218 "includedIds": [ # The IDs included in a configuration. 219 "A String", 220 ], 221 }, 222 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 224 "A String", 225 ], 226 "includedIds": [ # The IDs included in a configuration. 227 "A String", 228 ], 229 }, 230 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 232 "values": [ # The values specified. 233 "A String", 234 ], 235 }, 236}</pre> 237</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. 249 "appIds": [ # 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 "A String", 251 ], 252 "targetingMode": "A String", # 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} 254 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. 264 "allowedUserTargetingModes": [ # 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 "A String", 266 ], 267 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 270 "A String", 271 ], 272 "includedIds": [ # The IDs included in a configuration. 273 "A String", 274 ], 275 }, 276 "mobileAppTargeting": { # 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. 277 "targetingMode": "A String", # How the items in this list should be targeted. 278 "values": [ # The values specified. 279 "A String", 280 ], 281 }, 282 }, 283 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 285 "excludedContentLabelIds": [ # 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 "A String", 287 ], 288 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 290 "A String", 291 ], 292 "includedIds": [ # The IDs included in a configuration. 293 "A String", 294 ], 295 }, 296 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 299 "width": "A String", # The width of the creative in pixels. 300 }, 301 ], 302 "includedEnvironments": [ # 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 "A String", 304 ], 305 "includedFormats": [ # 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 "A String", 307 ], 308 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 309 "A String", 310 ], 311 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 312 "A String", 313 ], 314 "includedPlatforms": [ # 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 "A String", 316 ], 317 "includedUserIdTypes": [ # 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 "A String", 319 ], 320 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 322 "A String", 323 ], 324 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 327 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 329 "values": [ # The values specified. 330 "A String", 331 ], 332 }, 333 "state": "A String", # Output only. The state of this pretargeting configuration. 334 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 336 "A String", 337 ], 338 "includedIds": [ # The IDs included in a configuration. 339 "A String", 340 ], 341 }, 342 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 344 "A String", 345 ], 346 "includedIds": [ # The IDs included in a configuration. 347 "A String", 348 ], 349 }, 350 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 352 "values": [ # The values specified. 353 "A String", 354 ], 355 }, 356}</pre> 357</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. 369 "publisherIds": [ # 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 "A String", 371 ], 372 "targetingMode": "A String", # 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} 374 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. 384 "allowedUserTargetingModes": [ # 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 "A String", 386 ], 387 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 390 "A String", 391 ], 392 "includedIds": [ # The IDs included in a configuration. 393 "A String", 394 ], 395 }, 396 "mobileAppTargeting": { # 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. 397 "targetingMode": "A String", # How the items in this list should be targeted. 398 "values": [ # The values specified. 399 "A String", 400 ], 401 }, 402 }, 403 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 405 "excludedContentLabelIds": [ # 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 "A String", 407 ], 408 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 410 "A String", 411 ], 412 "includedIds": [ # The IDs included in a configuration. 413 "A String", 414 ], 415 }, 416 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 419 "width": "A String", # The width of the creative in pixels. 420 }, 421 ], 422 "includedEnvironments": [ # 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 "A String", 424 ], 425 "includedFormats": [ # 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 "A String", 427 ], 428 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 429 "A String", 430 ], 431 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 432 "A String", 433 ], 434 "includedPlatforms": [ # 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 "A String", 436 ], 437 "includedUserIdTypes": [ # 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 "A String", 439 ], 440 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 442 "A String", 443 ], 444 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 447 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 449 "values": [ # The values specified. 450 "A String", 451 ], 452 }, 453 "state": "A String", # Output only. The state of this pretargeting configuration. 454 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 456 "A String", 457 ], 458 "includedIds": [ # The IDs included in a configuration. 459 "A String", 460 ], 461 }, 462 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 464 "A String", 465 ], 466 "includedIds": [ # The IDs included in a configuration. 467 "A String", 468 ], 469 }, 470 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 472 "values": [ # The values specified. 473 "A String", 474 ], 475 }, 476}</pre> 477</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. 489 "sites": [ # 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 "A String", 491 ], 492 "targetingMode": "A String", # 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} 494 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. 504 "allowedUserTargetingModes": [ # 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 "A String", 506 ], 507 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 510 "A String", 511 ], 512 "includedIds": [ # The IDs included in a configuration. 513 "A String", 514 ], 515 }, 516 "mobileAppTargeting": { # 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. 517 "targetingMode": "A String", # How the items in this list should be targeted. 518 "values": [ # The values specified. 519 "A String", 520 ], 521 }, 522 }, 523 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 525 "excludedContentLabelIds": [ # 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 "A String", 527 ], 528 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 530 "A String", 531 ], 532 "includedIds": [ # The IDs included in a configuration. 533 "A String", 534 ], 535 }, 536 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 539 "width": "A String", # The width of the creative in pixels. 540 }, 541 ], 542 "includedEnvironments": [ # 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 "A String", 544 ], 545 "includedFormats": [ # 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 "A String", 547 ], 548 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 549 "A String", 550 ], 551 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 552 "A String", 553 ], 554 "includedPlatforms": [ # 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 "A String", 556 ], 557 "includedUserIdTypes": [ # 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 "A String", 559 ], 560 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 562 "A String", 563 ], 564 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 567 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 569 "values": [ # The values specified. 570 "A String", 571 ], 572 }, 573 "state": "A String", # Output only. The state of this pretargeting configuration. 574 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 576 "A String", 577 ], 578 "includedIds": [ # The IDs included in a configuration. 579 "A String", 580 ], 581 }, 582 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 584 "A String", 585 ], 586 "includedIds": [ # The IDs included in a configuration. 587 "A String", 588 ], 589 }, 590 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 592 "values": [ # The values specified. 593 "A String", 594 ], 595 }, 596}</pre> 597</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'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. 614 "allowedUserTargetingModes": [ # 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 "A String", 616 ], 617 "appTargeting": { # 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). 618 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 620 "A String", 621 ], 622 "includedIds": [ # The IDs included in a configuration. 623 "A String", 624 ], 625 }, 626 "mobileAppTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 628 "values": [ # The values specified. 629 "A String", 630 ], 631 }, 632 }, 633 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 635 "excludedContentLabelIds": [ # 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. 636 "A String", 637 ], 638 "geoTargeting": { # 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 639 "excludedIds": [ # The IDs excluded in a configuration. 640 "A String", 641 ], 642 "includedIds": [ # The IDs included in a configuration. 643 "A String", 644 ], 645 }, 646 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 649 "width": "A String", # The width of the creative in pixels. 650 }, 651 ], 652 "includedEnvironments": [ # 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 "A String", 654 ], 655 "includedFormats": [ # 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 "A String", 657 ], 658 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 659 "A String", 660 ], 661 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 662 "A String", 663 ], 664 "includedPlatforms": [ # 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 "A String", 666 ], 667 "includedUserIdTypes": [ # 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 "A String", 669 ], 670 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 672 "A String", 673 ], 674 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 677 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 679 "values": [ # The values specified. 680 "A String", 681 ], 682 }, 683 "state": "A String", # Output only. The state of this pretargeting configuration. 684 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 686 "A String", 687 ], 688 "includedIds": [ # The IDs included in a configuration. 689 "A String", 690 ], 691 }, 692 "verticalTargeting": { # 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 693 "excludedIds": [ # The IDs excluded in a configuration. 694 "A String", 695 ], 696 "includedIds": [ # The IDs included in a configuration. 697 "A String", 698 ], 699 }, 700 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 702 "values": [ # The values specified. 703 "A String", 704 ], 705 }, 706} 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. 717 "allowedUserTargetingModes": [ # 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 "A String", 719 ], 720 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 723 "A String", 724 ], 725 "includedIds": [ # The IDs included in a configuration. 726 "A String", 727 ], 728 }, 729 "mobileAppTargeting": { # 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. 730 "targetingMode": "A String", # How the items in this list should be targeted. 731 "values": [ # The values specified. 732 "A String", 733 ], 734 }, 735 }, 736 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 738 "excludedContentLabelIds": [ # 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 "A String", 740 ], 741 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 743 "A String", 744 ], 745 "includedIds": [ # The IDs included in a configuration. 746 "A String", 747 ], 748 }, 749 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 752 "width": "A String", # The width of the creative in pixels. 753 }, 754 ], 755 "includedEnvironments": [ # 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 "A String", 757 ], 758 "includedFormats": [ # 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 "A String", 760 ], 761 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 762 "A String", 763 ], 764 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 765 "A String", 766 ], 767 "includedPlatforms": [ # 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 "A String", 769 ], 770 "includedUserIdTypes": [ # 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 "A String", 772 ], 773 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 775 "A String", 776 ], 777 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 780 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 782 "values": [ # The values specified. 783 "A String", 784 ], 785 }, 786 "state": "A String", # Output only. The state of this pretargeting configuration. 787 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 789 "A String", 790 ], 791 "includedIds": [ # The IDs included in a configuration. 792 "A String", 793 ], 794 }, 795 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 797 "A String", 798 ], 799 "includedIds": [ # The IDs included in a configuration. 800 "A String", 801 ], 802 }, 803 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 805 "values": [ # The values specified. 806 "A String", 807 ], 808 }, 809}</pre> 810</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 `{}`. 827}</pre> 828</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. 845 "allowedUserTargetingModes": [ # 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 "A String", 847 ], 848 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 851 "A String", 852 ], 853 "includedIds": [ # The IDs included in a configuration. 854 "A String", 855 ], 856 }, 857 "mobileAppTargeting": { # 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. 858 "targetingMode": "A String", # How the items in this list should be targeted. 859 "values": [ # The values specified. 860 "A String", 861 ], 862 }, 863 }, 864 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 866 "excludedContentLabelIds": [ # 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 "A String", 868 ], 869 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 871 "A String", 872 ], 873 "includedIds": [ # The IDs included in a configuration. 874 "A String", 875 ], 876 }, 877 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 880 "width": "A String", # The width of the creative in pixels. 881 }, 882 ], 883 "includedEnvironments": [ # 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 "A String", 885 ], 886 "includedFormats": [ # 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 "A String", 888 ], 889 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 890 "A String", 891 ], 892 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 893 "A String", 894 ], 895 "includedPlatforms": [ # 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 "A String", 897 ], 898 "includedUserIdTypes": [ # 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 "A String", 900 ], 901 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 903 "A String", 904 ], 905 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 908 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 910 "values": [ # The values specified. 911 "A String", 912 ], 913 }, 914 "state": "A String", # Output only. The state of this pretargeting configuration. 915 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 917 "A String", 918 ], 919 "includedIds": [ # The IDs included in a configuration. 920 "A String", 921 ], 922 }, 923 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 925 "A String", 926 ], 927 "includedIds": [ # The IDs included in a configuration. 928 "A String", 929 ], 930 }, 931 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 933 "values": [ # The values specified. 934 "A String", 935 ], 936 }, 937}</pre> 938</div> 939 940<div class="method"> 941 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 942 <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) 946 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. 947 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. 948 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. 957 "nextPageToken": "A String", # 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 "pretargetingConfigs": [ # 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 "allowedUserTargetingModes": [ # 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 "A String", 962 ], 963 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 966 "A String", 967 ], 968 "includedIds": [ # The IDs included in a configuration. 969 "A String", 970 ], 971 }, 972 "mobileAppTargeting": { # 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. 973 "targetingMode": "A String", # How the items in this list should be targeted. 974 "values": [ # The values specified. 975 "A String", 976 ], 977 }, 978 }, 979 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 981 "excludedContentLabelIds": [ # 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 "A String", 983 ], 984 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 986 "A String", 987 ], 988 "includedIds": [ # The IDs included in a configuration. 989 "A String", 990 ], 991 }, 992 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 995 "width": "A String", # The width of the creative in pixels. 996 }, 997 ], 998 "includedEnvironments": [ # 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 "A String", 1000 ], 1001 "includedFormats": [ # 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 "A String", 1003 ], 1004 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1005 "A String", 1006 ], 1007 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1008 "A String", 1009 ], 1010 "includedPlatforms": [ # 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 "A String", 1012 ], 1013 "includedUserIdTypes": [ # 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 "A String", 1015 ], 1016 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1018 "A String", 1019 ], 1020 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1023 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1025 "values": [ # The values specified. 1026 "A String", 1027 ], 1028 }, 1029 "state": "A String", # Output only. The state of this pretargeting configuration. 1030 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1032 "A String", 1033 ], 1034 "includedIds": [ # The IDs included in a configuration. 1035 "A String", 1036 ], 1037 }, 1038 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1040 "A String", 1041 ], 1042 "includedIds": [ # The IDs included in a configuration. 1043 "A String", 1044 ], 1045 }, 1046 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1048 "values": [ # The values specified. 1049 "A String", 1050 ], 1051 }, 1052 }, 1053 ], 1054}</pre> 1055</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 'execute()' 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. 1081 "allowedUserTargetingModes": [ # 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 "A String", 1083 ], 1084 "appTargeting": { # 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). 1085 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1087 "A String", 1088 ], 1089 "includedIds": [ # The IDs included in a configuration. 1090 "A String", 1091 ], 1092 }, 1093 "mobileAppTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1095 "values": [ # The values specified. 1096 "A String", 1097 ], 1098 }, 1099 }, 1100 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1102 "excludedContentLabelIds": [ # 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. 1103 "A String", 1104 ], 1105 "geoTargeting": { # 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 1106 "excludedIds": [ # The IDs excluded in a configuration. 1107 "A String", 1108 ], 1109 "includedIds": [ # The IDs included in a configuration. 1110 "A String", 1111 ], 1112 }, 1113 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1116 "width": "A String", # The width of the creative in pixels. 1117 }, 1118 ], 1119 "includedEnvironments": [ # 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 "A String", 1121 ], 1122 "includedFormats": [ # 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 "A String", 1124 ], 1125 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1126 "A String", 1127 ], 1128 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1129 "A String", 1130 ], 1131 "includedPlatforms": [ # 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 "A String", 1133 ], 1134 "includedUserIdTypes": [ # 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 "A String", 1136 ], 1137 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1139 "A String", 1140 ], 1141 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1144 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1146 "values": [ # The values specified. 1147 "A String", 1148 ], 1149 }, 1150 "state": "A String", # Output only. The state of this pretargeting configuration. 1151 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1153 "A String", 1154 ], 1155 "includedIds": [ # The IDs included in a configuration. 1156 "A String", 1157 ], 1158 }, 1159 "verticalTargeting": { # 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 1160 "excludedIds": [ # The IDs excluded in a configuration. 1161 "A String", 1162 ], 1163 "includedIds": [ # The IDs included in a configuration. 1164 "A String", 1165 ], 1166 }, 1167 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1169 "values": [ # The values specified. 1170 "A String", 1171 ], 1172 }, 1173} 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. 1185 "allowedUserTargetingModes": [ # 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 "A String", 1187 ], 1188 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1191 "A String", 1192 ], 1193 "includedIds": [ # The IDs included in a configuration. 1194 "A String", 1195 ], 1196 }, 1197 "mobileAppTargeting": { # 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. 1198 "targetingMode": "A String", # How the items in this list should be targeted. 1199 "values": [ # The values specified. 1200 "A String", 1201 ], 1202 }, 1203 }, 1204 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1206 "excludedContentLabelIds": [ # 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 "A String", 1208 ], 1209 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1211 "A String", 1212 ], 1213 "includedIds": [ # The IDs included in a configuration. 1214 "A String", 1215 ], 1216 }, 1217 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1220 "width": "A String", # The width of the creative in pixels. 1221 }, 1222 ], 1223 "includedEnvironments": [ # 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 "A String", 1225 ], 1226 "includedFormats": [ # 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 "A String", 1228 ], 1229 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1230 "A String", 1231 ], 1232 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1233 "A String", 1234 ], 1235 "includedPlatforms": [ # 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 "A String", 1237 ], 1238 "includedUserIdTypes": [ # 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 "A String", 1240 ], 1241 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1243 "A String", 1244 ], 1245 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1248 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1250 "values": [ # The values specified. 1251 "A String", 1252 ], 1253 }, 1254 "state": "A String", # Output only. The state of this pretargeting configuration. 1255 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1257 "A String", 1258 ], 1259 "includedIds": [ # The IDs included in a configuration. 1260 "A String", 1261 ], 1262 }, 1263 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1265 "A String", 1266 ], 1267 "includedIds": [ # The IDs included in a configuration. 1268 "A String", 1269 ], 1270 }, 1271 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1273 "values": [ # The values specified. 1274 "A String", 1275 ], 1276 }, 1277}</pre> 1278</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. 1290 "appIds": [ # 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 "A String", 1292 ], 1293} 1294 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. 1304 "allowedUserTargetingModes": [ # 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 "A String", 1306 ], 1307 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1310 "A String", 1311 ], 1312 "includedIds": [ # The IDs included in a configuration. 1313 "A String", 1314 ], 1315 }, 1316 "mobileAppTargeting": { # 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. 1317 "targetingMode": "A String", # How the items in this list should be targeted. 1318 "values": [ # The values specified. 1319 "A String", 1320 ], 1321 }, 1322 }, 1323 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1325 "excludedContentLabelIds": [ # 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 "A String", 1327 ], 1328 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1330 "A String", 1331 ], 1332 "includedIds": [ # The IDs included in a configuration. 1333 "A String", 1334 ], 1335 }, 1336 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1339 "width": "A String", # The width of the creative in pixels. 1340 }, 1341 ], 1342 "includedEnvironments": [ # 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 "A String", 1344 ], 1345 "includedFormats": [ # 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 "A String", 1347 ], 1348 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1349 "A String", 1350 ], 1351 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1352 "A String", 1353 ], 1354 "includedPlatforms": [ # 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 "A String", 1356 ], 1357 "includedUserIdTypes": [ # 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 "A String", 1359 ], 1360 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1362 "A String", 1363 ], 1364 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1367 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1369 "values": [ # The values specified. 1370 "A String", 1371 ], 1372 }, 1373 "state": "A String", # Output only. The state of this pretargeting configuration. 1374 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1376 "A String", 1377 ], 1378 "includedIds": [ # The IDs included in a configuration. 1379 "A String", 1380 ], 1381 }, 1382 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1384 "A String", 1385 ], 1386 "includedIds": [ # The IDs included in a configuration. 1387 "A String", 1388 ], 1389 }, 1390 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1392 "values": [ # The values specified. 1393 "A String", 1394 ], 1395 }, 1396}</pre> 1397</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. 1409 "publisherIds": [ # 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 "A String", 1411 ], 1412} 1413 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. 1423 "allowedUserTargetingModes": [ # 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 "A String", 1425 ], 1426 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1429 "A String", 1430 ], 1431 "includedIds": [ # The IDs included in a configuration. 1432 "A String", 1433 ], 1434 }, 1435 "mobileAppTargeting": { # 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. 1436 "targetingMode": "A String", # How the items in this list should be targeted. 1437 "values": [ # The values specified. 1438 "A String", 1439 ], 1440 }, 1441 }, 1442 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1444 "excludedContentLabelIds": [ # 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 "A String", 1446 ], 1447 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1449 "A String", 1450 ], 1451 "includedIds": [ # The IDs included in a configuration. 1452 "A String", 1453 ], 1454 }, 1455 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1458 "width": "A String", # The width of the creative in pixels. 1459 }, 1460 ], 1461 "includedEnvironments": [ # 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 "A String", 1463 ], 1464 "includedFormats": [ # 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 "A String", 1466 ], 1467 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1468 "A String", 1469 ], 1470 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1471 "A String", 1472 ], 1473 "includedPlatforms": [ # 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 "A String", 1475 ], 1476 "includedUserIdTypes": [ # 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 "A String", 1478 ], 1479 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1481 "A String", 1482 ], 1483 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1486 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1488 "values": [ # The values specified. 1489 "A String", 1490 ], 1491 }, 1492 "state": "A String", # Output only. The state of this pretargeting configuration. 1493 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1495 "A String", 1496 ], 1497 "includedIds": [ # The IDs included in a configuration. 1498 "A String", 1499 ], 1500 }, 1501 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1503 "A String", 1504 ], 1505 "includedIds": [ # The IDs included in a configuration. 1506 "A String", 1507 ], 1508 }, 1509 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1511 "values": [ # The values specified. 1512 "A String", 1513 ], 1514 }, 1515}</pre> 1516</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. 1528 "sites": [ # 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 "A String", 1530 ], 1531} 1532 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. 1542 "allowedUserTargetingModes": [ # 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 "A String", 1544 ], 1545 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1548 "A String", 1549 ], 1550 "includedIds": [ # The IDs included in a configuration. 1551 "A String", 1552 ], 1553 }, 1554 "mobileAppTargeting": { # 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. 1555 "targetingMode": "A String", # How the items in this list should be targeted. 1556 "values": [ # The values specified. 1557 "A String", 1558 ], 1559 }, 1560 }, 1561 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1563 "excludedContentLabelIds": [ # 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 "A String", 1565 ], 1566 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1568 "A String", 1569 ], 1570 "includedIds": [ # The IDs included in a configuration. 1571 "A String", 1572 ], 1573 }, 1574 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1577 "width": "A String", # The width of the creative in pixels. 1578 }, 1579 ], 1580 "includedEnvironments": [ # 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 "A String", 1582 ], 1583 "includedFormats": [ # 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 "A String", 1585 ], 1586 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1587 "A String", 1588 ], 1589 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1590 "A String", 1591 ], 1592 "includedPlatforms": [ # 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 "A String", 1594 ], 1595 "includedUserIdTypes": [ # 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 "A String", 1597 ], 1598 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1600 "A String", 1601 ], 1602 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1605 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1607 "values": [ # The values specified. 1608 "A String", 1609 ], 1610 }, 1611 "state": "A String", # Output only. The state of this pretargeting configuration. 1612 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1614 "A String", 1615 ], 1616 "includedIds": [ # The IDs included in a configuration. 1617 "A String", 1618 ], 1619 }, 1620 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1622 "A String", 1623 ], 1624 "includedIds": [ # The IDs included in a configuration. 1625 "A String", 1626 ], 1627 }, 1628 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1630 "values": [ # The values specified. 1631 "A String", 1632 ], 1633 }, 1634}</pre> 1635</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's state to SUSPENDED. 1647} 1648 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. 1658 "allowedUserTargetingModes": [ # 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 "A String", 1660 ], 1661 "appTargeting": { # 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 "mobileAppCategoryTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1664 "A String", 1665 ], 1666 "includedIds": [ # The IDs included in a configuration. 1667 "A String", 1668 ], 1669 }, 1670 "mobileAppTargeting": { # 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. 1671 "targetingMode": "A String", # How the items in this list should be targeted. 1672 "values": [ # The values specified. 1673 "A String", 1674 ], 1675 }, 1676 }, 1677 "billingId": "A String", # 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 "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. 1679 "excludedContentLabelIds": [ # 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 "A String", 1681 ], 1682 "geoTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1684 "A String", 1685 ], 1686 "includedIds": [ # The IDs included in a configuration. 1687 "A String", 1688 ], 1689 }, 1690 "includedCreativeDimensions": [ # 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 "height": "A String", # The height of the creative in pixels. 1693 "width": "A String", # The width of the creative in pixels. 1694 }, 1695 ], 1696 "includedEnvironments": [ # 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 "A String", 1698 ], 1699 "includedFormats": [ # 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 "A String", 1701 ], 1702 "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1703 "A String", 1704 ], 1705 "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv 1706 "A String", 1707 ], 1708 "includedPlatforms": [ # 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 "A String", 1710 ], 1711 "includedUserIdTypes": [ # 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 "A String", 1713 ], 1714 "interstitialTargeting": "A String", # 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 "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. 1716 "A String", 1717 ], 1718 "maximumQps": "A String", # 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 "minimumViewabilityDecile": 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 > 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 "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` 1721 "publisherTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1723 "values": [ # The values specified. 1724 "A String", 1725 ], 1726 }, 1727 "state": "A String", # Output only. The state of this pretargeting configuration. 1728 "userListTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1730 "A String", 1731 ], 1732 "includedIds": [ # The IDs included in a configuration. 1733 "A String", 1734 ], 1735 }, 1736 "verticalTargeting": { # 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 "excludedIds": [ # The IDs excluded in a configuration. 1738 "A String", 1739 ], 1740 "includedIds": [ # The IDs included in a configuration. 1741 "A String", 1742 ], 1743 }, 1744 "webTargeting": { # 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 "targetingMode": "A String", # How the items in this list should be targeted. 1746 "values": [ # The values specified. 1747 "A String", 1748 ], 1749 }, 1750}</pre> 1751</div> 1752 1753</body></html>