Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

78

<code><a href="#list">list(accountId, filterSyntax=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">List finalized proposals, regardless if a proposal is being renegotiated.</p>

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

85

<code class="details" id="list">list(accountId, filterSyntax=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

<pre>List finalized proposals, regardless if a proposal is being renegotiated.

87

A filter expression (PQL query) may be specified to filter the results.

88

The notes will not be returned.

89

90

Args:

91

accountId: string, Account ID of the buyer. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL

93

but in the future it will be LIST_FILTER.

94

filter: string, An optional PQL filter query used to query for proposals.

95

96

Nested repeated fields, such as proposal.deals.targetingCriterion,

97

cannot be filtered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

98

pageToken: string, The page token as returned from ListProposalsResponse.

99

pageSize: integer, Requested page size. The server may return fewer results than requested.

100

If unspecified, the server will pick an appropriate default.

101

x__xgafv: string, V1 error format.

102

Allowed values

103

1 - v1 error format

104

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

106

Returns:

107

An object of the form:

108

109

{ # Response message for listing proposals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

110

"nextPageToken": "A String", # Continuation token for fetching the next page of results.

111

"proposals": [ # The list of proposals.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

{ # Note: this resource requires whitelisting for access. Please contact your

113

# account manager for access to Marketplace resources.

114

#

115

# Represents a proposal in the Marketplace. A proposal is the unit of

116

# negotiation between a seller and a buyer and contains deals which

117

# are served.

118

#

119

# Note: you can not update, create, or otherwise modify Private

120

# Auction or Preferred Deals deals through the API.

121

#

122

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

124

#

125

# Note: This field may be set only when creating the resource. Modifying

126

# this field while updating the resource will result in an error.

127

# Authorized Buyers account ID.

128

"accountId": "A String", # Authorized Buyers account ID of the buyer.

129

},

130

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

131

"notes": [ # Output only. The notes associated with this proposal.

132

{ # A proposal may be associated to several notes.

133

"note": "A String", # The actual note to attach.

134

# (max-length: 1024 unicode code units)

135

#

136

# Note: This field may be set only when creating the resource. Modifying

137

# this field while updating the resource will result in an error.

138

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

139

"noteId": "A String", # Output only. The unique ID for the note.

140

"createTime": "A String", # Output only. The timestamp for when this note was created.

141

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

142

},

143

],

144

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

145

# proposal.

146

"proposalState": "A String", # Output only. The current state of the proposal.

147

"sellerContacts": [ # Output only. Contact information for the seller.

148

{ # Contains information on how a buyer or seller can be reached.

149

"email": "A String", # Email address for the contact.

150

"name": "A String", # The name of the contact.

151

},

152

],

153

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

154

# proposal.

155

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

156

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

157

# left a comment.

158

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

159

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

160

# operations (max-length: 1024 unicode code units).

161

},

162

"displayName": "A String", # The name for the proposal.

163

"buyerContacts": [ # Contact information for the buyer.

164

{ # Contains information on how a buyer or seller can be reached.

165

"email": "A String", # Email address for the contact.

166

"name": "A String", # The name of the contact.

167

},

168

],

169

"billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.

170

# Authorized Buyers account ID.

171

"accountId": "A String", # Authorized Buyers account ID of the buyer.

172

},

173

"updateTime": "A String", # Output only. The time when the proposal was last revised.

174

"proposalId": "A String", # Output only. The unique ID of the proposal.

175

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

176

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

177

{ # A deal represents a segment of inventory for displaying ads on.

178

# A proposal can contain multiple deals. A deal contains the terms and

179

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

180

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

181

# PUBLISHER means creative is provided by seller and ADVERTISER means

182

# creative is provided by buyer.

183

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

184

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

185

# operations (max-length: 1024 unicode code units).

186

},

187

"displayName": "A String", # The name of the deal.

188

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

189

"updateTime": "A String", # Output only. The time when the deal was last updated.

190

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

191

# targeting entity is AND'd together.

192

{ # Advertisers can target different attributes of an ad slot. For example,

193

# they can choose to show ads only if the user is in the U.S. Such

194

# targeting criteria can be specified as part of Shared Targeting.

195

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

196

# together.

197

{ # A polymorphic targeting value used as part of Shared Targeting.

198

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

199

# Filled in when key = GOOG_CREATIVE_SIZE

200

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

201

# of the creative

202

# height depend on the type of the targeting.

203

"height": 42, # The height of the creative.

204

"width": 42, # The width of the creative

205

},

206

"allowedFormats": [ # What formats are allowed by the publisher.

207

# If this repeated field is empty then all formats are allowed.

208

# For example, if this field contains AllowedFormatType.AUDIO then the

209

# publisher only allows an audio ad (without any video).

210

"A String",

211

],

212

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

213

# Companion sizes may be filled in only when creative_size_type = VIDEO

214

{ # Message depicting the size of the creative. The units of width and

215

# height depend on the type of the targeting.

216

"height": 42, # The height of the creative.

217

"width": 42, # The width of the creative

218

},

219

],

220

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

221

# creative_size_type = CreativeSizeType.VIDEO.

222

"creativeSizeType": "A String", # The creative size type.

223

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

224

# only if creative_size_type = CreativeSizeType.NATIVE.

225

},

226

"stringValue": "A String", # The string value to include/exclude.

227

"longValue": "A String", # The long value to include/exclude.

228

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

229

# Filled in when the key is GOOG_DAYPART_TARGETING.

230

# The definition of this targeting is derived from the structure

231

# used by Ad Manager.

232

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

233

"dayParts": [ # A list of day part targeting criterion.

234

{ # Daypart targeting message that specifies if the ad can be shown

235

# only during certain parts of a day/week.

236

"startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).

237

# The start time is inclusive.

238

# This field is not available for filtering in PQL queries.

239

# or are specified elsewhere. An API may choose to allow leap seconds. Related

240

# types are google.type.Date and `google.protobuf.Timestamp`.

241

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

242

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

243

# to allow the value "24:00:00" for scenarios like business closing time.

244

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

245

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

246

# allow the value 60 if it allows leap-seconds.

247

},

248

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

249

"endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level

250

# granularity). The end time is exclusive. This field is not available

251

# for filtering in PQL queries.

252

# or are specified elsewhere. An API may choose to allow leap seconds. Related

253

# types are google.type.Date and `google.protobuf.Timestamp`.

254

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

255

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

256

# to allow the value "24:00:00" for scenarios like business closing time.

257

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

258

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

259

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

267

# Targeting criteria defined by Google ad servers will begin with GOOG_.

268

# Third parties may define their own keys.

269

# A list of permissible keys along with the acceptable values will be

270

# provided as part of the external documentation.

271

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

272

# together.

273

{ # A polymorphic targeting value used as part of Shared Targeting.

274

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

275

# Filled in when key = GOOG_CREATIVE_SIZE

276

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

277

# of the creative

278

# height depend on the type of the targeting.

279

"height": 42, # The height of the creative.

280

"width": 42, # The width of the creative

281

},

282

"allowedFormats": [ # What formats are allowed by the publisher.

283

# If this repeated field is empty then all formats are allowed.

284

# For example, if this field contains AllowedFormatType.AUDIO then the

285

# publisher only allows an audio ad (without any video).

286

"A String",

287

],

288

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

289

# Companion sizes may be filled in only when creative_size_type = VIDEO

290

{ # Message depicting the size of the creative. The units of width and

291

# height depend on the type of the targeting.

292

"height": 42, # The height of the creative.

293

"width": 42, # The width of the creative

294

},

295

],

296

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

297

# creative_size_type = CreativeSizeType.VIDEO.

298

"creativeSizeType": "A String", # The creative size type.

299

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

300

# only if creative_size_type = CreativeSizeType.NATIVE.

301

},

