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

2020-05-27 12:20:54 -0700

[diff] [blame]

78

<code><a href="#list">list(accountId, pageSize=None, pageToken=None, filterSyntax=None, filter=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-27 12:20:54 -0700

[diff] [blame]

85

<code class="details" id="list">list(accountId, pageSize=None, pageToken=None, filterSyntax=None, filter=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

2020-05-27 12:20:54 -0700

[diff] [blame]

92

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

93

If unspecified, the server will pick an appropriate default.

94

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

Bu Sun Kim

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

[diff] [blame]

95

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

96

but in the future it will be LIST_FILTER.

97

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

98

99

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

100

cannot be filtered.

Bu Sun Kim

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

[diff] [blame]

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

"proposals": [ # The list of proposals.

Bu Sun Kim

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

[diff] [blame]

111

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

112

# account manager for access to Marketplace resources.

113

#

114

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

115

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

116

# are served.

117

#

118

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

119

# Auction or Preferred Deals deals through the API.

120

#

121

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

122

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

123

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

124

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

125

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

126

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

127

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

128

# was made.

Bu Sun Kim

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

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

Bu Sun Kim

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

[diff] [blame]

131

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

132

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

133

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

134

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

135

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

136

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

137

# deal.

138

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

Bu Sun Kim

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

[diff] [blame]

139

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

140

# PUBLISHER means creative is provided by seller and ADVERTISER means

141

# creative is provided by buyer.

Bu Sun Kim

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

[diff] [blame]

142

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

143

# targeting entity is AND'd together.

144

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

145

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

146

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

147

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

148

# together.

149

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

Bu Sun Kim

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

[diff] [blame]

150

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

151

# Filled in when the key is GOOG_DAYPART_TARGETING.

152

# The definition of this targeting is derived from the structure

153

# used by Ad Manager.

154

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

155

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

156

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

157

# only during certain parts of a day/week.

Bu Sun Kim

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

[diff] [blame]

158

"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

159

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

160

# for filtering in PQL queries.

161

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

162

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

163

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

Bu Sun Kim

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

[diff] [blame]

164

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

165

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

166

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

Bu Sun Kim

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

[diff] [blame]

167

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

168

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

169

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

170

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

171

# The start time is inclusive.

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

},

182

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

Bu Sun Kim

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

[diff] [blame]

183

},

184

],

185

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

186

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

187

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

188

# Filled in when key = GOOG_CREATIVE_SIZE

189

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

190

# only if creative_size_type = CreativeSizeType.NATIVE.

191

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

192

# of the creative

193

# height depend on the type of the targeting.

194

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

195

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

196

},

197

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

198

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

199

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

200

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

201

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

202

"A String",

203

],

204

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

205

# creative_size_type = CreativeSizeType.VIDEO.

206

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

207

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

208

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

209

# height depend on the type of the targeting.

210

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

211

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

},

],

},

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

216

},

217

],

218

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

219

# together.

220

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

221

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

222

# Filled in when the key is GOOG_DAYPART_TARGETING.

223

# The definition of this targeting is derived from the structure

224

# used by Ad Manager.

225

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

226

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

227

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

228

# only during certain parts of a day/week.

229

"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

230

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

231

# for filtering in PQL queries.

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

},

241

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

242

# The start time is inclusive.

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

},

253

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

},

],

},

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

258

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

259

# Filled in when key = GOOG_CREATIVE_SIZE

260

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

261

# only if creative_size_type = CreativeSizeType.NATIVE.

262

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

263

# of the creative

264

# height depend on the type of the targeting.

265

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

266

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

267

},

268

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

269

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

270

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

271

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

272

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

273

"A String",

274

],

275

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

276

# creative_size_type = CreativeSizeType.VIDEO.

277

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

278

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

279

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

280

# height depend on the type of the targeting.

281

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

282

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

287

},

288

],

289

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

290

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

291

# Third parties may define their own keys.

292

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

293

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

294

},

295

],

296

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

297

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

298

# in Ad Manager.

299

# Preferred Deal in Ad Manager.

300

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

301

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

302

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

303

"creativeSpecifications": [

304

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

305

# Guaranteed/Preferred Deal in Ad Manager.

306

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

307

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

308

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

309

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

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

313

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

314

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

315

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

316

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

317

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

318

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

319

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

},

],

},

],

},

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

326

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

327

# The deal is considered paused if either hasBuyerPaused or

328

# hasSellPaused is true.

329

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

330

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

331

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

332

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

333

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

Bu Sun Kim

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

[diff] [blame]

334

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

335

},

Bu Sun Kim

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

[diff] [blame]

336

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

337

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

338

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

339

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

340

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

341

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

342

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

343

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

Bu Sun Kim

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

[diff] [blame]

344

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

345

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

346

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

347

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

348

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

349

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

350

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

351

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

352

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

353

"A String",

354

],

Bu Sun Kim

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

[diff] [blame]

355

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

356

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

Bu Sun Kim

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

[diff] [blame]

357

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

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

363

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

364

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

365

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

366

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

Bu Sun Kim

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

[diff] [blame]

367

},

Bu Sun Kim

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

[diff] [blame]

368

},

Bu Sun Kim

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

[diff] [blame]

369

"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

370

# (if the

371

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

372

# Authorized Buyers account ID.

373

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

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

378

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

