Blame - docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html - platform/external/python/google-api-python-client

<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

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

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

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

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

90

<code><a href="#close">close()</a></code></p>

91

<p class="firstline">Close httplib2 connections.</p>

92

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

96

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

97

<p class="firstline">Deletes a pretargeting configuration.</p>

98

99

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

100

<p class="firstline">Gets a pretargeting configuration.</p>

101

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

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

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

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

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

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

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

124

<code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>

125

<pre>Activates a pretargeting configuration.

126

127

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

145

"values": [ # The values specified.

146

"A String",

147

],

148

"targetingMode": "A String", # How the items in this list should be targeted.

149

},

150

"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

151

"includedIds": [ # The IDs included in a configuration.

152

"A String",

153

],

154

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

159

"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.

160

"A String",

161

],

162

"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.

163

"A String",

164

],

165

"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.

166

"A String",

167

],

168

"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.

169

"A String",

170

],

171

"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

172

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

173

"A String",

174

],

175

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

176

"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

177

"includedIds": [ # The IDs included in a configuration.

178

"A String",

179

],

180

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

185

"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.

186

"includedIds": [ # The IDs included in a configuration.

187

"A String",

188

],

189

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

194

"values": [ # The values specified.

195

"A String",

196

],

197

"targetingMode": "A String", # How the items in this list should be targeted.

198

},

199

"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.

200

"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.

201

"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).

202

"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.

203

"includedIds": [ # The IDs included in a configuration.

204

"A String",

205

],

206

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

211

"values": [ # The values specified.

212

"A String",

213

],

214

"targetingMode": "A String", # How the items in this list should be targeted.

215

},

216

},

217

"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.

218

"A String",

219

],

220

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

221

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

222

"A String",

223

],

224

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

225

"A String",

226

],

227

"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.

228

"A String",

229

],

230

"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.

231

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

232

"width": "A String", # The width of the creative in pixels.

233

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="addTargetedApps">addTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</code>

241

<pre>Adds targeted apps to the pretargeting configuration.

242

243

Args:

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

"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.

250

"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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

265

"values": [ # The values specified.

266

"A String",

267

],

268

"targetingMode": "A String", # How the items in this list should be targeted.

269

},

270

"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

271

"includedIds": [ # The IDs included in a configuration.

272

"A String",

273

],

274

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

279

"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.

280

"A String",

281

],

282

"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.

283

"A String",

284

],

285

"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.

286

"A String",

287

],

288

"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.

289

"A String",

290

],

291

"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

292

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

293

"A String",

294

],

295

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

296

"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

297

"includedIds": [ # The IDs included in a configuration.

298

"A String",

299

],

300

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

305

"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.

306

"includedIds": [ # The IDs included in a configuration.

307

"A String",

308

],

309

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

314

"values": [ # The values specified.

315

"A String",

316

],

317

"targetingMode": "A String", # How the items in this list should be targeted.

318

},

319

"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.

320

"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.

321

"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).

322

"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.

323

"includedIds": [ # The IDs included in a configuration.

324

"A String",

325

],

326

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

331

"values": [ # The values specified.

332

"A String",

333

],

334

"targetingMode": "A String", # How the items in this list should be targeted.

335

},

336

},

337

"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.

338

"A String",

339

],

340

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

341

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

342

"A String",

343

],

344

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

345

"A String",

346

],

347

"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.

348

"A String",

349

],

350

"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.

351

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

352

"width": "A String", # The width of the creative in pixels.

353

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="addTargetedPublishers">addTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</code>

361

<pre>Adds targeted publishers to the pretargeting config.

362

363

Args:

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

"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.

370

"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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

385

"values": [ # The values specified.

386

"A String",

387

],

388

"targetingMode": "A String", # How the items in this list should be targeted.

389

},

390

"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

391

"includedIds": [ # The IDs included in a configuration.

392

"A String",

393

],

394

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

399

"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.

400

"A String",

401

],

402

"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.

403

"A String",

404

],

405

"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.

406

"A String",