302

"stringValue": "A String", # The string value to include/exclude.

303

"longValue": "A String", # The long value to include/exclude.

304

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

305

# Filled in when the key is GOOG_DAYPART_TARGETING.

306

# The definition of this targeting is derived from the structure

307

# used by Ad Manager.

308

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

309

"dayParts": [ # A list of day part targeting criterion.

310

{ # Daypart targeting message that specifies if the ad can be shown

311

# only during certain parts of a day/week.

312

"startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).

313

# The start time is inclusive.

314

# This field is not available for filtering in PQL queries.

315

# or are specified elsewhere. An API may choose to allow leap seconds. Related

316

# types are google.type.Date and `google.protobuf.Timestamp`.

317

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

318

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

319

# to allow the value "24:00:00" for scenarios like business closing time.

320

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

321

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

322

# allow the value 60 if it allows leap-seconds.

323

},

324

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

325

"endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level

326

# granularity). The end time is exclusive. This field is not available

327

# for filtering in PQL queries.

328

# or are specified elsewhere. An API may choose to allow leap seconds. Related

329

# types are google.type.Date and `google.protobuf.Timestamp`.

330

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

331

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

332

# to allow the value "24:00:00" for scenarios like business closing time.

333

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

334

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

335

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

345

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

346

"availableEndTime": "A String", # Proposed flight end time of the deal.

347

# This will generally be stored in a granularity of a second.

348

# A value is not required for Private Auction deals or Preferred Deals.

349

"syndicationProduct": "A String", # The syndication product associated with the deal.

350

#

351

# Note: This field may be set only when creating the resource. Modifying

352

# this field while updating the resource will result in an error.

353

"createProductId": "A String", # The product ID from which this deal was created.

354

#

355

# Note: This field may be set only when creating the resource. Modifying

356

# this field while updating the resource will result in an error.

357

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

358

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

359

# deal.

360

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

361

# If present on create, and the server `product_revision` has advanced sinced

362

# the passed-in `create_product_revision`, an `ABORTED` error will be

363

# returned.

364

#

365

# Note: This field may be set only when creating the resource. Modifying

366

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

"sellerContacts": [ # Output only. Seller contact information for the deal.

368

{ # Contains information on how a buyer or seller can be reached.

369

"email": "A String", # Email address for the contact.

370

"name": "A String", # The name of the contact.

371

},

372

],

373

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

374

# This will generally be stored in the granularity of one second since deal

375

# serving starts at seconds boundary. Any time specified with more

376

# granularity (e.g., in milliseconds) will be truncated towards the start of

377

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

378

"createTime": "A String", # Output only. The time of the deal creation.

379

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

380

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

381

# and expected impressions from the publisher.

382

"description": "A String", # Publisher provided description for the terms.

383

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

384

# the API at this time, but can be returned in a get or list request.

385

"fixedPrices": [ # Fixed price for the specified buyer.

386

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

387

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

388

# a particular buyer or buyer/advertiser pair, we look for the most specific

389

# matching rule - we first look for a rule matching the buyer and advertiser,

390

# next a rule with the buyer but an empty advertiser list, and otherwise look

391

# for a matching rule where no buyer is set.

392

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

393

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

394

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

395

"nanos": 42, # Number of nano (10^-9) units of the amount.

396

# The value must be between -999,999,999 and +999,999,999 inclusive.

397

# If `units` is positive, `nanos` must be positive or zero.

398

# If `units` is zero, `nanos` can be positive, zero, or negative.

399

# If `units` is negative, `nanos` must be negative or zero.

400

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

401

"units": "A String", # The whole units of the amount.

402

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

403

},

404

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

405

},