379

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

380

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

381

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

382

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

Bu Sun Kim

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

[diff] [blame]

383

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

384

# Can be set by buyer or seller.

385

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

386

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

387

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

388

# in this private auction.

389

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

390

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

391

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

392

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

393

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

394

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

395

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

396

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

397

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

398

"A String",

399

],

Bu Sun Kim

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

[diff] [blame]

400

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

401

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

Bu Sun Kim

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

[diff] [blame]

402

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

403

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

404

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

Bu Sun Kim

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

[diff] [blame]

405

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

406

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

407

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

408

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

409

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

410

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

411

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

Bu Sun Kim

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

[diff] [blame]

412

},

Bu Sun Kim

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

[diff] [blame]

413

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

414

"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

415

# (if the

416

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

417

# Authorized Buyers account ID.

418

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

},

},

],

},

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

424

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

425

"fixedPrices": [ # Fixed 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.

Bu Sun Kim

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

[diff] [blame]

432

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

433

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

434

"A String",

435

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

},

449

},

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

461

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

Bu Sun Kim

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

[diff] [blame]

462

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

463

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

464

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

Bu Sun Kim

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

[diff] [blame]

465

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

466

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

467

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

468

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

469

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

470

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

471

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

Bu Sun Kim

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

[diff] [blame]

472

},

Bu Sun Kim

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

[diff] [blame]

473

},

474

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

Bu Sun Kim

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

[diff] [blame]

475

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

476

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

477

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

478

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

479

#

480

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

481

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

482

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

483

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

Bu Sun Kim

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

[diff] [blame]

484

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

485

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

486

# if the user is in the US.

487

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

488

# otherwise.

Bu Sun Kim

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

[diff] [blame]

489

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

490

# mobile applications.

491

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

492

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

493

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

494

# excluded.

495

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

496

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

497

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

Bu Sun Kim

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

[diff] [blame]

498

"A String",

499

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

500

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

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

505

# This doesn't apply to Auction Packages.

506

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

507

# display the ads in.

508

# publishers own.

509

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

510

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

511

# Google Play Store URL.

512

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

513

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

514

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

Bu Sun Kim

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

[diff] [blame]

515

"A String",

Dan O'Meara

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

[diff] [blame]

516

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

517

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

Bu Sun Kim

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

[diff] [blame]

518

"A String",

Dan O'Meara

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

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

523

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

524

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

525

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

526

# and Preferred Deals in Ad Manager.

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

},

535

],

536

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

537

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

538

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

539

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

540

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

541

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

542

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

},

],

},

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

547

# included and excluded numeric IDs.

548

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

549

"A String",

550

],

551

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

"A String",

],

},

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

556

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

557

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

558

# included and excluded numeric IDs.

559

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

560

"A String",

561

],

562

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

"A String",

],

},

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

567

# included and excluded numeric IDs.

568

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

569

"A String",

570

],

571

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

"A String",

],

},

},

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

577

# included and excluded numeric IDs.

578

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

579

"A String",

580

],

581

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

"A String",

],

},

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

586

# included and excluded numeric IDs.

587

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

588

"A String",

589

],

590

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

"A String",

],

},

},

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

596

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

597

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

598

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

599

"A String",

600

],

601

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

602

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

603

"A String",

604

],

605

},

Bu Sun Kim

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

[diff] [blame]

606

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

607

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

608

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

609

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

610

},

Bu Sun Kim

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

[diff] [blame]

611

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

612

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

Bu Sun Kim

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

[diff] [blame]

613

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

Bu Sun Kim

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

[diff] [blame]

614

{ # Frequency cap.

Bu Sun Kim

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

[diff] [blame]

615

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

616

# specified time period.

Bu Sun Kim

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

[diff] [blame]

617

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

618

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

619

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

620

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

Bu Sun Kim

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

[diff] [blame]

621

},

622

],

Bu Sun Kim

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

[diff] [blame]

623

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

624

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

Bu Sun Kim

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

[diff] [blame]

625

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

# time in seconds.

634

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

635

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

636

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

637

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

638

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

639

# returned.

640

#

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

Bu Sun Kim

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

[diff] [blame]

649

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

650

],

Bu Sun Kim

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

[diff] [blame]

651

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

652

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

653

#

654

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

655

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

Bu Sun Kim

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

[diff] [blame]

656

},

657

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

658

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

659

# Authorized Buyers account ID.

660

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

661

},

662

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

Bu Sun Kim

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

[diff] [blame]

663

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

664

#

665

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

666

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

667

# Ad Manager account ID.

Bu Sun Kim

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

[diff] [blame]

668

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

669

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

670

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

671

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

672

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

673

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

674

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

675

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

676

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

677

{ # A proposal may be associated to several notes.

678

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

679

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

680

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

681

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

682

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

683

# (max-length: 1024 unicode code units)

684

#

685

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

686

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

687

},

688

],

689

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

690

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

691

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

692

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

693

},

694

],

695

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

696

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

697

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

698

},

699

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

700

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

701

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

702

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

703

},

704

],

705

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

706

# proposal.

707

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

708

# proposal.

709

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

710

#

711

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

712

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

713

# Authorized Buyers account ID.

714

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

715

},

716

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

717

# left a comment.

Bu Sun Kim

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

[diff] [blame]

718

},

719

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

720

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

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