407

],

408

"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.

409

"A String",

410

],

411

"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

412

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

413

"A String",

414

],

415

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

416

"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

417

"includedIds": [ # The IDs included in a configuration.

418

"A String",

419

],

420

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

425

"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.

426

"includedIds": [ # The IDs included in a configuration.

427

"A String",

428

],

429

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

434

"values": [ # The values specified.

435

"A String",

436

],

437

"targetingMode": "A String", # How the items in this list should be targeted.

438

},

439

"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.

440

"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.

441

"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).

442

"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.

443

"includedIds": [ # The IDs included in a configuration.

444

"A String",

445

],

446

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

451

"values": [ # The values specified.

452

"A String",

453

],

454

"targetingMode": "A String", # How the items in this list should be targeted.

455

},

456

},

457

"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.

458

"A String",

459

],

460

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

461

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

462

"A String",

463

],

464

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

465

"A String",

466

],

467

"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.

468

"A String",

469

],

470

"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.

471

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

472

"width": "A String", # The width of the creative in pixels.

473

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="addTargetedSites">addTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</code>

481

<pre>Adds targeted sites to the pretargeting configuration.

482

483

Args:

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

"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.

490

"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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

505

"values": [ # The values specified.

506

"A String",

507

],

508

"targetingMode": "A String", # How the items in this list should be targeted.

509

},

510

"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

511

"includedIds": [ # The IDs included in a configuration.

512

"A String",

513

],

514

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

519

"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.

520

"A String",

521

],

522

"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.

523

"A String",

524

],

525

"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.

526

"A String",

527

],

528

"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.

529

"A String",

530

],

531

"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

532

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

533

"A String",

534

],

535

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

536

"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

537

"includedIds": [ # The IDs included in a configuration.

538

"A String",

539

],

540

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

545

"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.

546

"includedIds": [ # The IDs included in a configuration.

547

"A String",

548

],

549

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

554

"values": [ # The values specified.

555

"A String",

556

],

557

"targetingMode": "A String", # How the items in this list should be targeted.

558

},

559

"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.

560

"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.

561

"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).

562

"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.

563

"includedIds": [ # The IDs included in a configuration.

564

"A String",

565

],

566

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

571

"values": [ # The values specified.

572

"A String",

573

],

574

"targetingMode": "A String", # How the items in this list should be targeted.

575

},

576

},

577

"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.

578

"A String",

579

],

580

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

581

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

582

"A String",

583

],

584

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

585

"A String",

586

],

587

"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.

588

"A String",

589

],

590

"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.

591

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

592

"width": "A String", # The width of the creative in pixels.

593

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="close">close()</code>

601

<pre>Close httplib2 connections.</pre>

</div>

<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

608

Args:

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

"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).

615

"values": [ # The values specified.

616

"A String",

617

],

618

"targetingMode": "A String", # How the items in this list should be targeted.

619

},

620

"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

621

"includedIds": [ # The IDs included in a configuration.

622

"A String",

623

],

624

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

629

"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.

630

"A String",

631

],

632

"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.

633

"A String",

634

],

635

"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.

636

"A String",

637

],

638

"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.

639

"A String",

640

],

641

"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

642

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

643

"A String",

644

],

645

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

646

"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

647

"includedIds": [ # The IDs included in a configuration.

648

"A String",

649

],

650

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

655

"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.

656

"includedIds": [ # The IDs included in a configuration.

657

"A String",

658

],

659

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

664

"values": [ # The values specified.

665

"A String",

666

],

667

"targetingMode": "A String", # How the items in this list should be targeted.

668

},

669

"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.

670

"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.

671

"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).

672

"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.

673

"includedIds": [ # The IDs included in a configuration.

674

"A String",

675

],

676

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

681

"values": [ # The values specified.

682

"A String",

683

],

684

"targetingMode": "A String", # How the items in this list should be targeted.

685

},

686

},

687

"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.

688

"A String",

689

],

690

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

691

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

692

"A String",

693

],

694

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

695

"A String",