406

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

407

# If empty, all advertisers with this buyer pay this price.

408

"A String",

409

],

410

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price

411

# (if the

412

# advertisers match, and there's no more specific rule matching the buyer).

413

# Authorized Buyers account ID.

414

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

420

# Can be set by buyer or seller.

421

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

422

# by the seller, but they can be returned in a get or list request.

423

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

424

# in this private auction.

425

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

426

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

427

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

428

# a particular buyer or buyer/advertiser pair, we look for the most specific

429

# matching rule - we first look for a rule matching the buyer and advertiser,

430

# next a rule with the buyer but an empty advertiser list, and otherwise look

431

# for a matching rule where no buyer is set.

432

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

433

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

434

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

435

"nanos": 42, # Number of nano (10^-9) units of the amount.

436

# The value must be between -999,999,999 and +999,999,999 inclusive.

437

# If `units` is positive, `nanos` must be positive or zero.

438

# If `units` is zero, `nanos` can be positive, zero, or negative.

439

# If `units` is negative, `nanos` must be negative or zero.

440

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

441

"units": "A String", # The whole units of the amount.

442

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

443

},

444

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

445

},

446

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

447

# If empty, all advertisers with this buyer pay this price.

448

"A String",

449

],

450

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price

451

# (if the

452

# advertisers match, and there's no more specific rule matching the buyer).

453

# Authorized Buyers account ID.

454

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

460

# Can be set by buyer or seller.

461

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

462

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

463

"nanos": 42, # Number of nano (10^-9) units of the amount.

464

# The value must be between -999,999,999 and +999,999,999 inclusive.

465

# If `units` is positive, `nanos` must be positive or zero.

466

# If `units` is zero, `nanos` can be positive, zero, or negative.

467

# If `units` is negative, `nanos` must be negative or zero.

468

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

469

"units": "A String", # The whole units of the amount.

470

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

471

},

472

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

473

},

474

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

475

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

476

# time zone used to mark the boundaries of a day. It should be an

477

# IANA TZ name, such as "America/Los_Angeles". For more information,

478

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

479

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

480

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

481

# of guaranteed looks that the buyer is guaranteeing to buy.

482

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

483

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

484

"fixedPrices": [ # Fixed price for the specified buyer.

485

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

486

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

487

# a particular buyer or buyer/advertiser pair, we look for the most specific

488

# matching rule - we first look for a rule matching the buyer and advertiser,

489

# next a rule with the buyer but an empty advertiser list, and otherwise look

490

# for a matching rule where no buyer is set.

491

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

492

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

493

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

494

"nanos": 42, # Number of nano (10^-9) units of the amount.

495

# The value must be between -999,999,999 and +999,999,999 inclusive.

496

# If `units` is positive, `nanos` must be positive or zero.

497

# If `units` is zero, `nanos` can be positive, zero, or negative.

498

# If `units` is negative, `nanos` must be negative or zero.

499

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

500

"units": "A String", # The whole units of the amount.

501

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

502

},