696

],

697

"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.

698

"A String",

699

],

700

"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.

701

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

702

"width": "A String", # The width of the creative in pixels.

703

"height": "A String", # The height of the creative in pixels.

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

718

"values": [ # The values specified.

719

"A String",

720

],

721

"targetingMode": "A String", # How the items in this list should be targeted.

722

},

723

"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

724

"includedIds": [ # The IDs included in a configuration.

725

"A String",

726

],

727

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

732

"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.

733

"A String",

734

],

735

"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.

736

"A String",

737

],

738

"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.

739

"A String",

740

],

741

"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.

742

"A String",

743

],

744

"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

745

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

746

"A String",

747

],

748

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

749

"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

750

"includedIds": [ # The IDs included in a configuration.

751

"A String",

752

],

753

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

758

"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.

759

"includedIds": [ # The IDs included in a configuration.

760

"A String",

761

],

762

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

767

"values": [ # The values specified.

768

"A String",

769

],

770

"targetingMode": "A String", # How the items in this list should be targeted.

771

},

772

"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.

773

"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.

774

"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).

775

"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.

776

"includedIds": [ # The IDs included in a configuration.

777

"A String",

778

],

779

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

784

"values": [ # The values specified.

785

"A String",

786

],

787

"targetingMode": "A String", # How the items in this list should be targeted.

788

},

789

},

790

"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.

791

"A String",

792

],

793

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

794

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

795

"A String",

796

],

797

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

798

"A String",

799

],

800

"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.

801

"A String",

802

],

803

"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.

804

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

805

"width": "A String", # The width of the creative in pixels.

806

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

814

<pre>Deletes a pretargeting configuration.

815

816

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

832

<pre>Gets a pretargeting configuration.

833

834

Args:

835

name: string, Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)

836

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

846

"values": [ # The values specified.

847

"A String",

848

],

849

"targetingMode": "A String", # How the items in this list should be targeted.

850

},

851

"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

852

"includedIds": [ # The IDs included in a configuration.

853

"A String",

854

],

855

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

860

"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.

861

"A String",

862

],

863

"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.

864

"A String",

865

],

866

"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.

867

"A String",

868

],

869

"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.

870

"A String",

871

],

872

"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

873

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

874

"A String",

875

],

876

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

877

"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

878

"includedIds": [ # The IDs included in a configuration.

879

"A String",

880

],

881

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

886

"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.

887

"includedIds": [ # The IDs included in a configuration.

888

"A String",

889

],

890

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

895

"values": [ # The values specified.

896

"A String",

897

],

898

"targetingMode": "A String", # How the items in this list should be targeted.

899

},

900

"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.

901

"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.

902

"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).

903

"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.

904

"includedIds": [ # The IDs included in a configuration.

905

"A String",

906

],

907

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

912

"values": [ # The values specified.

913

"A String",

914

],

915

"targetingMode": "A String", # How the items in this list should be targeted.

916

},

917

},

918

"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.

919

"A String",

920

],

921

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

922

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

923

"A String",

924

],

925

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

926

"A String",

927

],

928

"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.

929

"A String",

930

],

931

"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.

932

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

933

"width": "A String", # The width of the creative in pixels.

934

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<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

944

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

955

956

{ # A response containing pretargeting configurations.

957

"pretargetingConfigs": [ # List of pretargeting configurations.

958

{ # 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.

959

"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).

960

"values": [ # The values specified.

961

"A String",

962

],

963

"targetingMode": "A String", # How the items in this list should be targeted.

964

},

965

"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

966

"includedIds": [ # The IDs included in a configuration.

967

"A String",

968

],

969

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

974

"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.

975

"A String",

976

],

977

"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.

978

"A String",

979

],

980

"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.

981

"A String",

982

],

983

"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.

984

"A String",

985

],

986

"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

987

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

988

"A String",

989

],

990

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

991

"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

992

"includedIds": [ # The IDs included in a configuration.

993

"A String",

994

],

995

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1000

"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.

1001