503

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

504

},

505

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

506

# If empty, all advertisers with this buyer pay this price.

507

"A String",

508

],

509

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price

510

# (if the

511

# advertisers match, and there's no more specific rule matching the buyer).

512

# Authorized Buyers account ID.

513

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

520

# target ad inventory. For example, they can choose to target ad requests only

521

# if the user is in the US.

522

# Multiple types of targeting are always applied as a logical AND, unless noted

523

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

524

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

525

# included and excluded numeric IDs.

526

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

527

"A String",

528

],

529

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

534

# request. It only applies to Private Auction, AdX Preferred Deals and

535

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

536

# and Preferred Deals in Ad Manager.

537

"targetedInventorySizes": [ # A list of inventory sizes to be included.

538

{ # Represents size of a single ad slot, or a creative.

539

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

540

# This field will be present only when size type is `PIXEL`.

541

"sizeType": "A String", # The size type of the ad slot.

542

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

543

# This field will be present only when size type is `PIXEL`.

544

},

545

],

546

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

547

{ # Represents size of a single ad slot, or a creative.

548

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

549

# This field will be present only when size type is `PIXEL`.

550

"sizeType": "A String", # The size type of the ad slot.

551

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

552

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

557

"targetedPositionTypes": [ # A list of video positions to be included.

558

# When the included list is present, the excluded list must be empty.

559

# When the excluded list is present, the included list must be empty.

560

"A String",

561

],

562

"excludedPositionTypes": [ # A list of video positions to be excluded.

563

# Position types can either be included or excluded (XOR).

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

568

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

569

# included and excluded numeric IDs.

570

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

571

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

572

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

573

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

574

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

575

],

576

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

577

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

578

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

579

# included and excluded numeric IDs.

580

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

581

"A String",

582

],

583

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

588

# included and excluded numeric IDs.

589

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

590

"A String",

591

],

592

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

598

# included and excluded numeric IDs.

599

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

600

"A String",

601

],

602

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

608

# mobile applications.

609

# Different placement targeting types will be logically OR'ed.

610

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

611

# For Private Auction and AdX Preferred Deals, URLs are either included or

612

# excluded.

613

# For Programmatic Guaranteed and Preferred Deals, this doesn't

614

# apply.

615

"targetedUrls": [ # A list of URLs to be included.

616

"A String",

617

],

618

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

623

# This doesn't apply to Auction Packages.

624

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

625

# display the ads in.

626

# publishers own.

627

# Mobile application IDs are from App Store and Google Play Store.

628

# Android App ID, for example, com.google.android.apps.maps, can be found in

629

# Google Play Store URL.

630

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

631

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

632

"targetedAppIds": [ # A list of application IDs to be included.

633

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

634

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

635

"excludedAppIds": [ # A list of application IDs to be excluded.

636

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

642

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

643

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

644

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

645

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

646

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

647

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

648

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

649

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

650

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

651

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

652

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

653

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

654

},

655

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

657

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

658

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

659

# finalized. This is the deal ID that shows up in serving/reporting etc.

660

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

661

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

662

# in Ad Manager.

663

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

# This doesn't apply to Private Auction and AdX Preferred Deals.

665

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

666

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

667

{ # Represents information for a creative that is associated with a Programmatic

668

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

669

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

670

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

671

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

672

"sizeType": "A String", # The size type of the ad slot.

673

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

674

# This field will be present only when size type is `PIXEL`.

675

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

676

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

677

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

678

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

679

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

680

"sizeType": "A String", # The size type of the ad slot.

681

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

682

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

687

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

688

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

689

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

690

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

691

# The deal is considered paused if either hasBuyerPaused or

692

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

693

"firstPausedBy": "A String", # The role of the person who first paused this deal.

694

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

695

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

696

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

697

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

698

},

699

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

700

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

701

},

702

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

703

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

704

# Each update to the proposal or the deal causes the proposal revision number

705

# to auto-increment. The buyer keeps track of the last revision number they

706

# know of and pass it in when making an update. If the head revision number

707

# on the server has since incremented, then an ABORTED error is returned

708

# during the update operation to let the buyer know that a subsequent update

709

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

710

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

711

#

712

# Note: This field may be set only when creating the resource. Modifying

713

# this field while updating the resource will result in an error.

714

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

715

"subAccountId": "A String", # Optional sub-account ID for the seller.

716

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

717

# The seller account ID is then available to buyer in the product.

718

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

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

726

<pre>Retrieves the next page of results.

727

728

Args:

729

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

730

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

731

732

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

A request object that you can call 'execute()' on to request the next

Bu Sun Kim