"includedIds": [ # The IDs included in a configuration.

1002

"A String",

1003

],

1004

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1009

"values": [ # The values specified.

1010

"A String",

1011

],

1012

"targetingMode": "A String", # How the items in this list should be targeted.

1013

},

1014

"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.

1015

"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.

1016

"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).

1017

"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.

1018

"includedIds": [ # The IDs included in a configuration.

1019

"A String",

1020

],

1021

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1026

"values": [ # The values specified.

1027

"A String",

1028

],

1029

"targetingMode": "A String", # How the items in this list should be targeted.

1030

},

1031

},

1032

"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.

1033

"A String",

1034

],

1035

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1036

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1037

"A String",

1038

],

1039

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1040

"A String",

1041

],

1042

"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.

1043

"A String",

1044

],

1045

"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.

1046

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1047

"width": "A String", # The width of the creative in pixels.

1048

"height": "A String", # The height of the creative in pixels.

},

],

},

],

"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.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1059

<pre>Retrieves the next page of results.

1060

1061

Args:

1062

previous_request: The request for the previous page. (required)

1063

previous_response: The response from the request for the previous page. (required)

1064

1065

Returns:

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.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

1073

<pre>Updates a pretargeting configuration.

1074

1075

Args:

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

"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).

1082

"values": [ # The values specified.

1083

"A String",

1084

],

1085

"targetingMode": "A String", # How the items in this list should be targeted.

1086

},

1087

"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

1088

"includedIds": [ # The IDs included in a configuration.

1089

"A String",

1090

],

1091

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1096

"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.

1097

"A String",

1098

],

1099

"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.

1100

"A String",

1101

],

1102

"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.

1103

"A String",

1104

],

1105

"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.

1106

"A String",

1107

],

1108

"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

1109

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1110

"A String",

1111

],

1112

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1113

"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

1114

"includedIds": [ # The IDs included in a configuration.

1115

"A String",

1116

],

1117

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1122

"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.

1123

"includedIds": [ # The IDs included in a configuration.

1124

"A String",

1125

],

1126

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1131

"values": [ # The values specified.

1132

"A String",

1133

],

1134

"targetingMode": "A String", # How the items in this list should be targeted.

1135

},

1136

"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.

1137

"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.

1138

"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).

1139

"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.

1140

"includedIds": [ # The IDs included in a configuration.

1141

"A String",

1142

],

1143

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1148

"values": [ # The values specified.

1149

"A String",

1150

],

1151

"targetingMode": "A String", # How the items in this list should be targeted.

1152

},

1153

},

1154

"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.

1155

"A String",

1156

],

1157

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1158

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1159

"A String",

1160

],

1161

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1162

"A String",

1163

],

1164

"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.

1165

"A String",

1166

],

1167

"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.

1168

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1169

"width": "A String", # The width of the creative in pixels.

1170

"height": "A String", # The height of the creative in pixels.

},

],

}

updateMask: string, Field mask to use for partial in-place updates.

1176

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

1186

"values": [ # The values specified.

1187

"A String",

1188

],

1189

"targetingMode": "A String", # How the items in this list should be targeted.

1190

},

1191

"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

1192

"includedIds": [ # The IDs included in a configuration.

1193

"A String",

1194

],

1195

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1200

"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.

1201

"A String",

1202

],

1203

"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.

1204

"A String",

1205

],

1206

"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.

1207

"A String",

1208

],

1209

"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.

1210

"A String",

1211

],

1212

"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

1213

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1214

"A String",

1215

],

1216

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1217

"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

1218

"includedIds": [ # The IDs included in a configuration.

1219

"A String",

1220

],

1221

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1226

"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.

1227

"includedIds": [ # The IDs included in a configuration.

1228

"A String",

1229

],

1230

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1235

"values": [ # The values specified.

1236

"A String",

1237

],

1238

"targetingMode": "A String", # How the items in this list should be targeted.

1239

},

1240

"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.

1241

"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.

1242

"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).

1243

"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.

1244

"includedIds": [ # The IDs included in a configuration.

1245

"A String",

1246

],

1247

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1252

"values": [ # The values specified.

1253

"A String",

1254

],

1255

"targetingMode": "A String", # How the items in this list should be targeted.

1256

},

1257

},

1258

"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.

1259

"A String",

1260

],

1261

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1262

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1263

"A String",

1264

],

1265

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1266

"A String",

1267

],

1268

"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.

1269

"A String",

1270

],

1271

"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.

1272

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1273

"width": "A String", # The width of the creative in pixels.

1274

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="removeTargetedApps">removeTargetedApps(pretargetingConfig, body=None, x__xgafv=None)</code>

1282

<pre>Removes targeted apps from the pretargeting configuration.

1283

1284

Args:

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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

1305

"values": [ # The values specified.

1306

"A String",

1307

],

1308

"targetingMode": "A String", # How the items in this list should be targeted.

1309

},

1310

"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

1311

"includedIds": [ # The IDs included in a configuration.

1312

"A String",

1313

],

1314

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1319

"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.

1320

"A String",

1321

],

1322

"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.

1323

"A String",

1324

],

1325

"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.

1326

"A String",

1327

],

1328

"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.

1329

"A String",

1330

],

1331

"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

1332

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1333

"A String",

1334

],

1335

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1336

"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

1337

"includedIds": [ # The IDs included in a configuration.

1338

"A String",

1339

],

1340

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1345

"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.

1346

"includedIds": [ # The IDs included in a configuration.

1347

"A String",

1348

],

1349

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1354

"values": [ # The values specified.

1355

"A String",

1356

],

1357

"targetingMode": "A String", # How the items in this list should be targeted.

1358

},

1359

"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.

1360

"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.

1361

"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).

1362

"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.

1363

"includedIds": [ # The IDs included in a configuration.

1364

"A String",

1365

],

1366

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1371

"values": [ # The values specified.

1372

"A String",

1373

],

1374

"targetingMode": "A String", # How the items in this list should be targeted.

1375

},

1376

},

1377

"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.

1378

"A String",

1379

],

1380

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1381

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1382

"A String",

1383

],

1384

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1385

"A String",

1386

],

1387

"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.

1388

"A String",

1389

],

1390

"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.

1391

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1392

"width": "A String", # The width of the creative in pixels.

1393

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="removeTargetedPublishers">removeTargetedPublishers(pretargetingConfig, body=None, x__xgafv=None)</code>

1401

<pre>Removes targeted publishers from the pretargeting config.

1402

1403

Args:

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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

1424

"values": [ # The values specified.

1425

"A String",

1426

],

1427

"targetingMode": "A String", # How the items in this list should be targeted.

1428

},

1429

"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

1430

"includedIds": [ # The IDs included in a configuration.

1431

"A String",

1432

],

1433

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1438

"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.

1439

"A String",

1440

],

1441

"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.

1442

"A String",

1443

],

1444

"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.

1445

"A String",

1446

],

1447

"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.

1448

"A String",

1449

],

1450

"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

1451

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1452

"A String",

1453

],

1454

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1455

"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

1456

"includedIds": [ # The IDs included in a configuration.

1457

"A String",

1458

],

1459

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1464

"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.

1465

"includedIds": [ # The IDs included in a configuration.

1466

"A String",

1467

],

1468

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1473

"values": [ # The values specified.

1474

"A String",

1475

],

1476

"targetingMode": "A String", # How the items in this list should be targeted.

1477

},

1478

"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.

1479

"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.

1480

"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).

1481

"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.

1482

"includedIds": [ # The IDs included in a configuration.

1483

"A String",

1484

],

1485

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1490

"values": [ # The values specified.

1491

"A String",

1492

],

1493

"targetingMode": "A String", # How the items in this list should be targeted.

1494

},

1495

},

1496

"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.

1497

"A String",

1498

],

1499

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1500

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1501

"A String",

1502

],

1503

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1504

"A String",

1505

],

1506

"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.

1507

"A String",

1508

],

1509

"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.

1510

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1511

"width": "A String", # The width of the creative in pixels.

1512

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="removeTargetedSites">removeTargetedSites(pretargetingConfig, body=None, x__xgafv=None)</code>

1520

<pre>Removes targeted sites from the pretargeting configuration.

1521

1522

Args:

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.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

1543

"values": [ # The values specified.

1544

"A String",

1545

],

1546

"targetingMode": "A String", # How the items in this list should be targeted.

1547

},

1548

"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

1549

"includedIds": [ # The IDs included in a configuration.

1550

"A String",

1551

],

1552

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1557

"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.

1558

"A String",

1559

],

1560

"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.

1561

"A String",

1562

],

1563

"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.

1564

"A String",

1565

],

1566

"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.

1567

"A String",

1568

],

1569

"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

1570

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1571

"A String",

1572

],

1573

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1574

"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

1575

"includedIds": [ # The IDs included in a configuration.

1576

"A String",

1577

],

1578

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1583

"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.

1584

"includedIds": [ # The IDs included in a configuration.

1585

"A String",

1586

],

1587

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1592

"values": [ # The values specified.

1593

"A String",

1594

],

1595

"targetingMode": "A String", # How the items in this list should be targeted.

1596

},

1597

"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.

1598

"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.

1599

"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).

1600

"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.

1601

"includedIds": [ # The IDs included in a configuration.

1602

"A String",

1603

],

1604

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1609

"values": [ # The values specified.

1610

"A String",

1611

],

1612

"targetingMode": "A String", # How the items in this list should be targeted.

1613

},

1614

},

1615

"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.

1616

"A String",

1617

],

1618

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1619

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1620

"A String",

1621

],

1622

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1623

"A String",

1624

],

1625

"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.

1626

"A String",

1627

],

1628

"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.

1629

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1630

"width": "A String", # The width of the creative in pixels.

1631

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

<code class="details" id="suspend">suspend(name, body=None, x__xgafv=None)</code>

1639

<pre>Suspends a pretargeting configuration.

1640

1641

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

"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).

1659

"values": [ # The values specified.

1660

"A String",

1661

],

1662

"targetingMode": "A String", # How the items in this list should be targeted.

1663

},

1664

"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

1665

"includedIds": [ # The IDs included in a configuration.

1666

"A String",

1667

],

1668

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1673

"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.

1674

"A String",

1675

],

1676

"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.

1677

"A String",

1678

],

1679

"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.

1680

"A String",

1681

],

1682

"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.

1683

"A String",

1684

],

1685

"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

1686

"invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

1687

"A String",

1688

],

1689

"displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

1690

"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

1691

"includedIds": [ # The IDs included in a configuration.

1692

"A String",

1693

],

1694

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"state": "A String", # Output only. The state of this pretargeting configuration.

1699

"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.

1700

"includedIds": [ # The IDs included in a configuration.

1701

"A String",

1702

],

1703

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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).

1708

"values": [ # The values specified.

1709

"A String",

1710

],

1711

"targetingMode": "A String", # How the items in this list should be targeted.

1712

},

1713

"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.

1714

"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.

1715

"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).

1716

"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.

1717

"includedIds": [ # The IDs included in a configuration.

1718

"A String",

1719

],

1720

"excludedIds": [ # The IDs excluded in a configuration.

"A String",

],

},

"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.

1725

"values": [ # The values specified.

1726

"A String",

1727

],

1728

"targetingMode": "A String", # How the items in this list should be targeted.

1729

},

1730

},

1731

"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.

1732

"A String",

1733

],

1734

"name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`

1735

"includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

1736

"A String",

1737

],

1738

"includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

1739

"A String",

1740

],

1741

"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.

1742

"A String",

1743

],

1744

"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.

1745

{ # The dimensions of a creative. This applies to only HTML and Native creatives.

1746

"width": "A String", # The width of the creative in pixels.

1747

"height": "A String", # The height of the creative in pixels.

},

],

}</pre>

</div>

</body></html>