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

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

[diff] [blame]

78

<code><a href="#accept">accept(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Mark the proposal as accepted at the given revision number. If the number</p>

80

Dan O'Meara

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

[diff] [blame]

81

<code><a href="#addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Create a new note and attach it to the proposal. The note is assigned</p>

83

84

<code><a href="#cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Cancel an ongoing negotiation on a proposal. This does not cancel or end</p>

86

87

<code><a href="#completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Update the given proposal to indicate that setup has been completed.</p>

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Create the given proposal. Each created proposal and any deals it contains</p>

92

93

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

94

<p class="firstline">Gets a proposal given its ID. The proposal is returned at its head</p>

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">List proposals. A filter expression (PQL query) may be specified to</p>

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

<code><a href="#pause">pause(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Update the given proposal to pause serving.</p>

104

105

<code><a href="#resume">resume(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

106

<p class="firstline">Update the given proposal to resume serving.</p>

107

Dan O'Meara

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

[diff] [blame]

108

<code><a href="#update">update(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Update the given proposal at the client known revision number. If the</p>

110

<h3>Method Details</h3>

111

Dan O'Meara

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

[diff] [blame]

112

<code class="details" id="accept">accept(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

113

<pre>Mark the proposal as accepted at the given revision number. If the number

Bu Sun Kim

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

[diff] [blame]

114

does not match the server's revision number an `ABORTED` error message will

Bu Sun Kim

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

[diff] [blame]

115

be returned. This call updates the proposal_state from `PROPOSED` to

116

`BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.

117

118

Args:

119

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

120

proposalId: string, The ID of the proposal to accept. (required)

Dan O'Meara

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

[diff] [blame]

121

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

122

The object takes the form of:

123

124

{ # Request to accept a proposal.

Bu Sun Kim

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

[diff] [blame]

125

"proposalRevision": "A String", # The last known client revision number of the proposal.

Bu Sun Kim

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

[diff] [blame]

126

}

127

128

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

135

136

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

137

# account manager for access to Marketplace resources.

138

#

139

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

140

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

141

# are served.

142

#

143

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

144

# Auction or Preferred Deals deals through the API.

145

#

146

# Fields are updatable unless noted otherwise.

Bu Sun Kim

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

[diff] [blame]

147

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

148

#

149

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

150

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

151

# Authorized Buyers account ID.

152

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

153

},

154

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

155

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

156

{ # A proposal may be associated to several notes.

157

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

158

# (max-length: 1024 unicode code units)

159

#

160

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

161

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

162

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

163

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

164

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

165

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

166

},

167

],

168

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

169

# proposal.

170

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

171

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

172

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

173

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

174

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

175

},

176

],

177

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

178

# proposal.

179

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

180

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

181

# left a comment.

182

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

183

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

184

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

185

},

186

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

187

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

188

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

189

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

190

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

191

},

192

],

193

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

194

# Authorized Buyers account ID.

195

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

196

},

197

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

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

201

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

202

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

203

# targeting information that is used for serving.

Bu Sun Kim

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

[diff] [blame]

204

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

205

# PUBLISHER means creative is provided by seller and ADVERTISER means

206

# creative is provided by buyer.

207

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

208

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

209

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

210

},

211

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

212

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

213

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

214

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

215

# targeting entity is AND'd together.

216

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

217

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

218

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

219

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

220

# together.

221

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

222

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

223

# Filled in when key = GOOG_CREATIVE_SIZE

224

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

225

# of the creative

226

# height depend on the type of the targeting.

227

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

228

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

229

},

230

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

231

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

232

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

233

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

234

"A String",

235

],

236

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

237

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

238

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

239

# height depend on the type of the targeting.

240

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

241

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

242

},

243

],

244

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

245

# creative_size_type = CreativeSizeType.VIDEO.

246

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

247

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

248

# only if creative_size_type = CreativeSizeType.NATIVE.

249

},

250

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

251

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

252

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

253

# Filled in when the key is GOOG_DAYPART_TARGETING.

254

# The definition of this targeting is derived from the structure

255

# used by Ad Manager.

256

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

257

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

258

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

259

# only during certain parts of a day/week.

260

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

261

# The start time is inclusive.

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

},

272

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

273

"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

274

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

275

# for filtering in PQL queries.

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

},

},

],

},

},

],

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

291

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

292

# Third parties may define their own keys.

293

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

294

# provided as part of the external documentation.

295

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

296

# together.

297

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

298

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

299

# Filled in when key = GOOG_CREATIVE_SIZE

300

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

301

# of the creative

302

# height depend on the type of the targeting.

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

"A String",

311

],

312

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

313

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

314

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

315

# height depend on the type of the targeting.

316

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

317

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

318

},

319

],

320

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

321

# creative_size_type = CreativeSizeType.VIDEO.

322

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

323

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

324

# only if creative_size_type = CreativeSizeType.NATIVE.

325

},

326

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

327

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

328

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

329

# Filled in when the key is GOOG_DAYPART_TARGETING.

330

# The definition of this targeting is derived from the structure

331

# used by Ad Manager.

332

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

333

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

334

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

335

# only during certain parts of a day/week.

336

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

337

# The start time is inclusive.

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

},

348

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

349

"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

350

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

351

# for filtering in PQL queries.

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

},

},

],

},

},

],

},

],

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

369

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

370

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

371

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

372

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

373

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

374

#

375

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

376

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

377

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

378

#

379

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

380

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

381

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

382

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

383

# deal.

384

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

385

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

386

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

387

# returned.

388

#

389

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

390

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

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

393

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

394

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

395

},

396

],

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

400

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

401

# time in seconds.

Bu Sun Kim

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

[diff] [blame]

402

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

403

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

404

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

405

# and expected impressions from the publisher.

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

# for a matching rule where no buyer is set.

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

},

428

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

429

},

430

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

431

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

432

"A String",

433

],

434

"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

435

# (if the

436

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

437

# Authorized Buyers account ID.

438

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

},

},

],

},

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

444

# Can be set by buyer or seller.

445

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

446

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

447

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

448

# in this private auction.

449

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

450

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

451

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

452

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

453

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

454

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

455

# for a matching rule where no buyer is set.

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

},

468

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

469

},

470

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

471

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

472

"A String",

473

],

474

"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

475

# (if the

476

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

477

# Authorized Buyers account ID.

478

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

484

# Can be set by buyer or seller.

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

},

496

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

497

},

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

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

513

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

514

# for a matching rule where no buyer is set.

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

},

527

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

528

},

529

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

530

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

531

"A String",

532

],

533

"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

534

# (if the

535

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

536

# Authorized Buyers account ID.

537

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

544

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

545

# if the user is in the US.

546

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

547

# otherwise.

Bu Sun Kim

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

[diff] [blame]

548

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

549

# included and excluded numeric IDs.

550

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

551

"A String",

552

],

553

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

558

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

559

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

560

# and Preferred Deals in Ad Manager.

561

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

562

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

563

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

564

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

565

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

566

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

567

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

568

},

569

],

570

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

571

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

572

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

573

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

574

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

575

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

576

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

},

],

},

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

581

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

582

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

583

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

584

"A String",

585

],

586

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

587

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

592

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

593

# included and excluded numeric IDs.

594

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

595

"A String",

Dan O'Meara

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

[diff] [blame]

596

],

Bu Sun Kim

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

[diff] [blame]

597

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

598

"A String",

Dan O'Meara

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

[diff] [blame]

599

],

600

},

Bu Sun Kim

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

[diff] [blame]

601

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

602

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

603

# included and excluded numeric IDs.

604

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

605

"A String",

606

],

607

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

612

# included and excluded numeric IDs.

613

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

614

"A String",

615

],

616

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

622

# included and excluded numeric IDs.

623

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

624

"A String",

625

],

626

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

632

# mobile applications.

633

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

634

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

635

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

636

# excluded.

637

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

638

# apply.

639

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

640

"A String",

641

],

642

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

"A String",

],

},

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

647

# This doesn't apply to Auction Packages.

648

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

649

# display the ads in.

650

# publishers own.

651

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

652

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

653

# Google Play Store URL.

654

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

655

# First party mobile applications is either included or excluded.

Bu Sun Kim

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

[diff] [blame]

656

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

657

"A String",

Dan O'Meara

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

[diff] [blame]

658

],

Bu Sun Kim

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

[diff] [blame]

659

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

660

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

665

},

Bu Sun Kim

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

[diff] [blame]

666

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

667

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

668

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

Bu Sun Kim

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

[diff] [blame]

669

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

670

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

Bu Sun Kim

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

[diff] [blame]

671

{ # Frequency cap.

Bu Sun Kim

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

[diff] [blame]

672

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

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

675

# specified time period.

Bu Sun Kim

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

[diff] [blame]

676

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

677

# which impressions per user are counted and capped.

Bu Sun Kim

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

[diff] [blame]

678

},

679

],

Bu Sun Kim

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

[diff] [blame]

680

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

681

},

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

684

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

685

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

686

# in Ad Manager.

687

# Preferred Deal in Ad Manager.

Bu Sun Kim

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

[diff] [blame]

688

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

689

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

690

"creativeSpecifications": [

Dan O'Meara

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

[diff] [blame]

691

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

692

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

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

[diff] [blame]

693

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

694

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

Dan O'Meara

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

[diff] [blame]

695

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

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

Dan O'Meara

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

[diff] [blame]

698

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

699

},

Bu Sun Kim

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

[diff] [blame]

700

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

701

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

Bu Sun Kim

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

[diff] [blame]

702

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

Dan O'Meara

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

[diff] [blame]

703

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

Bu Sun Kim

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

[diff] [blame]

704

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

705

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

Dan O'Meara

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

[diff] [blame]

706

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

711

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

712

},

Bu Sun Kim

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

[diff] [blame]

713

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

714

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

715

# The deal is considered paused if either hasBuyerPaused or

716

# hasSellPaused is true.

Bu Sun Kim

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

[diff] [blame]

717

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

718

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

719

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

720

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

721

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

722

},

723

},

Bu Sun Kim

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

[diff] [blame]

724

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

Bu Sun Kim

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

[diff] [blame]

725

},

726

],

Bu Sun Kim

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

[diff] [blame]

727

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

Dan O'Meara

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

[diff] [blame]

728

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

729

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

730

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

731

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

732

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

733

# was made.

Bu Sun Kim

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

[diff] [blame]

734

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

735

#

736

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

737

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

738

# Ad Manager account ID.

Bu Sun Kim

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

[diff] [blame]

739

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

740

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

741

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

742

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

747

<code class="details" id="addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

748

<pre>Create a new note and attach it to the proposal. The note is assigned

749

a unique ID by the server.

750

The proposal revision number will not increase when associated with a

new note.

Args:

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

755

proposalId: string, The ID of the proposal to attach the note to. (required)

Dan O'Meara

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

[diff] [blame]

756

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

757

The object takes the form of:

758

759

{ # Request message for adding a note to a given proposal.

Bu Sun Kim

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

[diff] [blame]

760

"note": { # A proposal may be associated to several notes. # Details of the note to add.

761

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

Bu Sun Kim

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

[diff] [blame]

762

# (max-length: 1024 unicode code units)

763

#

764

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

765

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

Bu Sun Kim

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

[diff] [blame]

766

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

767

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

768

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

769

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

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

780

781

{ # A proposal may be associated to several notes.

Bu Sun Kim

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

[diff] [blame]

782

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

Bu Sun Kim

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

[diff] [blame]

783

# (max-length: 1024 unicode code units)

784

#

785

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

786

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

Bu Sun Kim

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

[diff] [blame]

787

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

788

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

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</code>

796

<pre>Cancel an ongoing negotiation on a proposal. This does not cancel or end

797

serving for the deals if the proposal has been finalized, but only cancels

798

a negotiation unilaterally.

799

800

Args:

801

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

802

proposalId: string, The ID of the proposal to cancel negotiation for. (required)

803

body: object, The request body.

804

The object takes the form of:

805

806

{ # Request to cancel an ongoing negotiation.

807

}

808

809

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

816

817

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

818

# account manager for access to Marketplace resources.

819

#

820

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

821

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

822

# are served.

823

#

824

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

825

# Auction or Preferred Deals deals through the API.

826

#

827

# Fields are updatable unless noted otherwise.

Bu Sun Kim

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

[diff] [blame]

828

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

829

#

830

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

831

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

832

# Authorized Buyers account ID.

833

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

834

},

835

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

836

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

837

{ # A proposal may be associated to several notes.

838

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

839

# (max-length: 1024 unicode code units)

840

#

841

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

842

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

843

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

844

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

845

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

846

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

847

},

848

],

849

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

850

# proposal.

851

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

852

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

853

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

854

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

855

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

856

},

857

],

858

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

859

# proposal.

860

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

861

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

862

# left a comment.

863

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

864

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

865

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

866

},

867

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

868

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

869

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

870

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

871

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

872

},

873

],

874

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

875

# Authorized Buyers account ID.

876

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

877

},

878

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

879

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

880

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

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

883

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

884

# targeting information that is used for serving.

Bu Sun Kim

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

[diff] [blame]

885

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

886

# PUBLISHER means creative is provided by seller and ADVERTISER means

887

# creative is provided by buyer.

888

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

889

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

890

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

891

},

892

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

893

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

894

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

895

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

896

# targeting entity is AND'd together.

897

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

898

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

899

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

900

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

901

# together.

902

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

903

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

904

# Filled in when key = GOOG_CREATIVE_SIZE

905

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

906

# of the creative

907

# height depend on the type of the targeting.

908

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

909

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

910

},

911

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

912

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

913

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

914

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

915

"A String",

916

],

917

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

918

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

919

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

920

# height depend on the type of the targeting.

921

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

922

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

923

},

924

],

925

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

926

# creative_size_type = CreativeSizeType.VIDEO.

927

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

928

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

929

# only if creative_size_type = CreativeSizeType.NATIVE.

930

},

931

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

932

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

933

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

934

# Filled in when the key is GOOG_DAYPART_TARGETING.

935

# The definition of this targeting is derived from the structure

936

# used by Ad Manager.

937

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

938

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

939

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

940

# only during certain parts of a day/week.

941

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

942

# The start time is inclusive.

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

},

953

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

954

"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

955

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

956

# for filtering in PQL queries.

957

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

958

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

959

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

960

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

961

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

962

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

963

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

964

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

},

},

],

},

},

],

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

972

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

973

# Third parties may define their own keys.

974

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

975

# provided as part of the external documentation.

976

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

977

# together.

978

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

979

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

980

# Filled in when key = GOOG_CREATIVE_SIZE

981

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

982

# of the creative

983

# height depend on the type of the targeting.

984

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

985

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

986

},

987

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

988

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

989

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

990

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

991

"A String",

992

],

993

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

994

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

995

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

996

# height depend on the type of the targeting.

997

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

998

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

999

},

1000

],

1001

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

1002

# creative_size_type = CreativeSizeType.VIDEO.

1003

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

1004

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

1005

# only if creative_size_type = CreativeSizeType.NATIVE.

1006

},

1007

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

1008

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

1009

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

1010

# Filled in when the key is GOOG_DAYPART_TARGETING.

1011

# The definition of this targeting is derived from the structure

1012

# used by Ad Manager.

1013

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

1014

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

1015

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

1016

# only during certain parts of a day/week.

1017

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

1018

# The start time is inclusive.

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

},

1029

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

1030

"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

1031

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

1032

# for filtering in PQL queries.

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

},

},

],

},

},

],

},

],

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

#

1056

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

1057

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

1058

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

1059

#

1060

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

1061

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

1062

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

1063

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

1064

# deal.

1065

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

1066

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

1067

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

1068

# returned.

1069

#

1070

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

1071

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

Bu Sun Kim

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

[diff] [blame]

1072

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

1073

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

1074

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

1075

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

1076

},

1077

],

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

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

1080

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

1081

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

1082

# time in seconds.

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

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

1085

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

1086

# and expected impressions from the publisher.

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

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

1095

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

1096

# for a matching rule where no buyer is set.

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

},

1109

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

1110

},

1111

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

1112

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

1113

"A String",

1114

],

1115

"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

1116

# (if the

1117

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

1118

# Authorized Buyers account ID.

1119

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

},

},

],

},

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

1125

# Can be set by buyer or seller.

1126

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

1127

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

1128

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

1129

# in this private auction.

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

# for a matching rule where no buyer is set.

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

},

1149

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

1150

},

1151

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

1152

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

1153

"A String",

1154

],

1155

"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

1156

# (if the

1157

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

1158

# Authorized Buyers account ID.

1159

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

1165

# Can be set by buyer or seller.

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

},

1177

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

1178

},

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

# for a matching rule where no buyer is set.

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

},

1208

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

1209

},

1210

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

1211

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

1212

"A String",

1213

],

1214

"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

1215

# (if the

1216

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

1217

# Authorized Buyers account ID.

1218

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

1225

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

1226

# if the user is in the US.

1227

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

1228

# otherwise.

Bu Sun Kim

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

[diff] [blame]

1229

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

1230

# included and excluded numeric IDs.

1231

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

1232

"A String",

1233

],

1234

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

1239

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

1240

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

1241

# and Preferred Deals in Ad Manager.

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

},

1250

],

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

},

],

},

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

1262

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

1263

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

1264

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

1265

"A String",

1266

],

1267

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

1268

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

1273

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

1274

# included and excluded numeric IDs.

1275

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

1276

"A String",

Dan O'Meara

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

[diff] [blame]

1277

],

Bu Sun Kim

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

[diff] [blame]

1278

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

1279

"A String",

Dan O'Meara

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

[diff] [blame]

1280

],

1281

},

Bu Sun Kim

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

[diff] [blame]

1282

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

1283

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

1284

# included and excluded numeric IDs.

1285

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

1286

"A String",

1287

],

1288

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

1293

# included and excluded numeric IDs.

1294

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

1295

"A String",

1296

],

1297

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

1303

# included and excluded numeric IDs.

1304

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

1305

"A String",

1306

],

1307

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

1313

# mobile applications.

1314

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

1315

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

1316

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

1317

# excluded.

1318

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

1319

# apply.

1320

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

1321

"A String",

1322

],

1323

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

"A String",

],

},

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

1328

# This doesn't apply to Auction Packages.

1329

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

1330

# display the ads in.

1331

# publishers own.

1332

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

1333

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

1334

# Google Play Store URL.

1335

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

1336

# First party mobile applications is either included or excluded.

Bu Sun Kim

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

[diff] [blame]

1337

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

1338

"A String",

Dan O'Meara

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

[diff] [blame]

1339

],

Bu Sun Kim

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

[diff] [blame]

1340

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

1341

"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]

1346

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1348

"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]

1349

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1350

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

1351

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1352

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1353

"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]

1354

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

"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]

1356

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1357

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1358

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1359

},

1360

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1361

"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]

1362

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

1364

# finalized. This is the deal ID that shows up in serving/reporting etc.

1365

"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]

1366

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

1367

# in Ad Manager.

1368

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

# This doesn't apply to Private Auction and AdX Preferred Deals.

1370

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

1371

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1372

{ # Represents information for a creative that is associated with a Programmatic

1373

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

1375

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1376

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1377

"sizeType": "A String", # The size type of the ad slot.

1378

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1379

# This field will be present only when size type is `PIXEL`.

1380

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1381

"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]

1382

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1383

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1384

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1385

"sizeType": "A String", # The size type of the ad slot.

1386

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1387

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1392

"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]

1393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1394

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

1395

"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]

1396

# The deal is considered paused if either hasBuyerPaused or

1397

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1398

"firstPausedBy": "A String", # The role of the person who first paused this deal.

1399

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

1400

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

1401

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

1402

"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]

1403

},

1404

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1405

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1406

},

1407

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1408

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1409

# Each update to the proposal or the deal causes the proposal revision number

1410

# to auto-increment. The buyer keeps track of the last revision number they

1411

# know of and pass it in when making an update. If the head revision number

1412

# on the server has since incremented, then an ABORTED error is returned

1413

# during the update operation to let the buyer know that a subsequent update

1414

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1415

"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]

1416

#

1417

# Note: This field may be set only when creating the resource. Modifying

1418

# this field while updating the resource will result in an error.

1419

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1420

"subAccountId": "A String", # Optional sub-account ID for the seller.

1421

"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]

1422

# The seller account ID is then available to buyer in the product.

1423

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</code>

1429

<pre>Update the given proposal to indicate that setup has been completed.

1430

This method is called by the buyer when the line items have been created

1431

on their end for a finalized proposal and all the required creatives

1432

have been uploaded using the creatives API. This call updates the

1433

`is_setup_completed` bit on the proposal and also notifies the seller.

1434

The server will advance the revision number of the most recent proposal.

1435

1436

Args:

1437

accountId: string, Account ID of the buyer. (required)

1438

proposalId: string, The ID of the proposal to mark as setup completed. (required)

1439

body: object, The request body.

1440

The object takes the form of:

1441

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

{ # Request message for indicating that the proposal's setup step is complete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1443

}

1444

1445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1452

1453

{ # Note: this resource requires whitelisting for access. Please contact your

1454

# account manager for access to Marketplace resources.

1455

#

1456

# Represents a proposal in the Marketplace. A proposal is the unit of

1457

# negotiation between a seller and a buyer and contains deals which

1458

# are served.

1459

#

1460

# Note: you can not update, create, or otherwise modify Private

1461

# Auction or Preferred Deals deals through the API.

1462

#

1463

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1464

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

1465

#

1466

# Note: This field may be set only when creating the resource. Modifying

1467

# this field while updating the resource will result in an error.

1468

# Authorized Buyers account ID.

1469

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1470

},

1471

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

1472

"notes": [ # Output only. The notes associated with this proposal.

1473

{ # A proposal may be associated to several notes.

1474

"note": "A String", # The actual note to attach.

1475

# (max-length: 1024 unicode code units)

1476

#

1477

# Note: This field may be set only when creating the resource. Modifying

1478

# this field while updating the resource will result in an error.

1479

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

1480

"noteId": "A String", # Output only. The unique ID for the note.

1481

"createTime": "A String", # Output only. The timestamp for when this note was created.

1482

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

1483

},

1484

],

1485

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1486

# proposal.

1487

"proposalState": "A String", # Output only. The current state of the proposal.

1488

"sellerContacts": [ # Output only. Contact information for the seller.

1489

{ # Contains information on how a buyer or seller can be reached.

1490

"email": "A String", # Email address for the contact.

1491

"name": "A String", # The name of the contact.

1492

},

1493

],

1494

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

1495

# proposal.

1496

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

1497

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

1498

# left a comment.

1499

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

1500

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1501

# operations (max-length: 1024 unicode code units).

1502

},

1503

"displayName": "A String", # The name for the proposal.

1504

"buyerContacts": [ # Contact information for the buyer.

1505

{ # Contains information on how a buyer or seller can be reached.

1506

"email": "A String", # Email address for the contact.

1507

"name": "A String", # The name of the contact.

1508

},

1509

],

1510

"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.

1511

# Authorized Buyers account ID.

1512

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1513

},

1514

"updateTime": "A String", # Output only. The time when the proposal was last revised.

1515

"proposalId": "A String", # Output only. The unique ID of the proposal.

1516

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1517

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

1518

{ # A deal represents a segment of inventory for displaying ads on.

1519

# A proposal can contain multiple deals. A deal contains the terms and

1520

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1521

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

1522

# PUBLISHER means creative is provided by seller and ADVERTISER means

1523

# creative is provided by buyer.

1524

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

1525

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1526

# operations (max-length: 1024 unicode code units).

1527

},

1528

"displayName": "A String", # The name of the deal.

1529

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

1530

"updateTime": "A String", # Output only. The time when the deal was last updated.

1531

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

1532

# targeting entity is AND'd together.

1533

{ # Advertisers can target different attributes of an ad slot. For example,

1534

# they can choose to show ads only if the user is in the U.S. Such

1535

# targeting criteria can be specified as part of Shared Targeting.

1536

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

1537

# together.

1538

{ # A polymorphic targeting value used as part of Shared Targeting.

1539

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1540

# Filled in when key = GOOG_CREATIVE_SIZE

1541

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1542

# of the creative

1543

# height depend on the type of the targeting.

1544

"height": 42, # The height of the creative.

1545

"width": 42, # The width of the creative

1546

},

1547

"allowedFormats": [ # What formats are allowed by the publisher.

1548

# If this repeated field is empty then all formats are allowed.

1549

# For example, if this field contains AllowedFormatType.AUDIO then the

1550

# publisher only allows an audio ad (without any video).

1551

"A String",

1552

],

1553

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1554

# Companion sizes may be filled in only when creative_size_type = VIDEO

1555

{ # Message depicting the size of the creative. The units of width and

1556

# height depend on the type of the targeting.

1557

"height": 42, # The height of the creative.

1558

"width": 42, # The width of the creative

1559

},

1560

],

1561

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1562

# creative_size_type = CreativeSizeType.VIDEO.

1563

"creativeSizeType": "A String", # The creative size type.

1564

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1565

# only if creative_size_type = CreativeSizeType.NATIVE.

1566

},

1567

"stringValue": "A String", # The string value to include/exclude.

1568

"longValue": "A String", # The long value to include/exclude.

1569

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1570

# Filled in when the key is GOOG_DAYPART_TARGETING.

1571

# The definition of this targeting is derived from the structure

1572

# used by Ad Manager.

1573

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1574

"dayParts": [ # A list of day part targeting criterion.

1575

{ # Daypart targeting message that specifies if the ad can be shown

1576

# only during certain parts of a day/week.

1577

"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).

1578

# The start time is inclusive.

1579

# This field is not available for filtering in PQL queries.

1580

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1581

# types are google.type.Date and `google.protobuf.Timestamp`.

1582

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1583

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1584

# to allow the value "24:00:00" for scenarios like business closing time.

1585

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1586

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1587

# allow the value 60 if it allows leap-seconds.

1588

},

1589

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

1590

"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

1591

# granularity). The end time is exclusive. This field is not available

1592

# for filtering in PQL queries.

1593

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1594

# types are google.type.Date and `google.protobuf.Timestamp`.

1595

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1596

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1597

# to allow the value "24:00:00" for scenarios like business closing time.

1598

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1599

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1600

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

1608

# Targeting criteria defined by Google ad servers will begin with GOOG_.

1609

# Third parties may define their own keys.

1610

# A list of permissible keys along with the acceptable values will be

1611

# provided as part of the external documentation.

1612

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

1613

# together.

1614

{ # A polymorphic targeting value used as part of Shared Targeting.

1615

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1616

# Filled in when key = GOOG_CREATIVE_SIZE

1617

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1618

# of the creative

1619

# height depend on the type of the targeting.

1620

"height": 42, # The height of the creative.

1621

"width": 42, # The width of the creative

1622

},

1623

"allowedFormats": [ # What formats are allowed by the publisher.

1624

# If this repeated field is empty then all formats are allowed.

1625

# For example, if this field contains AllowedFormatType.AUDIO then the

1626

# publisher only allows an audio ad (without any video).

1627

"A String",

1628

],

1629

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1630

# Companion sizes may be filled in only when creative_size_type = VIDEO

1631

{ # Message depicting the size of the creative. The units of width and

1632

# height depend on the type of the targeting.

1633

"height": 42, # The height of the creative.

1634

"width": 42, # The width of the creative

1635

},

1636

],

1637

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1638

# creative_size_type = CreativeSizeType.VIDEO.

1639

"creativeSizeType": "A String", # The creative size type.

1640

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1641

# only if creative_size_type = CreativeSizeType.NATIVE.

1642

},

1643

"stringValue": "A String", # The string value to include/exclude.

1644

"longValue": "A String", # The long value to include/exclude.

1645

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1646

# Filled in when the key is GOOG_DAYPART_TARGETING.

1647

# The definition of this targeting is derived from the structure

1648

# used by Ad Manager.

1649

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1650

"dayParts": [ # A list of day part targeting criterion.

1651

{ # Daypart targeting message that specifies if the ad can be shown

1652

# only during certain parts of a day/week.

1653

"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).

1654

# The start time is inclusive.

1655

# This field is not available for filtering in PQL queries.

1656

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1657

# types are google.type.Date and `google.protobuf.Timestamp`.

1658

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1659

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1660

# to allow the value "24:00:00" for scenarios like business closing time.

1661

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1662

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1663

# allow the value 60 if it allows leap-seconds.

1664

},

1665

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

1666

"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

1667

# granularity). The end time is exclusive. This field is not available

1668

# for filtering in PQL queries.

1669

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1670

# types are google.type.Date and `google.protobuf.Timestamp`.

1671

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1672

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1673

# to allow the value "24:00:00" for scenarios like business closing time.

1674

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1675

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1676

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

1686

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

1687

"availableEndTime": "A String", # Proposed flight end time of the deal.

1688

# This will generally be stored in a granularity of a second.

1689

# A value is not required for Private Auction deals or Preferred Deals.

1690

"syndicationProduct": "A String", # The syndication product associated with the deal.

1691

#

1692

# Note: This field may be set only when creating the resource. Modifying

1693

# this field while updating the resource will result in an error.

1694

"createProductId": "A String", # The product ID from which this deal was created.

1695

#

1696

# Note: This field may be set only when creating the resource. Modifying

1697

# this field while updating the resource will result in an error.

1698

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

1699

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1700

# deal.

1701

"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]

1702

# If present on create, and the server `product_revision` has advanced sinced

1703

# the passed-in `create_product_revision`, an `ABORTED` error will be

1704

# returned.

1705

#

1706

# Note: This field may be set only when creating the resource. Modifying

1707

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1708

"sellerContacts": [ # Output only. Seller contact information for the deal.

1709

{ # Contains information on how a buyer or seller can be reached.

1710

"email": "A String", # Email address for the contact.

1711

"name": "A String", # The name of the contact.

1712

},

1713

],

1714

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1715

# This will generally be stored in the granularity of one second since deal

1716

# serving starts at seconds boundary. Any time specified with more

1717

# granularity (e.g., in milliseconds) will be truncated towards the start of

1718

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1719

"createTime": "A String", # Output only. The time of the deal creation.

1720

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

1721

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

1722

# and expected impressions from the publisher.

1723

"description": "A String", # Publisher provided description for the terms.

1724

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

1725

# the API at this time, but can be returned in a get or list request.

1726

"fixedPrices": [ # Fixed price for the specified buyer.

1727

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1728

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1729

# a particular buyer or buyer/advertiser pair, we look for the most specific

1730

# matching rule - we first look for a rule matching the buyer and advertiser,

1731

# next a rule with the buyer but an empty advertiser list, and otherwise look

1732

# for a matching rule where no buyer is set.

1733

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1734

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1735

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1736

"nanos": 42, # Number of nano (10^-9) units of the amount.

1737

# The value must be between -999,999,999 and +999,999,999 inclusive.

1738

# If `units` is positive, `nanos` must be positive or zero.

1739

# If `units` is zero, `nanos` can be positive, zero, or negative.

1740

# If `units` is negative, `nanos` must be negative or zero.

1741

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1742

"units": "A String", # The whole units of the amount.

1743

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1744

},

1745

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1746

},

1747

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1748

# If empty, all advertisers with this buyer pay this price.

1749

"A String",

1750

],

1751

"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

1752

# (if the

1753

# advertisers match, and there's no more specific rule matching the buyer).

1754

# Authorized Buyers account ID.

1755

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

1761

# Can be set by buyer or seller.

1762

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

1763

# by the seller, but they can be returned in a get or list request.

1764

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

1765

# in this private auction.

1766

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

1767

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1768

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1769

# a particular buyer or buyer/advertiser pair, we look for the most specific

1770

# matching rule - we first look for a rule matching the buyer and advertiser,

1771

# next a rule with the buyer but an empty advertiser list, and otherwise look

1772

# for a matching rule where no buyer is set.

1773

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1774

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1775

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1776

"nanos": 42, # Number of nano (10^-9) units of the amount.

1777

# The value must be between -999,999,999 and +999,999,999 inclusive.

1778

# If `units` is positive, `nanos` must be positive or zero.

1779

# If `units` is zero, `nanos` can be positive, zero, or negative.

1780

# If `units` is negative, `nanos` must be negative or zero.

1781

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1782

"units": "A String", # The whole units of the amount.

1783

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1784

},

1785

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1786

},

1787

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1788

# If empty, all advertisers with this buyer pay this price.

1789

"A String",

1790

],

1791

"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

1792

# (if the

1793

# advertisers match, and there's no more specific rule matching the buyer).

1794

# Authorized Buyers account ID.

1795

"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.

1801

# Can be set by buyer or seller.

1802

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1803

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1804

"nanos": 42, # Number of nano (10^-9) units of the amount.

1805

# The value must be between -999,999,999 and +999,999,999 inclusive.

1806

# If `units` is positive, `nanos` must be positive or zero.

1807

# If `units` is zero, `nanos` can be positive, zero, or negative.

1808

# If `units` is negative, `nanos` must be negative or zero.

1809

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1810

"units": "A String", # The whole units of the amount.

1811

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1812

},

1813

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1814

},

1815

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

1816

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

1817

# time zone used to mark the boundaries of a day. It should be an

1818

# IANA TZ name, such as "America/Los_Angeles". For more information,

1819

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

1820

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

1821

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

1822

# of guaranteed looks that the buyer is guaranteeing to buy.

1823

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

1824

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

1825

"fixedPrices": [ # Fixed price for the specified buyer.

1826

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1827

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1828

# a particular buyer or buyer/advertiser pair, we look for the most specific

1829

# matching rule - we first look for a rule matching the buyer and advertiser,

1830

# next a rule with the buyer but an empty advertiser list, and otherwise look

1831

# for a matching rule where no buyer is set.

1832

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1833

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1834

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1835

"nanos": 42, # Number of nano (10^-9) units of the amount.

1836

# The value must be between -999,999,999 and +999,999,999 inclusive.

1837

# If `units` is positive, `nanos` must be positive or zero.

1838

# If `units` is zero, `nanos` can be positive, zero, or negative.

1839

# If `units` is negative, `nanos` must be negative or zero.

1840

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1841

"units": "A String", # The whole units of the amount.

1842

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1843

},

1844

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1845

},

1846

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1847

# If empty, all advertisers with this buyer pay this price.

1848

"A String",

1849

],

1850

"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

1851

# (if the

1852

# advertisers match, and there's no more specific rule matching the buyer).

1853

# Authorized Buyers account ID.

1854

"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]

1861

# target ad inventory. For example, they can choose to target ad requests only

1862

# if the user is in the US.

1863

# Multiple types of targeting are always applied as a logical AND, unless noted

1864

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

1866

# included and excluded numeric IDs.

1867

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1868

"A String",

1869

],

1870

"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.

1875

# request. It only applies to Private Auction, AdX Preferred Deals and

1876

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

1877

# and Preferred Deals in Ad Manager.

1878

"targetedInventorySizes": [ # A list of inventory sizes to be included.

1879

{ # Represents size of a single ad slot, or a creative.

1880

"width": "A String", # The width of the ad slot in pixels.

1881

# This field will be present only when size type is `PIXEL`.

1882

"sizeType": "A String", # The size type of the ad slot.

1883

"height": "A String", # The height of the ad slot in pixels.

1884

# This field will be present only when size type is `PIXEL`.

1885

},

1886

],

1887

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

1888

{ # Represents size of a single ad slot, or a creative.

1889

"width": "A String", # The width of the ad slot in pixels.

1890

# This field will be present only when size type is `PIXEL`.

1891

"sizeType": "A String", # The size type of the ad slot.

1892

"height": "A String", # The height of the ad slot in pixels.

1893

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

1898

"targetedPositionTypes": [ # A list of video positions to be included.

1899

# When the included list is present, the excluded list must be empty.

1900

# When the excluded list is present, the included list must be empty.

1901

"A String",

1902

],

1903

"excludedPositionTypes": [ # A list of video positions to be excluded.

1904

# 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.

1909

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

1910

# included and excluded numeric IDs.

1911

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1912

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1913

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1914

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1915

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1916

],

1917

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1918

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

1919

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

1920

# included and excluded numeric IDs.

1921

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1922

"A String",

1923

],

1924

"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.

1929

# included and excluded numeric IDs.

1930

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1931

"A String",

1932

],

1933

"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.

1939

# included and excluded numeric IDs.

1940

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1941

"A String",

1942

],

1943

"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.

1949

# mobile applications.

1950

# Different placement targeting types will be logically OR'ed.

1951

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

1952

# For Private Auction and AdX Preferred Deals, URLs are either included or

1953

# excluded.

1954

# For Programmatic Guaranteed and Preferred Deals, this doesn't

1955

# apply.

1956

"targetedUrls": [ # A list of URLs to be included.

1957

"A String",

1958

],

1959

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

1964

# This doesn't apply to Auction Packages.

1965

"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]

1966

# display the ads in.

1967

# publishers own.

1968

# Mobile application IDs are from App Store and Google Play Store.

1969

# Android App ID, for example, com.google.android.apps.maps, can be found in

1970

# Google Play Store URL.

1971

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

1972

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1973

"targetedAppIds": [ # A list of application IDs to be included.

1974

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1975

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1976

"excludedAppIds": [ # A list of application IDs to be excluded.

1977

"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]

1982

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1983

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1984

"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]

1985

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1986

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

1987

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1988

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1989

"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]

1990

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1991

"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]

1992

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1993

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1994

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1995

},

1996

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1997

"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]

1998

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1999

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2000

# finalized. This is the deal ID that shows up in serving/reporting etc.

2001

"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]

2002

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2003

# in Ad Manager.

2004

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2005

# This doesn't apply to Private Auction and AdX Preferred Deals.

2006

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2007

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2008

{ # Represents information for a creative that is associated with a Programmatic

2009

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2010

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2011

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2012

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2013

"sizeType": "A String", # The size type of the ad slot.

2014

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2015

# This field will be present only when size type is `PIXEL`.

2016

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2017

"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]

2018

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2019

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2020

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2021

"sizeType": "A String", # The size type of the ad slot.

2022

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2023

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2028

"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]

2029

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2030

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2031

"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]

2032

# The deal is considered paused if either hasBuyerPaused or

2033

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2034

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2035

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2036

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2037

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2038

"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]

2039

},

2040

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2041

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2042

},

2043

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2044

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2045

# Each update to the proposal or the deal causes the proposal revision number

2046

# to auto-increment. The buyer keeps track of the last revision number they

2047

# know of and pass it in when making an update. If the head revision number

2048

# on the server has since incremented, then an ABORTED error is returned

2049

# during the update operation to let the buyer know that a subsequent update

2050

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2051

"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]

2052

#

2053

# Note: This field may be set only when creating the resource. Modifying

2054

# this field while updating the resource will result in an error.

2055

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

"subAccountId": "A String", # Optional sub-account ID for the seller.

2057

"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]

2058

# The seller account ID is then available to buyer in the product.

2059

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2064

<code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2065

<pre>Create the given proposal. Each created proposal and any deals it contains

2066

are assigned a unique ID by the server.

2067

2068

Args:

2069

accountId: string, Account ID of the buyer. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2070

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2071

The object takes the form of:

2072

2073

{ # Note: this resource requires whitelisting for access. Please contact your

2074

# account manager for access to Marketplace resources.

2075

#

2076

# Represents a proposal in the Marketplace. A proposal is the unit of

2077

# negotiation between a seller and a buyer and contains deals which

2078

# are served.

2079

#

2080

# Note: you can not update, create, or otherwise modify Private

2081

# Auction or Preferred Deals deals through the API.

2082

#

2083

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2084

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2085

#

2086

# Note: This field may be set only when creating the resource. Modifying

2087

# this field while updating the resource will result in an error.

2088

# Authorized Buyers account ID.

2089

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2090

},

2091

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2092

"notes": [ # Output only. The notes associated with this proposal.

2093

{ # A proposal may be associated to several notes.

2094

"note": "A String", # The actual note to attach.

2095

# (max-length: 1024 unicode code units)

2096

#

2097

# Note: This field may be set only when creating the resource. Modifying

2098

# this field while updating the resource will result in an error.

2099

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2100

"noteId": "A String", # Output only. The unique ID for the note.

2101

"createTime": "A String", # Output only. The timestamp for when this note was created.

2102

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2103

},

2104

],

2105

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2106

# proposal.

2107

"proposalState": "A String", # Output only. The current state of the proposal.

2108

"sellerContacts": [ # Output only. Contact information for the seller.

2109

{ # Contains information on how a buyer or seller can be reached.

2110

"email": "A String", # Email address for the contact.

2111

"name": "A String", # The name of the contact.

2112

},

2113

],

2114

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2115

# proposal.

2116

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2117

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2118

# left a comment.

2119

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2120

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2121

# operations (max-length: 1024 unicode code units).

2122

},

2123

"displayName": "A String", # The name for the proposal.

2124

"buyerContacts": [ # Contact information for the buyer.

2125

{ # Contains information on how a buyer or seller can be reached.

2126

"email": "A String", # Email address for the contact.

2127

"name": "A String", # The name of the contact.

2128

},

2129

],

2130

"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.

2131

# Authorized Buyers account ID.

2132

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2133

},

2134

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2135

"proposalId": "A String", # Output only. The unique ID of the proposal.

2136

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2137

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2138

{ # A deal represents a segment of inventory for displaying ads on.

2139

# A proposal can contain multiple deals. A deal contains the terms and

2140

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2141

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2142

# PUBLISHER means creative is provided by seller and ADVERTISER means

2143

# creative is provided by buyer.

2144

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2145

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2146

# operations (max-length: 1024 unicode code units).

2147

},

2148

"displayName": "A String", # The name of the deal.

2149

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

2150

"updateTime": "A String", # Output only. The time when the deal was last updated.

2151

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2152

# targeting entity is AND'd together.

2153

{ # Advertisers can target different attributes of an ad slot. For example,

2154

# they can choose to show ads only if the user is in the U.S. Such

2155

# targeting criteria can be specified as part of Shared Targeting.

2156

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2157

# together.

2158

{ # A polymorphic targeting value used as part of Shared Targeting.

2159

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2160

# Filled in when key = GOOG_CREATIVE_SIZE

2161

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2162

# of the creative

2163

# height depend on the type of the targeting.

2164

"height": 42, # The height of the creative.

2165

"width": 42, # The width of the creative

2166

},

2167

"allowedFormats": [ # What formats are allowed by the publisher.

2168

# If this repeated field is empty then all formats are allowed.

2169

# For example, if this field contains AllowedFormatType.AUDIO then the

2170

# publisher only allows an audio ad (without any video).

2171

"A String",

2172

],

2173

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2174

# Companion sizes may be filled in only when creative_size_type = VIDEO

2175

{ # Message depicting the size of the creative. The units of width and

2176

# height depend on the type of the targeting.

2177

"height": 42, # The height of the creative.

2178

"width": 42, # The width of the creative

2179

},

2180

],

2181

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2182

# creative_size_type = CreativeSizeType.VIDEO.

2183

"creativeSizeType": "A String", # The creative size type.

2184

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2185

# only if creative_size_type = CreativeSizeType.NATIVE.

2186

},

2187

"stringValue": "A String", # The string value to include/exclude.

2188

"longValue": "A String", # The long value to include/exclude.

2189

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2190

# Filled in when the key is GOOG_DAYPART_TARGETING.

2191

# The definition of this targeting is derived from the structure

2192

# used by Ad Manager.

2193

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2194

"dayParts": [ # A list of day part targeting criterion.

2195

{ # Daypart targeting message that specifies if the ad can be shown

2196

# only during certain parts of a day/week.

2197

"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).

2198

# The start time is inclusive.

2199

# This field is not available for filtering in PQL queries.

2200

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2201

# types are google.type.Date and `google.protobuf.Timestamp`.

2202

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2203

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2204

# to allow the value "24:00:00" for scenarios like business closing time.

2205

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2206

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2207

# allow the value 60 if it allows leap-seconds.

2208

},

2209

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2210

"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

2211

# granularity). The end time is exclusive. This field is not available

2212

# for filtering in PQL queries.

2213

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2214

# types are google.type.Date and `google.protobuf.Timestamp`.

2215

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2216

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2217

# to allow the value "24:00:00" for scenarios like business closing time.

2218

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2219

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2220

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

2228

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2229

# Third parties may define their own keys.

2230

# A list of permissible keys along with the acceptable values will be

2231

# provided as part of the external documentation.

2232

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2233

# together.

2234

{ # A polymorphic targeting value used as part of Shared Targeting.

2235

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2236

# Filled in when key = GOOG_CREATIVE_SIZE

2237

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2238

# of the creative

2239

# height depend on the type of the targeting.

2240

"height": 42, # The height of the creative.

2241

"width": 42, # The width of the creative

2242

},

2243

"allowedFormats": [ # What formats are allowed by the publisher.

2244

# If this repeated field is empty then all formats are allowed.

2245

# For example, if this field contains AllowedFormatType.AUDIO then the

2246

# publisher only allows an audio ad (without any video).

2247

"A String",

2248

],

2249

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2250

# Companion sizes may be filled in only when creative_size_type = VIDEO

2251

{ # Message depicting the size of the creative. The units of width and

2252

# height depend on the type of the targeting.

2253

"height": 42, # The height of the creative.

2254

"width": 42, # The width of the creative

2255

},

2256

],

2257

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2258

# creative_size_type = CreativeSizeType.VIDEO.

2259

"creativeSizeType": "A String", # The creative size type.

2260

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2261

# only if creative_size_type = CreativeSizeType.NATIVE.

2262

},

2263

"stringValue": "A String", # The string value to include/exclude.

2264

"longValue": "A String", # The long value to include/exclude.

2265

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2266

# Filled in when the key is GOOG_DAYPART_TARGETING.

2267

# The definition of this targeting is derived from the structure

2268

# used by Ad Manager.

2269

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2270

"dayParts": [ # A list of day part targeting criterion.

2271

{ # Daypart targeting message that specifies if the ad can be shown

2272

# only during certain parts of a day/week.

2273

"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).

2274

# The start time is inclusive.

2275

# This field is not available for filtering in PQL queries.

2276

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2277

# types are google.type.Date and `google.protobuf.Timestamp`.

2278

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2279

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2280

# to allow the value "24:00:00" for scenarios like business closing time.

2281

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2282

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2283

# allow the value 60 if it allows leap-seconds.

2284

},

2285

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2286

"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

2287

# granularity). The end time is exclusive. This field is not available

2288

# for filtering in PQL queries.

2289

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2290

# types are google.type.Date and `google.protobuf.Timestamp`.

2291

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2292

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2293

# to allow the value "24:00:00" for scenarios like business closing time.

2294

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2295

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2296

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2306

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

2307

"availableEndTime": "A String", # Proposed flight end time of the deal.

2308

# This will generally be stored in a granularity of a second.

2309

# A value is not required for Private Auction deals or Preferred Deals.

2310

"syndicationProduct": "A String", # The syndication product associated with the deal.

2311

#

2312

# Note: This field may be set only when creating the resource. Modifying

2313

# this field while updating the resource will result in an error.

2314

"createProductId": "A String", # The product ID from which this deal was created.

2315

#

2316

# Note: This field may be set only when creating the resource. Modifying

2317

# this field while updating the resource will result in an error.

2318

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2319

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2320

# deal.

2321

"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]

2322

# If present on create, and the server `product_revision` has advanced sinced

2323

# the passed-in `create_product_revision`, an `ABORTED` error will be

2324

# returned.

2325

#

2326

# Note: This field may be set only when creating the resource. Modifying

2327

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2328

"sellerContacts": [ # Output only. Seller contact information for the deal.

2329

{ # Contains information on how a buyer or seller can be reached.

2330

"email": "A String", # Email address for the contact.

2331

"name": "A String", # The name of the contact.

2332

},

2333

],

2334

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2335

# This will generally be stored in the granularity of one second since deal

2336

# serving starts at seconds boundary. Any time specified with more

2337

# granularity (e.g., in milliseconds) will be truncated towards the start of

2338

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2339

"createTime": "A String", # Output only. The time of the deal creation.

2340

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2341

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2342

# and expected impressions from the publisher.

2343

"description": "A String", # Publisher provided description for the terms.

2344

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2345

# the API at this time, but can be returned in a get or list request.

2346

"fixedPrices": [ # Fixed price for the specified buyer.

2347

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2348

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2349

# a particular buyer or buyer/advertiser pair, we look for the most specific

2350

# matching rule - we first look for a rule matching the buyer and advertiser,

2351

# next a rule with the buyer but an empty advertiser list, and otherwise look

2352

# for a matching rule where no buyer is set.

2353

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2354

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2355

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2356

"nanos": 42, # Number of nano (10^-9) units of the amount.

2357

# The value must be between -999,999,999 and +999,999,999 inclusive.

2358

# If `units` is positive, `nanos` must be positive or zero.

2359

# If `units` is zero, `nanos` can be positive, zero, or negative.

2360

# If `units` is negative, `nanos` must be negative or zero.

2361

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2362

"units": "A String", # The whole units of the amount.

2363

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2364

},

2365

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2366

},

2367

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2368

# If empty, all advertisers with this buyer pay this price.

2369

"A String",

2370

],

2371

"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

2372

# (if the

2373

# advertisers match, and there's no more specific rule matching the buyer).

2374

# Authorized Buyers account ID.

2375

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2381

# Can be set by buyer or seller.

2382

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

2383

# by the seller, but they can be returned in a get or list request.

2384

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

2385

# in this private auction.

2386

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

2387

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2388

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2389

# a particular buyer or buyer/advertiser pair, we look for the most specific

2390

# matching rule - we first look for a rule matching the buyer and advertiser,

2391

# next a rule with the buyer but an empty advertiser list, and otherwise look

2392

# for a matching rule where no buyer is set.

2393

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2394

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2395

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2396

"nanos": 42, # Number of nano (10^-9) units of the amount.

2397

# The value must be between -999,999,999 and +999,999,999 inclusive.

2398

# If `units` is positive, `nanos` must be positive or zero.

2399

# If `units` is zero, `nanos` can be positive, zero, or negative.

2400

# If `units` is negative, `nanos` must be negative or zero.

2401

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2402

"units": "A String", # The whole units of the amount.

2403

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2404

},

2405

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2406

},

2407

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2408

# If empty, all advertisers with this buyer pay this price.

2409

"A String",

2410

],

2411

"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

2412

# (if the

2413

# advertisers match, and there's no more specific rule matching the buyer).

2414

# Authorized Buyers account ID.

2415

"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.

2421

# Can be set by buyer or seller.

2422

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2423

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2424

"nanos": 42, # Number of nano (10^-9) units of the amount.

2425

# The value must be between -999,999,999 and +999,999,999 inclusive.

2426

# If `units` is positive, `nanos` must be positive or zero.

2427

# If `units` is zero, `nanos` can be positive, zero, or negative.

2428

# If `units` is negative, `nanos` must be negative or zero.

2429

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2430

"units": "A String", # The whole units of the amount.

2431

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2432

},

2433

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2434

},

2435

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

2436

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2437

# time zone used to mark the boundaries of a day. It should be an

2438

# IANA TZ name, such as "America/Los_Angeles". For more information,

2439

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

2440

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2441

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2442

# of guaranteed looks that the buyer is guaranteeing to buy.

2443

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

2444

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2445

"fixedPrices": [ # Fixed price for the specified buyer.

2446

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2447

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2448

# a particular buyer or buyer/advertiser pair, we look for the most specific

2449

# matching rule - we first look for a rule matching the buyer and advertiser,

2450

# next a rule with the buyer but an empty advertiser list, and otherwise look

2451

# for a matching rule where no buyer is set.

2452

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2453

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2454

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2455

"nanos": 42, # Number of nano (10^-9) units of the amount.

2456

# The value must be between -999,999,999 and +999,999,999 inclusive.

2457

# If `units` is positive, `nanos` must be positive or zero.

2458

# If `units` is zero, `nanos` can be positive, zero, or negative.

2459

# If `units` is negative, `nanos` must be negative or zero.

2460

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2461

"units": "A String", # The whole units of the amount.

2462

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2463

},

2464

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2465

},

2466

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2467

# If empty, all advertisers with this buyer pay this price.

2468

"A String",

2469

],

2470

"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

2471

# (if the

2472

# advertisers match, and there's no more specific rule matching the buyer).

2473

# Authorized Buyers account ID.

2474

"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]

2481

# target ad inventory. For example, they can choose to target ad requests only

2482

# if the user is in the US.

2483

# Multiple types of targeting are always applied as a logical AND, unless noted

2484

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2485

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2486

# included and excluded numeric IDs.

2487

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2488

"A String",

2489

],

2490

"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.

2495

# request. It only applies to Private Auction, AdX Preferred Deals and

2496

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2497

# and Preferred Deals in Ad Manager.

2498

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2499

{ # Represents size of a single ad slot, or a creative.

2500

"width": "A String", # The width of the ad slot in pixels.

2501

# This field will be present only when size type is `PIXEL`.

2502

"sizeType": "A String", # The size type of the ad slot.

2503

"height": "A String", # The height of the ad slot in pixels.

2504

# This field will be present only when size type is `PIXEL`.

2505

},

2506

],

2507

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2508

{ # Represents size of a single ad slot, or a creative.

2509

"width": "A String", # The width of the ad slot in pixels.

2510

# This field will be present only when size type is `PIXEL`.

2511

"sizeType": "A String", # The size type of the ad slot.

2512

"height": "A String", # The height of the ad slot in pixels.

2513

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2518

"targetedPositionTypes": [ # A list of video positions to be included.

2519

# When the included list is present, the excluded list must be empty.

2520

# When the excluded list is present, the included list must be empty.

2521

"A String",

2522

],

2523

"excludedPositionTypes": [ # A list of video positions to be excluded.

2524

# 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.

2529

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2530

# included and excluded numeric IDs.

2531

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2532

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2533

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2534

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2535

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2536

],

2537

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2538

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2539

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2540

# included and excluded numeric IDs.

2541

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2542

"A String",

2543

],

2544

"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.

2549

# included and excluded numeric IDs.

2550

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2551

"A String",

2552

],

2553

"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.

2559

# included and excluded numeric IDs.

2560

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2561

"A String",

2562

],

2563

"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.

2569

# mobile applications.

2570

# Different placement targeting types will be logically OR'ed.

2571

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2572

# For Private Auction and AdX Preferred Deals, URLs are either included or

2573

# excluded.

2574

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2575

# apply.

2576

"targetedUrls": [ # A list of URLs to be included.

2577

"A String",

2578

],

2579

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2584

# This doesn't apply to Auction Packages.

2585

"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]

2586

# display the ads in.

2587

# publishers own.

2588

# Mobile application IDs are from App Store and Google Play Store.

2589

# Android App ID, for example, com.google.android.apps.maps, can be found in

2590

# Google Play Store URL.

2591

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2592

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2593

"targetedAppIds": [ # A list of application IDs to be included.

2594

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2595

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2596

"excludedAppIds": [ # A list of application IDs to be excluded.

2597

"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]

2602

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2603

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2604

"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]

2605

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2606

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

2607

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2608

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2609

"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]

2610

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2611

"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]

2612

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2613

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2614

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2615

},

2616

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2617

"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]

2618

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2619

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2620

# finalized. This is the deal ID that shows up in serving/reporting etc.

2621

"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]

2622

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2623

# in Ad Manager.

2624

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2625

# This doesn't apply to Private Auction and AdX Preferred Deals.

2626

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2627

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2628

{ # Represents information for a creative that is associated with a Programmatic

2629

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2630

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2631

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2632

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2633

"sizeType": "A String", # The size type of the ad slot.

2634

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2635

# This field will be present only when size type is `PIXEL`.

2636

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2637

"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]

2638

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2640

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2641

"sizeType": "A String", # The size type of the ad slot.

2642

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2643

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2648

"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]

2649

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2650

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2651

"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]

2652

# The deal is considered paused if either hasBuyerPaused or

2653

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2654

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2655

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2656

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2657

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2658

"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]

2659

},

2660

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2661

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2662

},

2663

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2664

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2665

# Each update to the proposal or the deal causes the proposal revision number

2666

# to auto-increment. The buyer keeps track of the last revision number they

2667

# know of and pass it in when making an update. If the head revision number

2668

# on the server has since incremented, then an ABORTED error is returned

2669

# during the update operation to let the buyer know that a subsequent update

2670

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2671

"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]

2672

#

2673

# Note: This field may be set only when creating the resource. Modifying

2674

# this field while updating the resource will result in an error.

2675

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2676

"subAccountId": "A String", # Optional sub-account ID for the seller.

2677

"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]

2678

# The seller account ID is then available to buyer in the product.

2679

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2680

}

2681

2682

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2689

2690

{ # Note: this resource requires whitelisting for access. Please contact your

2691

# account manager for access to Marketplace resources.

2692

#

2693

# Represents a proposal in the Marketplace. A proposal is the unit of

2694

# negotiation between a seller and a buyer and contains deals which

2695

# are served.

2696

#

2697

# Note: you can not update, create, or otherwise modify Private

2698

# Auction or Preferred Deals deals through the API.

2699

#

2700

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2701

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2702

#

2703

# Note: This field may be set only when creating the resource. Modifying

2704

# this field while updating the resource will result in an error.

2705

# Authorized Buyers account ID.

2706

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2707

},

2708

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2709

"notes": [ # Output only. The notes associated with this proposal.

2710

{ # A proposal may be associated to several notes.

2711

"note": "A String", # The actual note to attach.

2712

# (max-length: 1024 unicode code units)

2713

#

2714

# Note: This field may be set only when creating the resource. Modifying

2715

# this field while updating the resource will result in an error.

2716

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2717

"noteId": "A String", # Output only. The unique ID for the note.

2718

"createTime": "A String", # Output only. The timestamp for when this note was created.

2719

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2720

},

2721

],

2722

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2723

# proposal.

2724

"proposalState": "A String", # Output only. The current state of the proposal.

2725

"sellerContacts": [ # Output only. Contact information for the seller.

2726

{ # Contains information on how a buyer or seller can be reached.

2727

"email": "A String", # Email address for the contact.

2728

"name": "A String", # The name of the contact.

2729

},

2730

],

2731

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2732

# proposal.

2733

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2734

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2735

# left a comment.

2736

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2737

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2738

# operations (max-length: 1024 unicode code units).

2739

},

2740

"displayName": "A String", # The name for the proposal.

2741

"buyerContacts": [ # Contact information for the buyer.

2742

{ # Contains information on how a buyer or seller can be reached.

2743

"email": "A String", # Email address for the contact.

2744

"name": "A String", # The name of the contact.

2745

},

2746

],

2747

"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.

2748

# Authorized Buyers account ID.

2749

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2750

},

2751

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2752

"proposalId": "A String", # Output only. The unique ID of the proposal.

2753

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2754

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2755

{ # A deal represents a segment of inventory for displaying ads on.

2756

# A proposal can contain multiple deals. A deal contains the terms and

2757

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2758

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2759

# PUBLISHER means creative is provided by seller and ADVERTISER means

2760

# creative is provided by buyer.

2761

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2762

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2763

# operations (max-length: 1024 unicode code units).

2764

},

2765

"displayName": "A String", # The name of the deal.

2766

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

2767

"updateTime": "A String", # Output only. The time when the deal was last updated.

2768

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2769

# targeting entity is AND'd together.

2770

{ # Advertisers can target different attributes of an ad slot. For example,

2771

# they can choose to show ads only if the user is in the U.S. Such

2772

# targeting criteria can be specified as part of Shared Targeting.

2773

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2774

# together.

2775

{ # A polymorphic targeting value used as part of Shared Targeting.

2776

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2777

# Filled in when key = GOOG_CREATIVE_SIZE

2778

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2779

# of the creative

2780

# height depend on the type of the targeting.

2781

"height": 42, # The height of the creative.

2782

"width": 42, # The width of the creative

2783

},

2784

"allowedFormats": [ # What formats are allowed by the publisher.

2785

# If this repeated field is empty then all formats are allowed.

2786

# For example, if this field contains AllowedFormatType.AUDIO then the

2787

# publisher only allows an audio ad (without any video).

2788

"A String",

2789

],

2790

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2791

# Companion sizes may be filled in only when creative_size_type = VIDEO

2792

{ # Message depicting the size of the creative. The units of width and

2793

# height depend on the type of the targeting.

2794

"height": 42, # The height of the creative.

2795

"width": 42, # The width of the creative

2796

},

2797

],

2798

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2799

# creative_size_type = CreativeSizeType.VIDEO.

2800

"creativeSizeType": "A String", # The creative size type.

2801

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2802

# only if creative_size_type = CreativeSizeType.NATIVE.

2803

},

2804

"stringValue": "A String", # The string value to include/exclude.

2805

"longValue": "A String", # The long value to include/exclude.

2806

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2807

# Filled in when the key is GOOG_DAYPART_TARGETING.

2808

# The definition of this targeting is derived from the structure

2809

# used by Ad Manager.

2810

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2811

"dayParts": [ # A list of day part targeting criterion.

2812

{ # Daypart targeting message that specifies if the ad can be shown

2813

# only during certain parts of a day/week.

2814

"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).

2815

# The start time is inclusive.

2816

# This field is not available for filtering in PQL queries.

2817

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2818

# types are google.type.Date and `google.protobuf.Timestamp`.

2819

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2820

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2821

# to allow the value "24:00:00" for scenarios like business closing time.

2822

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2823

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2824

# allow the value 60 if it allows leap-seconds.

2825

},

2826

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2827

"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

2828

# granularity). The end time is exclusive. This field is not available

2829

# for filtering in PQL queries.

2830

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2831

# types are google.type.Date and `google.protobuf.Timestamp`.

2832

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2833

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2834

# to allow the value "24:00:00" for scenarios like business closing time.

2835

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2836

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2837

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

2845

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2846

# Third parties may define their own keys.

2847

# A list of permissible keys along with the acceptable values will be

2848

# provided as part of the external documentation.

2849

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2850

# together.

2851

{ # A polymorphic targeting value used as part of Shared Targeting.

2852

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2853

# Filled in when key = GOOG_CREATIVE_SIZE

2854

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2855

# of the creative

2856

# height depend on the type of the targeting.

2857

"height": 42, # The height of the creative.

2858

"width": 42, # The width of the creative

2859

},

2860

"allowedFormats": [ # What formats are allowed by the publisher.

2861

# If this repeated field is empty then all formats are allowed.

2862

# For example, if this field contains AllowedFormatType.AUDIO then the

2863

# publisher only allows an audio ad (without any video).

2864

"A String",

2865

],

2866

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2867

# Companion sizes may be filled in only when creative_size_type = VIDEO

2868

{ # Message depicting the size of the creative. The units of width and

2869

# height depend on the type of the targeting.

2870

"height": 42, # The height of the creative.

2871

"width": 42, # The width of the creative

2872

},

2873

],

2874

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2875

# creative_size_type = CreativeSizeType.VIDEO.

2876

"creativeSizeType": "A String", # The creative size type.

2877

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2878

# only if creative_size_type = CreativeSizeType.NATIVE.

2879

},

2880

"stringValue": "A String", # The string value to include/exclude.

2881

"longValue": "A String", # The long value to include/exclude.

2882

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2883

# Filled in when the key is GOOG_DAYPART_TARGETING.

2884

# The definition of this targeting is derived from the structure

2885

# used by Ad Manager.

2886

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2887

"dayParts": [ # A list of day part targeting criterion.

2888

{ # Daypart targeting message that specifies if the ad can be shown

2889

# only during certain parts of a day/week.

2890

"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).

2891

# The start time is inclusive.

2892

# This field is not available for filtering in PQL queries.

2893

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2894

# types are google.type.Date and `google.protobuf.Timestamp`.

2895

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2896

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2897

# to allow the value "24:00:00" for scenarios like business closing time.

2898

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2899

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2900

# allow the value 60 if it allows leap-seconds.

2901

},

2902

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2903

"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

2904

# granularity). The end time is exclusive. This field is not available

2905

# for filtering in PQL queries.

2906

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2907

# types are google.type.Date and `google.protobuf.Timestamp`.

2908

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2909

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2910

# to allow the value "24:00:00" for scenarios like business closing time.

2911

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2912

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2913

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2923

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

2924

"availableEndTime": "A String", # Proposed flight end time of the deal.

2925

# This will generally be stored in a granularity of a second.

2926

# A value is not required for Private Auction deals or Preferred Deals.

2927

"syndicationProduct": "A String", # The syndication product associated with the deal.

2928

#

2929

# Note: This field may be set only when creating the resource. Modifying

2930

# this field while updating the resource will result in an error.

2931

"createProductId": "A String", # The product ID from which this deal was created.

2932

#

2933

# Note: This field may be set only when creating the resource. Modifying

2934

# this field while updating the resource will result in an error.

2935

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2936

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2937

# deal.

2938

"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]

2939

# If present on create, and the server `product_revision` has advanced sinced

2940

# the passed-in `create_product_revision`, an `ABORTED` error will be

2941

# returned.

2942

#

2943

# Note: This field may be set only when creating the resource. Modifying

2944

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2945

"sellerContacts": [ # Output only. Seller contact information for the deal.

2946

{ # Contains information on how a buyer or seller can be reached.

2947

"email": "A String", # Email address for the contact.

2948

"name": "A String", # The name of the contact.

2949

},

2950

],

2951

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2952

# This will generally be stored in the granularity of one second since deal

2953

# serving starts at seconds boundary. Any time specified with more

2954

# granularity (e.g., in milliseconds) will be truncated towards the start of

2955

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2956

"createTime": "A String", # Output only. The time of the deal creation.

2957

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2958

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2959

# and expected impressions from the publisher.

2960

"description": "A String", # Publisher provided description for the terms.

2961

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2962

# the API at this time, but can be returned in a get or list request.

2963

"fixedPrices": [ # Fixed price for the specified buyer.

2964

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2965

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2966

# a particular buyer or buyer/advertiser pair, we look for the most specific

2967

# matching rule - we first look for a rule matching the buyer and advertiser,

2968

# next a rule with the buyer but an empty advertiser list, and otherwise look

2969

# for a matching rule where no buyer is set.

2970

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2971

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2972

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2973

"nanos": 42, # Number of nano (10^-9) units of the amount.

2974

# The value must be between -999,999,999 and +999,999,999 inclusive.

2975

# If `units` is positive, `nanos` must be positive or zero.

2976

# If `units` is zero, `nanos` can be positive, zero, or negative.

2977

# If `units` is negative, `nanos` must be negative or zero.

2978

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2979

"units": "A String", # The whole units of the amount.

2980

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2981

},

2982

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2983

},

2984

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2985

# If empty, all advertisers with this buyer pay this price.

2986

"A String",

2987

],

2988

"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

2989

# (if the

2990

# advertisers match, and there's no more specific rule matching the buyer).

2991

# Authorized Buyers account ID.

2992

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2998

# Can be set by buyer or seller.

2999

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3000

# by the seller, but they can be returned in a get or list request.

3001

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

3002

# in this private auction.

3003

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3004

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3005

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3006

# a particular buyer or buyer/advertiser pair, we look for the most specific

3007

# matching rule - we first look for a rule matching the buyer and advertiser,

3008

# next a rule with the buyer but an empty advertiser list, and otherwise look

3009

# for a matching rule where no buyer is set.

3010

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3011

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3012

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3013

"nanos": 42, # Number of nano (10^-9) units of the amount.

3014

# The value must be between -999,999,999 and +999,999,999 inclusive.

3015

# If `units` is positive, `nanos` must be positive or zero.

3016

# If `units` is zero, `nanos` can be positive, zero, or negative.

3017

# If `units` is negative, `nanos` must be negative or zero.

3018

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3019

"units": "A String", # The whole units of the amount.

3020

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3021

},

3022

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3023

},

3024

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3025

# If empty, all advertisers with this buyer pay this price.

3026

"A String",

3027

],

3028

"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

3029

# (if the

3030

# advertisers match, and there's no more specific rule matching the buyer).

3031

# Authorized Buyers account ID.

3032

"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.

3038

# Can be set by buyer or seller.

3039

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3040

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3041

"nanos": 42, # Number of nano (10^-9) units of the amount.

3042

# The value must be between -999,999,999 and +999,999,999 inclusive.

3043

# If `units` is positive, `nanos` must be positive or zero.

3044

# If `units` is zero, `nanos` can be positive, zero, or negative.

3045

# If `units` is negative, `nanos` must be negative or zero.

3046

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3047

"units": "A String", # The whole units of the amount.

3048

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3049

},

3050

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3051

},

3052

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3053

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3054

# time zone used to mark the boundaries of a day. It should be an

3055

# IANA TZ name, such as "America/Los_Angeles". For more information,

3056

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

3057

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3058

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3059

# of guaranteed looks that the buyer is guaranteeing to buy.

3060

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

3061

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3062

"fixedPrices": [ # Fixed price for the specified buyer.

3063

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3064

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3065

# a particular buyer or buyer/advertiser pair, we look for the most specific

3066

# matching rule - we first look for a rule matching the buyer and advertiser,

3067

# next a rule with the buyer but an empty advertiser list, and otherwise look

3068

# for a matching rule where no buyer is set.

3069

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3070

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3071

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3072

"nanos": 42, # Number of nano (10^-9) units of the amount.

3073

# The value must be between -999,999,999 and +999,999,999 inclusive.

3074

# If `units` is positive, `nanos` must be positive or zero.

3075

# If `units` is zero, `nanos` can be positive, zero, or negative.

3076

# If `units` is negative, `nanos` must be negative or zero.

3077

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3078

"units": "A String", # The whole units of the amount.

3079

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3080

},

3081

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3082

},

3083

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3084

# If empty, all advertisers with this buyer pay this price.

3085

"A String",

3086

],

3087

"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

3088

# (if the

3089

# advertisers match, and there's no more specific rule matching the buyer).

3090

# Authorized Buyers account ID.

3091

"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]

3098

# target ad inventory. For example, they can choose to target ad requests only

3099

# if the user is in the US.

3100

# Multiple types of targeting are always applied as a logical AND, unless noted

3101

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3102

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3103

# included and excluded numeric IDs.

3104

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3105

"A String",

3106

],

3107

"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.

3112

# request. It only applies to Private Auction, AdX Preferred Deals and

3113

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3114

# and Preferred Deals in Ad Manager.

3115

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3116

{ # Represents size of a single ad slot, or a creative.

3117

"width": "A String", # The width of the ad slot in pixels.

3118

# This field will be present only when size type is `PIXEL`.

3119

"sizeType": "A String", # The size type of the ad slot.

3120

"height": "A String", # The height of the ad slot in pixels.

3121

# This field will be present only when size type is `PIXEL`.

3122

},

3123

],

3124

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3125

{ # Represents size of a single ad slot, or a creative.

3126

"width": "A String", # The width of the ad slot in pixels.

3127

# This field will be present only when size type is `PIXEL`.

3128

"sizeType": "A String", # The size type of the ad slot.

3129

"height": "A String", # The height of the ad slot in pixels.

3130

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3135

"targetedPositionTypes": [ # A list of video positions to be included.

3136

# When the included list is present, the excluded list must be empty.

3137

# When the excluded list is present, the included list must be empty.

3138

"A String",

3139

],

3140

"excludedPositionTypes": [ # A list of video positions to be excluded.

3141

# 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.

3146

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3147

# included and excluded numeric IDs.

3148

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3149

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3150

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3151

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3152

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3153

],

3154

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3155

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3156

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3157

# included and excluded numeric IDs.

3158

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3159

"A String",

3160

],

3161

"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.

3166

# included and excluded numeric IDs.

3167

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3168

"A String",

3169

],

3170

"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.

3176

# included and excluded numeric IDs.

3177

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3178

"A String",

3179

],

3180

"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.

3186

# mobile applications.

3187

# Different placement targeting types will be logically OR'ed.

3188

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3189

# For Private Auction and AdX Preferred Deals, URLs are either included or

3190

# excluded.

3191

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3192

# apply.

3193

"targetedUrls": [ # A list of URLs to be included.

3194

"A String",

3195

],

3196

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3201

# This doesn't apply to Auction Packages.

3202

"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]

3203

# display the ads in.

3204

# publishers own.

3205

# Mobile application IDs are from App Store and Google Play Store.

3206

# Android App ID, for example, com.google.android.apps.maps, can be found in

3207

# Google Play Store URL.

3208

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3209

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3210

"targetedAppIds": [ # A list of application IDs to be included.

3211

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3212

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3213

"excludedAppIds": [ # A list of application IDs to be excluded.

3214

"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]

3219

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3220

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3221

"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]

3222

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3223

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

3224

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3225

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3226

"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]

3227

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

"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]

3229

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3231

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3232

},

3233

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3234

"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]

3235

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3236

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3237

# finalized. This is the deal ID that shows up in serving/reporting etc.

3238

"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]

3239

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

3240

# in Ad Manager.

3241

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3242

# This doesn't apply to Private Auction and AdX Preferred Deals.

3243

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

3244

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3245

{ # Represents information for a creative that is associated with a Programmatic

3246

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3247

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

3248

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3249

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3250

"sizeType": "A String", # The size type of the ad slot.

3251

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3252

# This field will be present only when size type is `PIXEL`.

3253

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3254

"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]

3255

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3256

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3257

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3258

"sizeType": "A String", # The size type of the ad slot.

3259

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3260

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3265

"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]

3266

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3267

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3268

"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]

3269

# The deal is considered paused if either hasBuyerPaused or

3270

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3271

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3272

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3273

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

3274

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3275

"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]

3276

},

3277

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3278

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3279

},

3280

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3281

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3282

# Each update to the proposal or the deal causes the proposal revision number

3283

# to auto-increment. The buyer keeps track of the last revision number they

3284

# know of and pass it in when making an update. If the head revision number

3285

# on the server has since incremented, then an ABORTED error is returned

3286

# during the update operation to let the buyer know that a subsequent update

3287

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"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]

3289

#

3290

# Note: This field may be set only when creating the resource. Modifying

3291

# this field while updating the resource will result in an error.

3292

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3293

"subAccountId": "A String", # Optional sub-account ID for the seller.

3294

"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]

3295

# The seller account ID is then available to buyer in the product.

3296

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(accountId, proposalId, x__xgafv=None)</code>

3302

<pre>Gets a proposal given its ID. The proposal is returned at its head

revision.

Args:

accountId: string, Account ID of the buyer. (required)

3307

proposalId: string, The unique ID of the proposal (required)

3308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3315

3316

{ # Note: this resource requires whitelisting for access. Please contact your

3317

# account manager for access to Marketplace resources.

3318

#

3319

# Represents a proposal in the Marketplace. A proposal is the unit of

3320

# negotiation between a seller and a buyer and contains deals which

3321

# are served.

3322

#

3323

# Note: you can not update, create, or otherwise modify Private

3324

# Auction or Preferred Deals deals through the API.

3325

#

3326

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3327

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3328

#

3329

# Note: This field may be set only when creating the resource. Modifying

3330

# this field while updating the resource will result in an error.

3331

# Authorized Buyers account ID.

3332

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3333

},

3334

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3335

"notes": [ # Output only. The notes associated with this proposal.

3336

{ # A proposal may be associated to several notes.

3337

"note": "A String", # The actual note to attach.

3338

# (max-length: 1024 unicode code units)

3339

#

3340

# Note: This field may be set only when creating the resource. Modifying

3341

# this field while updating the resource will result in an error.

3342

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3343

"noteId": "A String", # Output only. The unique ID for the note.

3344

"createTime": "A String", # Output only. The timestamp for when this note was created.

3345

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3346

},

3347

],

3348

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3349

# proposal.

3350

"proposalState": "A String", # Output only. The current state of the proposal.

3351

"sellerContacts": [ # Output only. Contact information for the seller.

3352

{ # Contains information on how a buyer or seller can be reached.

3353

"email": "A String", # Email address for the contact.

3354

"name": "A String", # The name of the contact.

3355

},

3356

],

3357

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3358

# proposal.

3359

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

3360

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3361

# left a comment.

3362

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3363

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3364

# operations (max-length: 1024 unicode code units).

3365

},

3366

"displayName": "A String", # The name for the proposal.

3367

"buyerContacts": [ # Contact information for the buyer.

3368

{ # Contains information on how a buyer or seller can be reached.

3369

"email": "A String", # Email address for the contact.

3370

"name": "A String", # The name of the contact.

3371

},

3372

],

3373

"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.

3374

# Authorized Buyers account ID.

3375

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3376

},

3377

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3378

"proposalId": "A String", # Output only. The unique ID of the proposal.

3379

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3380

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3381

{ # A deal represents a segment of inventory for displaying ads on.

3382

# A proposal can contain multiple deals. A deal contains the terms and

3383

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3384

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3385

# PUBLISHER means creative is provided by seller and ADVERTISER means

3386

# creative is provided by buyer.

3387

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3388

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3389

# operations (max-length: 1024 unicode code units).

3390

},

3391

"displayName": "A String", # The name of the deal.

3392

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

3393

"updateTime": "A String", # Output only. The time when the deal was last updated.

3394

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3395

# targeting entity is AND'd together.

3396

{ # Advertisers can target different attributes of an ad slot. For example,

3397

# they can choose to show ads only if the user is in the U.S. Such

3398

# targeting criteria can be specified as part of Shared Targeting.

3399

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3400

# together.

3401

{ # A polymorphic targeting value used as part of Shared Targeting.

3402

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3403

# Filled in when key = GOOG_CREATIVE_SIZE

3404

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3405

# of the creative

3406

# height depend on the type of the targeting.

3407

"height": 42, # The height of the creative.

3408

"width": 42, # The width of the creative

3409

},

3410

"allowedFormats": [ # What formats are allowed by the publisher.

3411

# If this repeated field is empty then all formats are allowed.

3412

# For example, if this field contains AllowedFormatType.AUDIO then the

3413

# publisher only allows an audio ad (without any video).

3414

"A String",

3415

],

3416

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3417

# Companion sizes may be filled in only when creative_size_type = VIDEO

3418

{ # Message depicting the size of the creative. The units of width and

3419

# height depend on the type of the targeting.

3420

"height": 42, # The height of the creative.

3421

"width": 42, # The width of the creative

3422

},

3423

],

3424

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3425

# creative_size_type = CreativeSizeType.VIDEO.

3426

"creativeSizeType": "A String", # The creative size type.

3427

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3428

# only if creative_size_type = CreativeSizeType.NATIVE.

3429

},

3430

"stringValue": "A String", # The string value to include/exclude.

3431

"longValue": "A String", # The long value to include/exclude.

3432

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3433

# Filled in when the key is GOOG_DAYPART_TARGETING.

3434

# The definition of this targeting is derived from the structure

3435

# used by Ad Manager.

3436

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3437

"dayParts": [ # A list of day part targeting criterion.

3438

{ # Daypart targeting message that specifies if the ad can be shown

3439

# only during certain parts of a day/week.

3440

"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).

3441

# The start time is inclusive.

3442

# This field is not available for filtering in PQL queries.

3443

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3444

# types are google.type.Date and `google.protobuf.Timestamp`.

3445

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3446

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3447

# to allow the value "24:00:00" for scenarios like business closing time.

3448

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3449

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3450

# allow the value 60 if it allows leap-seconds.

3451

},

3452

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3453

"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

3454

# granularity). The end time is exclusive. This field is not available

3455

# for filtering in PQL queries.

3456

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3457

# types are google.type.Date and `google.protobuf.Timestamp`.

3458

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3459

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3460

# to allow the value "24:00:00" for scenarios like business closing time.

3461

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3462

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3463

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

3471

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3472

# Third parties may define their own keys.

3473

# A list of permissible keys along with the acceptable values will be

3474

# provided as part of the external documentation.

3475

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

3476

# together.

3477

{ # A polymorphic targeting value used as part of Shared Targeting.

3478

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3479

# Filled in when key = GOOG_CREATIVE_SIZE

3480

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3481

# of the creative

3482

# height depend on the type of the targeting.

3483

"height": 42, # The height of the creative.

3484

"width": 42, # The width of the creative

3485

},

3486

"allowedFormats": [ # What formats are allowed by the publisher.

3487

# If this repeated field is empty then all formats are allowed.

3488

# For example, if this field contains AllowedFormatType.AUDIO then the

3489

# publisher only allows an audio ad (without any video).

3490

"A String",

3491

],

3492

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3493

# Companion sizes may be filled in only when creative_size_type = VIDEO

3494

{ # Message depicting the size of the creative. The units of width and

3495

# height depend on the type of the targeting.

3496

"height": 42, # The height of the creative.

3497

"width": 42, # The width of the creative

3498

},

3499

],

3500

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3501

# creative_size_type = CreativeSizeType.VIDEO.

3502

"creativeSizeType": "A String", # The creative size type.

3503

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3504

# only if creative_size_type = CreativeSizeType.NATIVE.

3505

},

3506

"stringValue": "A String", # The string value to include/exclude.

3507

"longValue": "A String", # The long value to include/exclude.

3508

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3509

# Filled in when the key is GOOG_DAYPART_TARGETING.

3510

# The definition of this targeting is derived from the structure

3511

# used by Ad Manager.

3512

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3513

"dayParts": [ # A list of day part targeting criterion.

3514

{ # Daypart targeting message that specifies if the ad can be shown

3515

# only during certain parts of a day/week.

3516

"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).

3517

# The start time is inclusive.

3518

# This field is not available for filtering in PQL queries.

3519

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3520

# types are google.type.Date and `google.protobuf.Timestamp`.

3521

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3522

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3523

# to allow the value "24:00:00" for scenarios like business closing time.

3524

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3525

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3526

# allow the value 60 if it allows leap-seconds.

3527

},

3528

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3529

"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

3530

# granularity). The end time is exclusive. This field is not available

3531

# for filtering in PQL queries.

3532

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3533

# types are google.type.Date and `google.protobuf.Timestamp`.

3534

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3535

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3536

# to allow the value "24:00:00" for scenarios like business closing time.

3537

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3538

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3539

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

3549

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

3550

"availableEndTime": "A String", # Proposed flight end time of the deal.

3551

# This will generally be stored in a granularity of a second.

3552

# A value is not required for Private Auction deals or Preferred Deals.

3553

"syndicationProduct": "A String", # The syndication product associated with the deal.

3554

#

3555

# Note: This field may be set only when creating the resource. Modifying

3556

# this field while updating the resource will result in an error.

3557

"createProductId": "A String", # The product ID from which this deal was created.

3558

#

3559

# Note: This field may be set only when creating the resource. Modifying

3560

# this field while updating the resource will result in an error.

3561

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3562

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3563

# deal.

3564

"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]

3565

# If present on create, and the server `product_revision` has advanced sinced

3566

# the passed-in `create_product_revision`, an `ABORTED` error will be

3567

# returned.

3568

#

3569

# Note: This field may be set only when creating the resource. Modifying

3570

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3571

"sellerContacts": [ # Output only. Seller contact information for the deal.

3572

{ # Contains information on how a buyer or seller can be reached.

3573

"email": "A String", # Email address for the contact.

3574

"name": "A String", # The name of the contact.

3575

},

3576

],

3577

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3578

# This will generally be stored in the granularity of one second since deal

3579

# serving starts at seconds boundary. Any time specified with more

3580

# granularity (e.g., in milliseconds) will be truncated towards the start of

3581

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

"createTime": "A String", # Output only. The time of the deal creation.

3583

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

3584

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

3585

# and expected impressions from the publisher.

3586

"description": "A String", # Publisher provided description for the terms.

3587

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3588

# the API at this time, but can be returned in a get or list request.

3589

"fixedPrices": [ # Fixed price for the specified buyer.

3590

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3591

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3592

# a particular buyer or buyer/advertiser pair, we look for the most specific

3593

# matching rule - we first look for a rule matching the buyer and advertiser,

3594

# next a rule with the buyer but an empty advertiser list, and otherwise look

3595

# for a matching rule where no buyer is set.

3596

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3597

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3598

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3599

"nanos": 42, # Number of nano (10^-9) units of the amount.

3600

# The value must be between -999,999,999 and +999,999,999 inclusive.

3601

# If `units` is positive, `nanos` must be positive or zero.

3602

# If `units` is zero, `nanos` can be positive, zero, or negative.

3603

# If `units` is negative, `nanos` must be negative or zero.

3604

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3605

"units": "A String", # The whole units of the amount.

3606

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3607

},

3608

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3609

},

3610

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3611

# If empty, all advertisers with this buyer pay this price.

3612

"A String",

3613

],

3614

"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

3615

# (if the

3616

# advertisers match, and there's no more specific rule matching the buyer).

3617

# Authorized Buyers account ID.

3618

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

3624

# Can be set by buyer or seller.

3625

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3626

# by the seller, but they can be returned in a get or list request.

3627

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

3628

# in this private auction.

3629

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3630

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3631

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3632

# a particular buyer or buyer/advertiser pair, we look for the most specific

3633

# matching rule - we first look for a rule matching the buyer and advertiser,

3634

# next a rule with the buyer but an empty advertiser list, and otherwise look

3635

# for a matching rule where no buyer is set.

3636

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3637

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3638

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3639

"nanos": 42, # Number of nano (10^-9) units of the amount.

3640

# The value must be between -999,999,999 and +999,999,999 inclusive.

3641

# If `units` is positive, `nanos` must be positive or zero.

3642

# If `units` is zero, `nanos` can be positive, zero, or negative.

3643

# If `units` is negative, `nanos` must be negative or zero.

3644

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3645

"units": "A String", # The whole units of the amount.

3646

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3647

},

3648

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3649

},

3650

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3651

# If empty, all advertisers with this buyer pay this price.

3652

"A String",

3653

],

3654

"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

3655

# (if the

3656

# advertisers match, and there's no more specific rule matching the buyer).

3657

# Authorized Buyers account ID.

3658

"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.

3664

# Can be set by buyer or seller.

3665

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3666

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3667

"nanos": 42, # Number of nano (10^-9) units of the amount.

3668

# The value must be between -999,999,999 and +999,999,999 inclusive.

3669

# If `units` is positive, `nanos` must be positive or zero.

3670

# If `units` is zero, `nanos` can be positive, zero, or negative.

3671

# If `units` is negative, `nanos` must be negative or zero.

3672

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3673

"units": "A String", # The whole units of the amount.

3674

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3675

},

3676

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3677

},

3678

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3679

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3680

# time zone used to mark the boundaries of a day. It should be an

3681

# IANA TZ name, such as "America/Los_Angeles". For more information,

3682

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

3683

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3684

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3685

# of guaranteed looks that the buyer is guaranteeing to buy.

3686

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

3687

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3688

"fixedPrices": [ # Fixed price for the specified buyer.

3689

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3690

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3691

# a particular buyer or buyer/advertiser pair, we look for the most specific

3692

# matching rule - we first look for a rule matching the buyer and advertiser,

3693

# next a rule with the buyer but an empty advertiser list, and otherwise look

3694

# for a matching rule where no buyer is set.

3695

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3696

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3697

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3698

"nanos": 42, # Number of nano (10^-9) units of the amount.

3699

# The value must be between -999,999,999 and +999,999,999 inclusive.

3700

# If `units` is positive, `nanos` must be positive or zero.

3701

# If `units` is zero, `nanos` can be positive, zero, or negative.

3702

# If `units` is negative, `nanos` must be negative or zero.

3703

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3704

"units": "A String", # The whole units of the amount.

3705

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3706

},

3707

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3708

},

3709

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3710

# If empty, all advertisers with this buyer pay this price.

3711

"A String",

3712

],

3713

"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

3714

# (if the

3715

# advertisers match, and there's no more specific rule matching the buyer).

3716

# Authorized Buyers account ID.

3717

"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]

3724

# target ad inventory. For example, they can choose to target ad requests only

3725

# if the user is in the US.

3726

# Multiple types of targeting are always applied as a logical AND, unless noted

3727

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3728

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3729

# included and excluded numeric IDs.

3730

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3731

"A String",

3732

],

3733

"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.

3738

# request. It only applies to Private Auction, AdX Preferred Deals and

3739

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3740

# and Preferred Deals in Ad Manager.

3741

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3742

{ # Represents size of a single ad slot, or a creative.

3743

"width": "A String", # The width of the ad slot in pixels.

3744

# This field will be present only when size type is `PIXEL`.

3745

"sizeType": "A String", # The size type of the ad slot.

3746

"height": "A String", # The height of the ad slot in pixels.

3747

# This field will be present only when size type is `PIXEL`.

3748

},

3749

],

3750

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3751

{ # Represents size of a single ad slot, or a creative.

3752

"width": "A String", # The width of the ad slot in pixels.

3753

# This field will be present only when size type is `PIXEL`.

3754

"sizeType": "A String", # The size type of the ad slot.

3755

"height": "A String", # The height of the ad slot in pixels.

3756

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3761

"targetedPositionTypes": [ # A list of video positions to be included.

3762

# When the included list is present, the excluded list must be empty.

3763

# When the excluded list is present, the included list must be empty.

3764

"A String",

3765

],

3766

"excludedPositionTypes": [ # A list of video positions to be excluded.

3767

# 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.

3772

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3773

# included and excluded numeric IDs.

3774

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3775

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3776

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3777

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3778

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3779

],

3780

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3781

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3782

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3783

# included and excluded numeric IDs.

3784

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3785

"A String",

3786

],

3787

"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.

3792

# included and excluded numeric IDs.

3793

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3794

"A String",

3795

],

3796

"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.

3802

# included and excluded numeric IDs.

3803

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3804

"A String",

3805

],

3806

"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.

3812

# mobile applications.

3813

# Different placement targeting types will be logically OR'ed.

3814

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3815

# For Private Auction and AdX Preferred Deals, URLs are either included or

3816

# excluded.

3817

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3818

# apply.

3819

"targetedUrls": [ # A list of URLs to be included.

3820

"A String",

3821

],

3822

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3827

# This doesn't apply to Auction Packages.

3828

"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]

3829

# display the ads in.

3830

# publishers own.

3831

# Mobile application IDs are from App Store and Google Play Store.

3832

# Android App ID, for example, com.google.android.apps.maps, can be found in

3833

# Google Play Store URL.

3834

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3835

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3836

"targetedAppIds": [ # A list of application IDs to be included.

3837

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3838

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3839

"excludedAppIds": [ # A list of application IDs to be excluded.

3840

"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]

3845

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3846

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3847

"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]

3848

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3849

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

3850

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3851

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3852

"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]

3853

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3854

"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]

3855

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3856

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3857

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3858

},

3859

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3860

"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]

3861

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3862

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3863

# finalized. This is the deal ID that shows up in serving/reporting etc.

3864

"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]

3865

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

3866

# in Ad Manager.

3867

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3868

# This doesn't apply to Private Auction and AdX Preferred Deals.

3869

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

3870

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3871

{ # Represents information for a creative that is associated with a Programmatic

3872

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3873

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

3874

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3875

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3876

"sizeType": "A String", # The size type of the ad slot.

3877

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3878

# This field will be present only when size type is `PIXEL`.

3879

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3880

"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]

3881

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3882

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3883

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3884

"sizeType": "A String", # The size type of the ad slot.

3885

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3886

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3891

"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]

3892

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3893

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3894

"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]

3895

# The deal is considered paused if either hasBuyerPaused or

3896

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3897

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3898

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3899

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

3900

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3901

"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]

3902

},

3903

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3904

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3905

},

3906

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3907

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3908

# Each update to the proposal or the deal causes the proposal revision number

3909

# to auto-increment. The buyer keeps track of the last revision number they

3910

# know of and pass it in when making an update. If the head revision number

3911

# on the server has since incremented, then an ABORTED error is returned

3912

# during the update operation to let the buyer know that a subsequent update

3913

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3914

"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]

3915

#

3916

# Note: This field may be set only when creating the resource. Modifying

3917

# this field while updating the resource will result in an error.

3918

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3919

"subAccountId": "A String", # Optional sub-account ID for the seller.

3920

"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]

3921

# The seller account ID is then available to buyer in the product.

3922

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3927

<code class="details" id="list">list(accountId, filter=None, pageToken=None, pageSize=None, filterSyntax=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3928

<pre>List proposals. A filter expression (PQL query) may be specified to

3929

filter the results. To retrieve all finalized proposals, regardless if a

3930

proposal is being renegotiated, see the FinalizedProposals resource.

3931

Note that Bidder/ChildSeat relationships differ from the usual behavior.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3932

A Bidder account can only see its child seats' proposals by specifying

3933

the ChildSeat's accountId in the request path.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3934

3935

Args:

3936

accountId: string, Account ID of the buyer. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3937

filter: string, An optional PQL filter query used to query for proposals.

3938

3939

Nested repeated fields, such as proposal.deals.targetingCriterion,

3940

cannot be filtered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

pageToken: string, The page token as returned from ListProposalsResponse.

3942

pageSize: integer, Requested page size. The server may return fewer results than requested.

3943

If unspecified, the server will pick an appropriate default.

3944

filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL

3945

but in the future it will be LIST_FILTER.

3946

x__xgafv: string, V1 error format.

3947

Allowed values

3948

1 - v1 error format

3949

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3950

3951

Returns:

3952

An object of the form:

3953

3954

{ # Response message for listing proposals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3955

"nextPageToken": "A String", # Continuation token for fetching the next page of results.

3956

"proposals": [ # The list of proposals.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3957

{ # Note: this resource requires whitelisting for access. Please contact your

3958

# account manager for access to Marketplace resources.

3959

#

3960

# Represents a proposal in the Marketplace. A proposal is the unit of

3961

# negotiation between a seller and a buyer and contains deals which

3962

# are served.

3963

#

3964

# Note: you can not update, create, or otherwise modify Private

3965

# Auction or Preferred Deals deals through the API.

3966

#

3967

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3968

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3969

#

3970

# Note: This field may be set only when creating the resource. Modifying

3971

# this field while updating the resource will result in an error.

3972

# Authorized Buyers account ID.

3973

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3974

},

3975

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3976

"notes": [ # Output only. The notes associated with this proposal.

3977

{ # A proposal may be associated to several notes.

3978

"note": "A String", # The actual note to attach.

3979

# (max-length: 1024 unicode code units)

3980

#

3981

# Note: This field may be set only when creating the resource. Modifying

3982

# this field while updating the resource will result in an error.

3983

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3984

"noteId": "A String", # Output only. The unique ID for the note.

3985

"createTime": "A String", # Output only. The timestamp for when this note was created.

3986

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3987

},

3988

],

3989

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3990

# proposal.

3991

"proposalState": "A String", # Output only. The current state of the proposal.

3992

"sellerContacts": [ # Output only. Contact information for the seller.

3993

{ # Contains information on how a buyer or seller can be reached.

3994

"email": "A String", # Email address for the contact.

3995

"name": "A String", # The name of the contact.

3996

},

3997

],

3998

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3999

# proposal.

4000

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

4001

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

4002

# left a comment.

4003

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

4004

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4005

# operations (max-length: 1024 unicode code units).

4006

},

4007

"displayName": "A String", # The name for the proposal.

4008

"buyerContacts": [ # Contact information for the buyer.

4009

{ # Contains information on how a buyer or seller can be reached.

4010

"email": "A String", # Email address for the contact.

4011

"name": "A String", # The name of the contact.

4012

},

4013

],

4014

"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.

4015

# Authorized Buyers account ID.

4016

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4017

},

4018

"updateTime": "A String", # Output only. The time when the proposal was last revised.

4019

"proposalId": "A String", # Output only. The unique ID of the proposal.

4020

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4021

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4022

{ # A deal represents a segment of inventory for displaying ads on.

4023

# A proposal can contain multiple deals. A deal contains the terms and

4024

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4025

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4026

# PUBLISHER means creative is provided by seller and ADVERTISER means

4027

# creative is provided by buyer.

4028

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4029

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4030

# operations (max-length: 1024 unicode code units).

4031

},

4032

"displayName": "A String", # The name of the deal.

4033

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

4034

"updateTime": "A String", # Output only. The time when the deal was last updated.

4035

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4036

# targeting entity is AND'd together.

4037

{ # Advertisers can target different attributes of an ad slot. For example,

4038

# they can choose to show ads only if the user is in the U.S. Such

4039

# targeting criteria can be specified as part of Shared Targeting.

4040

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4041

# together.

4042

{ # A polymorphic targeting value used as part of Shared Targeting.

4043

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4044

# Filled in when key = GOOG_CREATIVE_SIZE

4045

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4046

# of the creative

4047

# height depend on the type of the targeting.

4048

"height": 42, # The height of the creative.

4049

"width": 42, # The width of the creative

4050

},

4051

"allowedFormats": [ # What formats are allowed by the publisher.

4052

# If this repeated field is empty then all formats are allowed.

4053

# For example, if this field contains AllowedFormatType.AUDIO then the

4054

# publisher only allows an audio ad (without any video).

4055

"A String",

4056

],

4057

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4058

# Companion sizes may be filled in only when creative_size_type = VIDEO

4059

{ # Message depicting the size of the creative. The units of width and

4060

# height depend on the type of the targeting.

4061

"height": 42, # The height of the creative.

4062

"width": 42, # The width of the creative

4063

},

4064

],

4065

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4066

# creative_size_type = CreativeSizeType.VIDEO.

4067

"creativeSizeType": "A String", # The creative size type.

4068

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4069

# only if creative_size_type = CreativeSizeType.NATIVE.

4070

},

4071

"stringValue": "A String", # The string value to include/exclude.

4072

"longValue": "A String", # The long value to include/exclude.

4073

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4074

# Filled in when the key is GOOG_DAYPART_TARGETING.

4075

# The definition of this targeting is derived from the structure

4076

# used by Ad Manager.

4077

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4078

"dayParts": [ # A list of day part targeting criterion.

4079

{ # Daypart targeting message that specifies if the ad can be shown

4080

# only during certain parts of a day/week.

4081

"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).

4082

# The start time is inclusive.

4083

# This field is not available for filtering in PQL queries.

4084

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4085

# types are google.type.Date and `google.protobuf.Timestamp`.

4086

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4087

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4088

# to allow the value "24:00:00" for scenarios like business closing time.

4089

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4090

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4091

# allow the value 60 if it allows leap-seconds.

4092

},

4093

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4094

"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

4095

# granularity). The end time is exclusive. This field is not available

4096

# for filtering in PQL queries.

4097

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4098

# types are google.type.Date and `google.protobuf.Timestamp`.

4099

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4100

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4101

# to allow the value "24:00:00" for scenarios like business closing time.

4102

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4103

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4104

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

4112

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4113

# Third parties may define their own keys.

4114

# A list of permissible keys along with the acceptable values will be

4115

# provided as part of the external documentation.

4116

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4117

# together.

4118

{ # A polymorphic targeting value used as part of Shared Targeting.

4119

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4120

# Filled in when key = GOOG_CREATIVE_SIZE

4121

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4122

# of the creative

4123

# height depend on the type of the targeting.

4124

"height": 42, # The height of the creative.

4125

"width": 42, # The width of the creative

4126

},

4127

"allowedFormats": [ # What formats are allowed by the publisher.

4128

# If this repeated field is empty then all formats are allowed.

4129

# For example, if this field contains AllowedFormatType.AUDIO then the

4130

# publisher only allows an audio ad (without any video).

4131

"A String",

4132

],

4133

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4134

# Companion sizes may be filled in only when creative_size_type = VIDEO

4135

{ # Message depicting the size of the creative. The units of width and

4136

# height depend on the type of the targeting.

4137

"height": 42, # The height of the creative.

4138

"width": 42, # The width of the creative

4139

},

4140

],

4141

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4142

# creative_size_type = CreativeSizeType.VIDEO.

4143

"creativeSizeType": "A String", # The creative size type.

4144

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4145

# only if creative_size_type = CreativeSizeType.NATIVE.

4146

},

4147

"stringValue": "A String", # The string value to include/exclude.

4148

"longValue": "A String", # The long value to include/exclude.

4149

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4150

# Filled in when the key is GOOG_DAYPART_TARGETING.

4151

# The definition of this targeting is derived from the structure

4152

# used by Ad Manager.

4153

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4154

"dayParts": [ # A list of day part targeting criterion.

4155

{ # Daypart targeting message that specifies if the ad can be shown

4156

# only during certain parts of a day/week.

4157

"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).

4158

# The start time is inclusive.

4159

# This field is not available for filtering in PQL queries.

4160

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4161

# types are google.type.Date and `google.protobuf.Timestamp`.

4162

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4163

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4164

# to allow the value "24:00:00" for scenarios like business closing time.

4165

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4166

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4167

# allow the value 60 if it allows leap-seconds.

4168

},

4169

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4170

"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

4171

# granularity). The end time is exclusive. This field is not available

4172

# for filtering in PQL queries.

4173

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4174

# types are google.type.Date and `google.protobuf.Timestamp`.

4175

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4176

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4177

# to allow the value "24:00:00" for scenarios like business closing time.

4178

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4179

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4180

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

4190

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

4191

"availableEndTime": "A String", # Proposed flight end time of the deal.

4192

# This will generally be stored in a granularity of a second.

4193

# A value is not required for Private Auction deals or Preferred Deals.

4194

"syndicationProduct": "A String", # The syndication product associated with the deal.

4195

#

4196

# Note: This field may be set only when creating the resource. Modifying

4197

# this field while updating the resource will result in an error.

4198

"createProductId": "A String", # The product ID from which this deal was created.

4199

#

4200

# Note: This field may be set only when creating the resource. Modifying

4201

# this field while updating the resource will result in an error.

4202

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4203

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4204

# deal.

4205

"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]

4206

# If present on create, and the server `product_revision` has advanced sinced

4207

# the passed-in `create_product_revision`, an `ABORTED` error will be

4208

# returned.

4209

#

4210

# Note: This field may be set only when creating the resource. Modifying

4211

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4212

"sellerContacts": [ # Output only. Seller contact information for the deal.

4213

{ # Contains information on how a buyer or seller can be reached.

4214

"email": "A String", # Email address for the contact.

4215

"name": "A String", # The name of the contact.

4216

},

4217

],

4218

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4219

# This will generally be stored in the granularity of one second since deal

4220

# serving starts at seconds boundary. Any time specified with more

4221

# granularity (e.g., in milliseconds) will be truncated towards the start of

4222

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4223

"createTime": "A String", # Output only. The time of the deal creation.

4224

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4225

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4226

# and expected impressions from the publisher.

4227

"description": "A String", # Publisher provided description for the terms.

4228

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4229

# the API at this time, but can be returned in a get or list request.

4230

"fixedPrices": [ # Fixed price for the specified buyer.

4231

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4232

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4233

# a particular buyer or buyer/advertiser pair, we look for the most specific

4234

# matching rule - we first look for a rule matching the buyer and advertiser,

4235

# next a rule with the buyer but an empty advertiser list, and otherwise look

4236

# for a matching rule where no buyer is set.

4237

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4238

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4239

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4240

"nanos": 42, # Number of nano (10^-9) units of the amount.

4241

# The value must be between -999,999,999 and +999,999,999 inclusive.

4242

# If `units` is positive, `nanos` must be positive or zero.

4243

# If `units` is zero, `nanos` can be positive, zero, or negative.

4244

# If `units` is negative, `nanos` must be negative or zero.

4245

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4246

"units": "A String", # The whole units of the amount.

4247

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4248

},

4249

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4250

},

4251

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4252

# If empty, all advertisers with this buyer pay this price.

4253

"A String",

4254

],

4255

"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

4256

# (if the

4257

# advertisers match, and there's no more specific rule matching the buyer).

4258

# Authorized Buyers account ID.

4259

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4265

# Can be set by buyer or seller.

4266

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4267

# by the seller, but they can be returned in a get or list request.

4268

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

4269

# in this private auction.

4270

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4271

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4272

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4273

# a particular buyer or buyer/advertiser pair, we look for the most specific

4274

# matching rule - we first look for a rule matching the buyer and advertiser,

4275

# next a rule with the buyer but an empty advertiser list, and otherwise look

4276

# for a matching rule where no buyer is set.

4277

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4278

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4279

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4280

"nanos": 42, # Number of nano (10^-9) units of the amount.

4281

# The value must be between -999,999,999 and +999,999,999 inclusive.

4282

# If `units` is positive, `nanos` must be positive or zero.

4283

# If `units` is zero, `nanos` can be positive, zero, or negative.

4284

# If `units` is negative, `nanos` must be negative or zero.

4285

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4286

"units": "A String", # The whole units of the amount.

4287

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4288

},

4289

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4290

},

4291

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4292

# If empty, all advertisers with this buyer pay this price.

4293

"A String",

4294

],

4295

"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

4296

# (if the

4297

# advertisers match, and there's no more specific rule matching the buyer).

4298

# Authorized Buyers account ID.

4299

"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.

4305

# Can be set by buyer or seller.

4306

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4307

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4308

"nanos": 42, # Number of nano (10^-9) units of the amount.

4309

# The value must be between -999,999,999 and +999,999,999 inclusive.

4310

# If `units` is positive, `nanos` must be positive or zero.

4311

# If `units` is zero, `nanos` can be positive, zero, or negative.

4312

# If `units` is negative, `nanos` must be negative or zero.

4313

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4314

"units": "A String", # The whole units of the amount.

4315

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4316

},

4317

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4318

},

4319

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

4320

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4321

# time zone used to mark the boundaries of a day. It should be an

4322

# IANA TZ name, such as "America/Los_Angeles". For more information,

4323

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

4324

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4325

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4326

# of guaranteed looks that the buyer is guaranteeing to buy.

4327

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

4328

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4329

"fixedPrices": [ # Fixed price for the specified buyer.

4330

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4331

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4332

# a particular buyer or buyer/advertiser pair, we look for the most specific

4333

# matching rule - we first look for a rule matching the buyer and advertiser,

4334

# next a rule with the buyer but an empty advertiser list, and otherwise look

4335

# for a matching rule where no buyer is set.

4336

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4337

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4338

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4339

"nanos": 42, # Number of nano (10^-9) units of the amount.

4340

# The value must be between -999,999,999 and +999,999,999 inclusive.

4341

# If `units` is positive, `nanos` must be positive or zero.

4342

# If `units` is zero, `nanos` can be positive, zero, or negative.

4343

# If `units` is negative, `nanos` must be negative or zero.

4344

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4345

"units": "A String", # The whole units of the amount.

4346

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4347

},

4348

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4349

},

4350

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4351

# If empty, all advertisers with this buyer pay this price.

4352

"A String",

4353

],

4354

"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

4355

# (if the

4356

# advertisers match, and there's no more specific rule matching the buyer).

4357

# Authorized Buyers account ID.

4358

"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]

4365

# target ad inventory. For example, they can choose to target ad requests only

4366

# if the user is in the US.

4367

# Multiple types of targeting are always applied as a logical AND, unless noted

4368

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4369

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4370

# included and excluded numeric IDs.

4371

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4372

"A String",

4373

],

4374

"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.

4379

# request. It only applies to Private Auction, AdX Preferred Deals and

4380

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4381

# and Preferred Deals in Ad Manager.

4382

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4383

{ # Represents size of a single ad slot, or a creative.

4384

"width": "A String", # The width of the ad slot in pixels.

4385

# This field will be present only when size type is `PIXEL`.

4386

"sizeType": "A String", # The size type of the ad slot.

4387

"height": "A String", # The height of the ad slot in pixels.

4388

# This field will be present only when size type is `PIXEL`.

4389

},

4390

],

4391

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4392

{ # Represents size of a single ad slot, or a creative.

4393

"width": "A String", # The width of the ad slot in pixels.

4394

# This field will be present only when size type is `PIXEL`.

4395

"sizeType": "A String", # The size type of the ad slot.

4396

"height": "A String", # The height of the ad slot in pixels.

4397

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

4402

"targetedPositionTypes": [ # A list of video positions to be included.

4403

# When the included list is present, the excluded list must be empty.

4404

# When the excluded list is present, the included list must be empty.

4405

"A String",

4406

],

4407

"excludedPositionTypes": [ # A list of video positions to be excluded.

4408

# 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.

4413

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4414

# included and excluded numeric IDs.

4415

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4416

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4417

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4418

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4419

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4420

],

4421

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4422

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4423

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4424

# included and excluded numeric IDs.

4425

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4426

"A String",

4427

],

4428

"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.

4433

# included and excluded numeric IDs.

4434

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4435

"A String",

4436

],

4437

"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.

4443

# included and excluded numeric IDs.

4444

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4445

"A String",

4446

],

4447

"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.

4453

# mobile applications.

4454

# Different placement targeting types will be logically OR'ed.

4455

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4456

# For Private Auction and AdX Preferred Deals, URLs are either included or

4457

# excluded.

4458

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4459

# apply.

4460

"targetedUrls": [ # A list of URLs to be included.

4461

"A String",

4462

],

4463

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4468

# This doesn't apply to Auction Packages.

4469

"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]

4470

# display the ads in.

4471

# publishers own.

4472

# Mobile application IDs are from App Store and Google Play Store.

4473

# Android App ID, for example, com.google.android.apps.maps, can be found in

4474

# Google Play Store URL.

4475

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4476

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4477

"targetedAppIds": [ # A list of application IDs to be included.

4478

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4479

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4480

"excludedAppIds": [ # A list of application IDs to be excluded.

4481

"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]

4486

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4487

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4488

"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]

4489

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4490

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

4491

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4492

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4493

"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]

4494

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4495

"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]

4496

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4497

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4498

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4499

},

4500

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4501

"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]

4502

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4503

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4504

# finalized. This is the deal ID that shows up in serving/reporting etc.

4505

"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]

4506

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4507

# in Ad Manager.

4508

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4509

# This doesn't apply to Private Auction and AdX Preferred Deals.

4510

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

4511

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4512

{ # Represents information for a creative that is associated with a Programmatic

4513

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4514

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4515

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4516

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4517

"sizeType": "A String", # The size type of the ad slot.

4518

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4519

# This field will be present only when size type is `PIXEL`.

4520

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4521

"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]

4522

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4523

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4524

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4525

"sizeType": "A String", # The size type of the ad slot.

4526

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4527

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4532

"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]

4533

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4534

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4535

"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]

4536

# The deal is considered paused if either hasBuyerPaused or

4537

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4538

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4539

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4540

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

4541

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4542

"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]

4543

},

4544

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4545

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4546

},

4547

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4548

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4549

# Each update to the proposal or the deal causes the proposal revision number

4550

# to auto-increment. The buyer keeps track of the last revision number they

4551

# know of and pass it in when making an update. If the head revision number

4552

# on the server has since incremented, then an ABORTED error is returned

4553

# during the update operation to let the buyer know that a subsequent update

4554

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4555

"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]

4556

#

4557

# Note: This field may be set only when creating the resource. Modifying

4558

# this field while updating the resource will result in an error.

4559

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"subAccountId": "A String", # Optional sub-account ID for the seller.

4561

"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]

4562

# The seller account ID is then available to buyer in the product.

4563

},

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>

4571

<pre>Retrieves the next page of results.

4572

4573

Args:

4574

previous_request: The request for the previous page. (required)

4575

previous_response: The response from the request for the previous page. (required)

4576

4577

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4578

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4579

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4584

<code class="details" id="pause">pause(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4585

<pre>Update the given proposal to pause serving.

4586

This method will set the

4587

`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all

4588

deals in the proposal.

4589

4590

It is a no-op to pause an already-paused proposal.

4591

It is an error to call PauseProposal for a proposal that is not

4592

finalized or renegotiating.

4593

4594

Args:

4595

accountId: string, Account ID of the buyer. (required)

4596

proposalId: string, The ID of the proposal to pause. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4597

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4598

The object takes the form of:

4599

4600

{ # Request message to pause serving for an already-finalized proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4601

"reason": "A String", # The reason why the proposal is being paused.

4602

# This human readable message will be displayed in the seller's UI.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4603

# (Max length: 1000 unicode code units.)

4604

}

4605

4606

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4613

4614

{ # Note: this resource requires whitelisting for access. Please contact your

4615

# account manager for access to Marketplace resources.

4616

#

4617

# Represents a proposal in the Marketplace. A proposal is the unit of

4618

# negotiation between a seller and a buyer and contains deals which

4619

# are served.

4620

#

4621

# Note: you can not update, create, or otherwise modify Private

4622

# Auction or Preferred Deals deals through the API.

4623

#

4624

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4625

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

4626

#

4627

# Note: This field may be set only when creating the resource. Modifying

4628

# this field while updating the resource will result in an error.

4629

# Authorized Buyers account ID.

4630

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4631

},

4632

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

4633

"notes": [ # Output only. The notes associated with this proposal.

4634

{ # A proposal may be associated to several notes.

4635

"note": "A String", # The actual note to attach.

4636

# (max-length: 1024 unicode code units)

4637

#

4638

# Note: This field may be set only when creating the resource. Modifying

4639

# this field while updating the resource will result in an error.

4640

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

4641

"noteId": "A String", # Output only. The unique ID for the note.

4642

"createTime": "A String", # Output only. The timestamp for when this note was created.

4643

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

4644

},

4645

],

4646

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4647

# proposal.

4648

"proposalState": "A String", # Output only. The current state of the proposal.

4649

"sellerContacts": [ # Output only. Contact information for the seller.

4650

{ # Contains information on how a buyer or seller can be reached.

4651

"email": "A String", # Email address for the contact.

4652

"name": "A String", # The name of the contact.

4653

},

4654

],

4655

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

4656

# proposal.

4657

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

4658

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

4659

# left a comment.

4660

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

4661

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4662

# operations (max-length: 1024 unicode code units).

4663

},

4664

"displayName": "A String", # The name for the proposal.

4665

"buyerContacts": [ # Contact information for the buyer.

4666

{ # Contains information on how a buyer or seller can be reached.

4667

"email": "A String", # Email address for the contact.

4668

"name": "A String", # The name of the contact.

4669

},

4670

],

4671

"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.

4672

# Authorized Buyers account ID.

4673

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4674

},

4675

"updateTime": "A String", # Output only. The time when the proposal was last revised.

4676

"proposalId": "A String", # Output only. The unique ID of the proposal.

4677

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4678

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4679

{ # A deal represents a segment of inventory for displaying ads on.

4680

# A proposal can contain multiple deals. A deal contains the terms and

4681

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4682

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4683

# PUBLISHER means creative is provided by seller and ADVERTISER means

4684

# creative is provided by buyer.

4685

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4686

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4687

# operations (max-length: 1024 unicode code units).

4688

},

4689

"displayName": "A String", # The name of the deal.

4690

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

4691

"updateTime": "A String", # Output only. The time when the deal was last updated.

4692

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4693

# targeting entity is AND'd together.

4694

{ # Advertisers can target different attributes of an ad slot. For example,

4695

# they can choose to show ads only if the user is in the U.S. Such

4696

# targeting criteria can be specified as part of Shared Targeting.

4697

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4698

# together.

4699

{ # A polymorphic targeting value used as part of Shared Targeting.

4700

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4701

# Filled in when key = GOOG_CREATIVE_SIZE

4702

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4703

# of the creative

4704

# height depend on the type of the targeting.

4705

"height": 42, # The height of the creative.

4706

"width": 42, # The width of the creative

4707

},

4708

"allowedFormats": [ # What formats are allowed by the publisher.

4709

# If this repeated field is empty then all formats are allowed.

4710

# For example, if this field contains AllowedFormatType.AUDIO then the

4711

# publisher only allows an audio ad (without any video).

4712

"A String",

4713

],

4714

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4715

# Companion sizes may be filled in only when creative_size_type = VIDEO

4716

{ # Message depicting the size of the creative. The units of width and

4717

# height depend on the type of the targeting.

4718

"height": 42, # The height of the creative.

4719

"width": 42, # The width of the creative

4720

},

4721

],

4722

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4723

# creative_size_type = CreativeSizeType.VIDEO.

4724

"creativeSizeType": "A String", # The creative size type.

4725

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4726

# only if creative_size_type = CreativeSizeType.NATIVE.

4727

},

4728

"stringValue": "A String", # The string value to include/exclude.

4729

"longValue": "A String", # The long value to include/exclude.

4730

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4731

# Filled in when the key is GOOG_DAYPART_TARGETING.

4732

# The definition of this targeting is derived from the structure

4733

# used by Ad Manager.

4734

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4735

"dayParts": [ # A list of day part targeting criterion.

4736

{ # Daypart targeting message that specifies if the ad can be shown

4737

# only during certain parts of a day/week.

4738

"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).

4739

# The start time is inclusive.

4740

# This field is not available for filtering in PQL queries.

4741

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4742

# types are google.type.Date and `google.protobuf.Timestamp`.

4743

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4744

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4745

# to allow the value "24:00:00" for scenarios like business closing time.

4746

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4747

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4748

# allow the value 60 if it allows leap-seconds.

4749

},

4750

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4751

"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

4752

# granularity). The end time is exclusive. This field is not available

4753

# for filtering in PQL queries.

4754

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4755

# types are google.type.Date and `google.protobuf.Timestamp`.

4756

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4757

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4758

# to allow the value "24:00:00" for scenarios like business closing time.

4759

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4760

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4761

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

4769

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4770

# Third parties may define their own keys.

4771

# A list of permissible keys along with the acceptable values will be

4772

# provided as part of the external documentation.

4773

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4774

# together.

4775

{ # A polymorphic targeting value used as part of Shared Targeting.

4776

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4777

# Filled in when key = GOOG_CREATIVE_SIZE

4778

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4779

# of the creative

4780

# height depend on the type of the targeting.

4781

"height": 42, # The height of the creative.

4782

"width": 42, # The width of the creative

4783

},

4784

"allowedFormats": [ # What formats are allowed by the publisher.

4785

# If this repeated field is empty then all formats are allowed.

4786

# For example, if this field contains AllowedFormatType.AUDIO then the

4787

# publisher only allows an audio ad (without any video).

4788

"A String",

4789

],

4790

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4791

# Companion sizes may be filled in only when creative_size_type = VIDEO

4792

{ # Message depicting the size of the creative. The units of width and

4793

# height depend on the type of the targeting.

4794

"height": 42, # The height of the creative.

4795

"width": 42, # The width of the creative

4796

},

4797

],

4798

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4799

# creative_size_type = CreativeSizeType.VIDEO.

4800

"creativeSizeType": "A String", # The creative size type.

4801

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4802

# only if creative_size_type = CreativeSizeType.NATIVE.

4803

},

4804

"stringValue": "A String", # The string value to include/exclude.

4805

"longValue": "A String", # The long value to include/exclude.

4806

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4807

# Filled in when the key is GOOG_DAYPART_TARGETING.

4808

# The definition of this targeting is derived from the structure

4809

# used by Ad Manager.

4810

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4811

"dayParts": [ # A list of day part targeting criterion.

4812

{ # Daypart targeting message that specifies if the ad can be shown

4813

# only during certain parts of a day/week.

4814

"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).

4815

# The start time is inclusive.

4816

# This field is not available for filtering in PQL queries.

4817

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4818

# types are google.type.Date and `google.protobuf.Timestamp`.

4819

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4820

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4821

# to allow the value "24:00:00" for scenarios like business closing time.

4822

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4823

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4824

# allow the value 60 if it allows leap-seconds.

4825

},

4826

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4827

"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

4828

# granularity). The end time is exclusive. This field is not available

4829

# for filtering in PQL queries.

4830

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4831

# types are google.type.Date and `google.protobuf.Timestamp`.

4832

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4833

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4834

# to allow the value "24:00:00" for scenarios like business closing time.

4835

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4836

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4837

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

4847

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

4848

"availableEndTime": "A String", # Proposed flight end time of the deal.

4849

# This will generally be stored in a granularity of a second.

4850

# A value is not required for Private Auction deals or Preferred Deals.

4851

"syndicationProduct": "A String", # The syndication product associated with the deal.

4852

#

4853

# Note: This field may be set only when creating the resource. Modifying

4854

# this field while updating the resource will result in an error.

4855

"createProductId": "A String", # The product ID from which this deal was created.

4856

#

4857

# Note: This field may be set only when creating the resource. Modifying

4858

# this field while updating the resource will result in an error.

4859

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4860

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4861

# deal.

4862

"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]

4863

# If present on create, and the server `product_revision` has advanced sinced

4864

# the passed-in `create_product_revision`, an `ABORTED` error will be

4865

# returned.

4866

#

4867

# Note: This field may be set only when creating the resource. Modifying

4868

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4869

"sellerContacts": [ # Output only. Seller contact information for the deal.

4870

{ # Contains information on how a buyer or seller can be reached.

4871

"email": "A String", # Email address for the contact.

4872

"name": "A String", # The name of the contact.

4873

},

4874

],

4875

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4876

# This will generally be stored in the granularity of one second since deal

4877

# serving starts at seconds boundary. Any time specified with more

4878

# granularity (e.g., in milliseconds) will be truncated towards the start of

4879

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4880

"createTime": "A String", # Output only. The time of the deal creation.

4881

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4882

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4883

# and expected impressions from the publisher.

4884

"description": "A String", # Publisher provided description for the terms.

4885

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4886

# the API at this time, but can be returned in a get or list request.

4887

"fixedPrices": [ # Fixed price for the specified buyer.

4888

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4889

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4890

# a particular buyer or buyer/advertiser pair, we look for the most specific

4891

# matching rule - we first look for a rule matching the buyer and advertiser,

4892

# next a rule with the buyer but an empty advertiser list, and otherwise look

4893

# for a matching rule where no buyer is set.

4894

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4895

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4896

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4897

"nanos": 42, # Number of nano (10^-9) units of the amount.

4898

# The value must be between -999,999,999 and +999,999,999 inclusive.

4899

# If `units` is positive, `nanos` must be positive or zero.

4900

# If `units` is zero, `nanos` can be positive, zero, or negative.

4901

# If `units` is negative, `nanos` must be negative or zero.

4902

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4903

"units": "A String", # The whole units of the amount.

4904

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4905

},

4906

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4907

},

4908

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4909

# If empty, all advertisers with this buyer pay this price.

4910

"A String",

4911

],

4912

"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

4913

# (if the

4914

# advertisers match, and there's no more specific rule matching the buyer).

4915

# Authorized Buyers account ID.

4916

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4922

# Can be set by buyer or seller.

4923

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4924

# by the seller, but they can be returned in a get or list request.

4925

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

4926

# in this private auction.

4927

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4928

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4929

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4930

# a particular buyer or buyer/advertiser pair, we look for the most specific

4931

# matching rule - we first look for a rule matching the buyer and advertiser,

4932

# next a rule with the buyer but an empty advertiser list, and otherwise look

4933

# for a matching rule where no buyer is set.

4934

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4935

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4936

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4937

"nanos": 42, # Number of nano (10^-9) units of the amount.

4938

# The value must be between -999,999,999 and +999,999,999 inclusive.

4939

# If `units` is positive, `nanos` must be positive or zero.

4940

# If `units` is zero, `nanos` can be positive, zero, or negative.

4941

# If `units` is negative, `nanos` must be negative or zero.

4942

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4943

"units": "A String", # The whole units of the amount.

4944

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4945

},

4946

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4947

},

4948

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4949

# If empty, all advertisers with this buyer pay this price.

4950

"A String",

4951

],

4952

"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

4953

# (if the

4954

# advertisers match, and there's no more specific rule matching the buyer).

4955

# Authorized Buyers account ID.

4956

"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.

4962

# Can be set by buyer or seller.

4963

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4964

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4965

"nanos": 42, # Number of nano (10^-9) units of the amount.

4966

# The value must be between -999,999,999 and +999,999,999 inclusive.

4967

# If `units` is positive, `nanos` must be positive or zero.

4968

# If `units` is zero, `nanos` can be positive, zero, or negative.

4969

# If `units` is negative, `nanos` must be negative or zero.

4970

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4971

"units": "A String", # The whole units of the amount.

4972

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4973

},

4974

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4975

},

4976

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

4977

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4978

# time zone used to mark the boundaries of a day. It should be an

4979

# IANA TZ name, such as "America/Los_Angeles". For more information,

4980

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

4981

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4982

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4983

# of guaranteed looks that the buyer is guaranteeing to buy.

4984

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

4985

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4986

"fixedPrices": [ # Fixed price for the specified buyer.

4987

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4988

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4989

# a particular buyer or buyer/advertiser pair, we look for the most specific

4990

# matching rule - we first look for a rule matching the buyer and advertiser,

4991

# next a rule with the buyer but an empty advertiser list, and otherwise look

4992

# for a matching rule where no buyer is set.

4993

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4994

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4995

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4996

"nanos": 42, # Number of nano (10^-9) units of the amount.

4997

# The value must be between -999,999,999 and +999,999,999 inclusive.

4998

# If `units` is positive, `nanos` must be positive or zero.

4999

# If `units` is zero, `nanos` can be positive, zero, or negative.

5000

# If `units` is negative, `nanos` must be negative or zero.

5001

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5002

"units": "A String", # The whole units of the amount.

5003

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5004

},

5005

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5006

},

5007

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5008

# If empty, all advertisers with this buyer pay this price.

5009

"A String",

5010

],

5011

"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

5012

# (if the

5013

# advertisers match, and there's no more specific rule matching the buyer).

5014

# Authorized Buyers account ID.

5015

"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]

5022

# target ad inventory. For example, they can choose to target ad requests only

5023

# if the user is in the US.

5024

# Multiple types of targeting are always applied as a logical AND, unless noted

5025

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5026

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5027

# included and excluded numeric IDs.

5028

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5029

"A String",

5030

],

5031

"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.

5036

# request. It only applies to Private Auction, AdX Preferred Deals and

5037

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5038

# and Preferred Deals in Ad Manager.

5039

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5040

{ # Represents size of a single ad slot, or a creative.

5041

"width": "A String", # The width of the ad slot in pixels.

5042

# This field will be present only when size type is `PIXEL`.

5043

"sizeType": "A String", # The size type of the ad slot.

5044

"height": "A String", # The height of the ad slot in pixels.

5045

# This field will be present only when size type is `PIXEL`.

5046

},

5047

],

5048

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5049

{ # Represents size of a single ad slot, or a creative.

5050

"width": "A String", # The width of the ad slot in pixels.

5051

# This field will be present only when size type is `PIXEL`.

5052

"sizeType": "A String", # The size type of the ad slot.

5053

"height": "A String", # The height of the ad slot in pixels.

5054

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5059

"targetedPositionTypes": [ # A list of video positions to be included.

5060

# When the included list is present, the excluded list must be empty.

5061

# When the excluded list is present, the included list must be empty.

5062

"A String",

5063

],

5064

"excludedPositionTypes": [ # A list of video positions to be excluded.

5065

# 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.

5070

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5071

# included and excluded numeric IDs.

5072

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5073

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5074

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5075

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5076

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5077

],

5078

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5079

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5080

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5081

# included and excluded numeric IDs.

5082

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5083

"A String",

5084

],

5085

"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.

5090

# included and excluded numeric IDs.

5091

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5092

"A String",

5093

],

5094

"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.

5100

# included and excluded numeric IDs.

5101

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5102

"A String",

5103

],

5104

"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.

5110

# mobile applications.

5111

# Different placement targeting types will be logically OR'ed.

5112

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5113

# For Private Auction and AdX Preferred Deals, URLs are either included or

5114

# excluded.

5115

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5116

# apply.

5117

"targetedUrls": [ # A list of URLs to be included.

5118

"A String",

5119

],

5120

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5125

# This doesn't apply to Auction Packages.

5126

"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]

5127

# display the ads in.

5128

# publishers own.

5129

# Mobile application IDs are from App Store and Google Play Store.

5130

# Android App ID, for example, com.google.android.apps.maps, can be found in

5131

# Google Play Store URL.

5132

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5133

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5134

"targetedAppIds": [ # A list of application IDs to be included.

5135

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5136

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5137

"excludedAppIds": [ # A list of application IDs to be excluded.

5138

"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]

5143

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5144

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5145

"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]

5146

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5147

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

5148

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5149

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5150

"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]

5151

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5152

"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]

5153

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5154

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5155

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5156

},

5157

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5158

"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]

5159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5160

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

5161

# finalized. This is the deal ID that shows up in serving/reporting etc.

5162

"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]

5163

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5164

# in Ad Manager.

5165

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5166

# This doesn't apply to Private Auction and AdX Preferred Deals.

5167

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

5168

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5169

{ # Represents information for a creative that is associated with a Programmatic

5170

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5171

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5172

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5173

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5174

"sizeType": "A String", # The size type of the ad slot.

5175

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5176

# This field will be present only when size type is `PIXEL`.

5177

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5178

"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]

5179

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5180

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5181

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5182

"sizeType": "A String", # The size type of the ad slot.

5183

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5184

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5189

"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]

5190

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5191

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5192

"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]

5193

# The deal is considered paused if either hasBuyerPaused or

5194

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5195

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5196

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5197

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

5198

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5199

"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]

5200

},

5201

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5202

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5203

},

5204

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5205

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5206

# Each update to the proposal or the deal causes the proposal revision number

5207

# to auto-increment. The buyer keeps track of the last revision number they

5208

# know of and pass it in when making an update. If the head revision number

5209

# on the server has since incremented, then an ABORTED error is returned

5210

# during the update operation to let the buyer know that a subsequent update

5211

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5212

"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]

5213

#

5214

# Note: This field may be set only when creating the resource. Modifying

5215

# this field while updating the resource will result in an error.

5216

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5217

"subAccountId": "A String", # Optional sub-account ID for the seller.

5218

"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]

5219

# The seller account ID is then available to buyer in the product.

5220

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="resume">resume(accountId, proposalId, body=None, x__xgafv=None)</code>

5226

<pre>Update the given proposal to resume serving.

5227

This method will set the

5228

`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all

5229

deals in the proposal.

5230

5231

Note that if the `has_seller_paused` bit is also set, serving will not

5232

resume until the seller also resumes.

5233

5234

It is a no-op to resume an already-running proposal.

5235

It is an error to call ResumeProposal for a proposal that is not

5236

finalized or renegotiating.

5237

5238

Args:

5239

accountId: string, Account ID of the buyer. (required)

5240

proposalId: string, The ID of the proposal to resume. (required)

5241

body: object, The request body.

5242

The object takes the form of:

5243

5244

{ # Request message to resume (unpause) serving for an already-finalized

# proposal.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5255

5256

{ # Note: this resource requires whitelisting for access. Please contact your

5257

# account manager for access to Marketplace resources.

5258

#

5259

# Represents a proposal in the Marketplace. A proposal is the unit of

5260

# negotiation between a seller and a buyer and contains deals which

5261

# are served.

5262

#

5263

# Note: you can not update, create, or otherwise modify Private

5264

# Auction or Preferred Deals deals through the API.

5265

#

5266

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5267

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5268

#

5269

# Note: This field may be set only when creating the resource. Modifying

5270

# this field while updating the resource will result in an error.

5271

# Authorized Buyers account ID.

5272

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5273

},

5274

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5275

"notes": [ # Output only. The notes associated with this proposal.

5276

{ # A proposal may be associated to several notes.

5277

"note": "A String", # The actual note to attach.

5278

# (max-length: 1024 unicode code units)

5279

#

5280

# Note: This field may be set only when creating the resource. Modifying

5281

# this field while updating the resource will result in an error.

5282

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5283

"noteId": "A String", # Output only. The unique ID for the note.

5284

"createTime": "A String", # Output only. The timestamp for when this note was created.

5285

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5286

},

5287

],

5288

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5289

# proposal.

5290

"proposalState": "A String", # Output only. The current state of the proposal.

5291

"sellerContacts": [ # Output only. Contact information for the seller.

5292

{ # Contains information on how a buyer or seller can be reached.

5293

"email": "A String", # Email address for the contact.

5294

"name": "A String", # The name of the contact.

5295

},

5296

],

5297

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5298

# proposal.

5299

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5300

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5301

# left a comment.

5302

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5303

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5304

# operations (max-length: 1024 unicode code units).

5305

},

5306

"displayName": "A String", # The name for the proposal.

5307

"buyerContacts": [ # Contact information for the buyer.

5308

{ # Contains information on how a buyer or seller can be reached.

5309

"email": "A String", # Email address for the contact.

5310

"name": "A String", # The name of the contact.

5311

},

5312

],

5313

"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.

5314

# Authorized Buyers account ID.

5315

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5316

},

5317

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5318

"proposalId": "A String", # Output only. The unique ID of the proposal.

5319

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5320

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5321

{ # A deal represents a segment of inventory for displaying ads on.

5322

# A proposal can contain multiple deals. A deal contains the terms and

5323

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5324

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5325

# PUBLISHER means creative is provided by seller and ADVERTISER means

5326

# creative is provided by buyer.

5327

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5328

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5329

# operations (max-length: 1024 unicode code units).

5330

},

5331

"displayName": "A String", # The name of the deal.

5332

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

5333

"updateTime": "A String", # Output only. The time when the deal was last updated.

5334

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5335

# targeting entity is AND'd together.

5336

{ # Advertisers can target different attributes of an ad slot. For example,

5337

# they can choose to show ads only if the user is in the U.S. Such

5338

# targeting criteria can be specified as part of Shared Targeting.

5339

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5340

# together.

5341

{ # A polymorphic targeting value used as part of Shared Targeting.

5342

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5343

# Filled in when key = GOOG_CREATIVE_SIZE

5344

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5345

# of the creative

5346

# height depend on the type of the targeting.

5347

"height": 42, # The height of the creative.

5348

"width": 42, # The width of the creative

5349

},

5350

"allowedFormats": [ # What formats are allowed by the publisher.

5351

# If this repeated field is empty then all formats are allowed.

5352

# For example, if this field contains AllowedFormatType.AUDIO then the

5353

# publisher only allows an audio ad (without any video).

5354

"A String",

5355

],

5356

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5357

# Companion sizes may be filled in only when creative_size_type = VIDEO

5358

{ # Message depicting the size of the creative. The units of width and

5359

# height depend on the type of the targeting.

5360

"height": 42, # The height of the creative.

5361

"width": 42, # The width of the creative

5362

},

5363

],

5364

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5365

# creative_size_type = CreativeSizeType.VIDEO.

5366

"creativeSizeType": "A String", # The creative size type.

5367

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5368

# only if creative_size_type = CreativeSizeType.NATIVE.

5369

},

5370

"stringValue": "A String", # The string value to include/exclude.

5371

"longValue": "A String", # The long value to include/exclude.

5372

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5373

# Filled in when the key is GOOG_DAYPART_TARGETING.

5374

# The definition of this targeting is derived from the structure

5375

# used by Ad Manager.

5376

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5377

"dayParts": [ # A list of day part targeting criterion.

5378

{ # Daypart targeting message that specifies if the ad can be shown

5379

# only during certain parts of a day/week.

5380

"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).

5381

# The start time is inclusive.

5382

# This field is not available for filtering in PQL queries.

5383

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5384

# types are google.type.Date and `google.protobuf.Timestamp`.

5385

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5386

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5387

# to allow the value "24:00:00" for scenarios like business closing time.

5388

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5389

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5390

# allow the value 60 if it allows leap-seconds.

5391

},

5392

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5393

"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

5394

# granularity). The end time is exclusive. This field is not available

5395

# for filtering in PQL queries.

5396

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5397

# types are google.type.Date and `google.protobuf.Timestamp`.

5398

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5399

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5400

# to allow the value "24:00:00" for scenarios like business closing time.

5401

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5402

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5403

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

5411

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5412

# Third parties may define their own keys.

5413

# A list of permissible keys along with the acceptable values will be

5414

# provided as part of the external documentation.

5415

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5416

# together.

5417

{ # A polymorphic targeting value used as part of Shared Targeting.

5418

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5419

# Filled in when key = GOOG_CREATIVE_SIZE

5420

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5421

# of the creative

5422

# height depend on the type of the targeting.

5423

"height": 42, # The height of the creative.

5424

"width": 42, # The width of the creative

5425

},

5426

"allowedFormats": [ # What formats are allowed by the publisher.

5427

# If this repeated field is empty then all formats are allowed.

5428

# For example, if this field contains AllowedFormatType.AUDIO then the

5429

# publisher only allows an audio ad (without any video).

5430

"A String",

5431

],

5432

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5433

# Companion sizes may be filled in only when creative_size_type = VIDEO

5434

{ # Message depicting the size of the creative. The units of width and

5435

# height depend on the type of the targeting.

5436

"height": 42, # The height of the creative.

5437

"width": 42, # The width of the creative

5438

},

5439

],

5440

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5441

# creative_size_type = CreativeSizeType.VIDEO.

5442

"creativeSizeType": "A String", # The creative size type.

5443

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5444

# only if creative_size_type = CreativeSizeType.NATIVE.

5445

},

5446

"stringValue": "A String", # The string value to include/exclude.

5447

"longValue": "A String", # The long value to include/exclude.

5448

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5449

# Filled in when the key is GOOG_DAYPART_TARGETING.

5450

# The definition of this targeting is derived from the structure

5451

# used by Ad Manager.

5452

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5453

"dayParts": [ # A list of day part targeting criterion.

5454

{ # Daypart targeting message that specifies if the ad can be shown

5455

# only during certain parts of a day/week.

5456

"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).

5457

# The start time is inclusive.

5458

# This field is not available for filtering in PQL queries.

5459

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5460

# types are google.type.Date and `google.protobuf.Timestamp`.

5461

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5462

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5463

# to allow the value "24:00:00" for scenarios like business closing time.

5464

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5465

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5466

# allow the value 60 if it allows leap-seconds.

5467

},

5468

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5469

"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

5470

# granularity). The end time is exclusive. This field is not available

5471

# for filtering in PQL queries.

5472

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5473

# types are google.type.Date and `google.protobuf.Timestamp`.

5474

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5475

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5476

# to allow the value "24:00:00" for scenarios like business closing time.

5477

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5478

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5479

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

5489

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

5490

"availableEndTime": "A String", # Proposed flight end time of the deal.

5491

# This will generally be stored in a granularity of a second.

5492

# A value is not required for Private Auction deals or Preferred Deals.

5493

"syndicationProduct": "A String", # The syndication product associated with the deal.

5494

#

5495

# Note: This field may be set only when creating the resource. Modifying

5496

# this field while updating the resource will result in an error.

5497

"createProductId": "A String", # The product ID from which this deal was created.

5498

#

5499

# Note: This field may be set only when creating the resource. Modifying

5500

# this field while updating the resource will result in an error.

5501

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5502

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5503

# deal.

5504

"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]

5505

# If present on create, and the server `product_revision` has advanced sinced

5506

# the passed-in `create_product_revision`, an `ABORTED` error will be

5507

# returned.

5508

#

5509

# Note: This field may be set only when creating the resource. Modifying

5510

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5511

"sellerContacts": [ # Output only. Seller contact information for the deal.

5512

{ # Contains information on how a buyer or seller can be reached.

5513

"email": "A String", # Email address for the contact.

5514

"name": "A String", # The name of the contact.

5515

},

5516

],

5517

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5518

# This will generally be stored in the granularity of one second since deal

5519

# serving starts at seconds boundary. Any time specified with more

5520

# granularity (e.g., in milliseconds) will be truncated towards the start of

5521

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5522

"createTime": "A String", # Output only. The time of the deal creation.

5523

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

5524

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

5525

# and expected impressions from the publisher.

5526

"description": "A String", # Publisher provided description for the terms.

5527

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

5528

# the API at this time, but can be returned in a get or list request.

5529

"fixedPrices": [ # Fixed price for the specified buyer.

5530

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5531

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5532

# a particular buyer or buyer/advertiser pair, we look for the most specific

5533

# matching rule - we first look for a rule matching the buyer and advertiser,

5534

# next a rule with the buyer but an empty advertiser list, and otherwise look

5535

# for a matching rule where no buyer is set.

5536

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5537

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5538

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5539

"nanos": 42, # Number of nano (10^-9) units of the amount.

5540

# The value must be between -999,999,999 and +999,999,999 inclusive.

5541

# If `units` is positive, `nanos` must be positive or zero.

5542

# If `units` is zero, `nanos` can be positive, zero, or negative.

5543

# If `units` is negative, `nanos` must be negative or zero.

5544

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5545

"units": "A String", # The whole units of the amount.

5546

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5547

},

5548

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5549

},

5550

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5551

# If empty, all advertisers with this buyer pay this price.

5552

"A String",

5553

],

5554

"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

5555

# (if the

5556

# advertisers match, and there's no more specific rule matching the buyer).

5557

# Authorized Buyers account ID.

5558

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

5564

# Can be set by buyer or seller.

5565

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

5566

# by the seller, but they can be returned in a get or list request.

5567

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

5568

# in this private auction.

5569

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

5570

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5571

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5572

# a particular buyer or buyer/advertiser pair, we look for the most specific

5573

# matching rule - we first look for a rule matching the buyer and advertiser,

5574

# next a rule with the buyer but an empty advertiser list, and otherwise look

5575

# for a matching rule where no buyer is set.

5576

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5577

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5578

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5579

"nanos": 42, # Number of nano (10^-9) units of the amount.

5580

# The value must be between -999,999,999 and +999,999,999 inclusive.

5581

# If `units` is positive, `nanos` must be positive or zero.

5582

# If `units` is zero, `nanos` can be positive, zero, or negative.

5583

# If `units` is negative, `nanos` must be negative or zero.

5584

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5585

"units": "A String", # The whole units of the amount.

5586

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5587

},

5588

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5589

},

5590

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5591

# If empty, all advertisers with this buyer pay this price.

5592

"A String",

5593

],

5594

"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

5595

# (if the

5596

# advertisers match, and there's no more specific rule matching the buyer).

5597

# Authorized Buyers account ID.

5598

"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.

5604

# Can be set by buyer or seller.

5605

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5606

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5607

"nanos": 42, # Number of nano (10^-9) units of the amount.

5608

# The value must be between -999,999,999 and +999,999,999 inclusive.

5609

# If `units` is positive, `nanos` must be positive or zero.

5610

# If `units` is zero, `nanos` can be positive, zero, or negative.

5611

# If `units` is negative, `nanos` must be negative or zero.

5612

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5613

"units": "A String", # The whole units of the amount.

5614

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5615

},

5616

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5617

},

5618

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

5619

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

5620

# time zone used to mark the boundaries of a day. It should be an

5621

# IANA TZ name, such as "America/Los_Angeles". For more information,

5622

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

5623

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

5624

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

5625

# of guaranteed looks that the buyer is guaranteeing to buy.

5626

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

5627

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

5628

"fixedPrices": [ # Fixed price for the specified buyer.

5629

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5630

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5631

# a particular buyer or buyer/advertiser pair, we look for the most specific

5632

# matching rule - we first look for a rule matching the buyer and advertiser,

5633

# next a rule with the buyer but an empty advertiser list, and otherwise look

5634

# for a matching rule where no buyer is set.

5635

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5636

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5637

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5638

"nanos": 42, # Number of nano (10^-9) units of the amount.

5639

# The value must be between -999,999,999 and +999,999,999 inclusive.

5640

# If `units` is positive, `nanos` must be positive or zero.

5641

# If `units` is zero, `nanos` can be positive, zero, or negative.

5642

# If `units` is negative, `nanos` must be negative or zero.

5643

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5644

"units": "A String", # The whole units of the amount.

5645

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5646

},

5647

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5648

},

5649

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5650

# If empty, all advertisers with this buyer pay this price.

5651

"A String",

5652

],

5653

"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

5654

# (if the

5655

# advertisers match, and there's no more specific rule matching the buyer).

5656

# Authorized Buyers account ID.

5657

"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]

5664

# target ad inventory. For example, they can choose to target ad requests only

5665

# if the user is in the US.

5666

# Multiple types of targeting are always applied as a logical AND, unless noted

5667

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5668

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5669

# included and excluded numeric IDs.

5670

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5671

"A String",

5672

],

5673

"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.

5678

# request. It only applies to Private Auction, AdX Preferred Deals and

5679

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5680

# and Preferred Deals in Ad Manager.

5681

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5682

{ # Represents size of a single ad slot, or a creative.

5683

"width": "A String", # The width of the ad slot in pixels.

5684

# This field will be present only when size type is `PIXEL`.

5685

"sizeType": "A String", # The size type of the ad slot.

5686

"height": "A String", # The height of the ad slot in pixels.

5687

# This field will be present only when size type is `PIXEL`.

5688

},

5689

],

5690

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5691

{ # Represents size of a single ad slot, or a creative.

5692

"width": "A String", # The width of the ad slot in pixels.

5693

# This field will be present only when size type is `PIXEL`.

5694

"sizeType": "A String", # The size type of the ad slot.

5695

"height": "A String", # The height of the ad slot in pixels.

5696

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5701

"targetedPositionTypes": [ # A list of video positions to be included.

5702

# When the included list is present, the excluded list must be empty.

5703

# When the excluded list is present, the included list must be empty.

5704

"A String",

5705

],

5706

"excludedPositionTypes": [ # A list of video positions to be excluded.

5707

# 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.

5712

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5713

# included and excluded numeric IDs.

5714

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5715

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5716

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5717

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5718

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5719

],

5720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5721

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5722

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5723

# included and excluded numeric IDs.

5724

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5725

"A String",

5726

],

5727

"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.

5732

# included and excluded numeric IDs.

5733

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5734

"A String",

5735

],

5736

"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.

5742

# included and excluded numeric IDs.

5743

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5744

"A String",

5745

],

5746

"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.

5752

# mobile applications.

5753

# Different placement targeting types will be logically OR'ed.

5754

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5755

# For Private Auction and AdX Preferred Deals, URLs are either included or

5756

# excluded.

5757

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5758

# apply.

5759

"targetedUrls": [ # A list of URLs to be included.

5760

"A String",

5761

],

5762

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5767

# This doesn't apply to Auction Packages.

5768

"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]

5769

# display the ads in.

5770

# publishers own.

5771

# Mobile application IDs are from App Store and Google Play Store.

5772

# Android App ID, for example, com.google.android.apps.maps, can be found in

5773

# Google Play Store URL.

5774

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5775

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5776

"targetedAppIds": [ # A list of application IDs to be included.

5777

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5778

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5779

"excludedAppIds": [ # A list of application IDs to be excluded.

5780

"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]

5785

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5786

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5787

"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]

5788

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5789

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

5790

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5791

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5792

"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]

5793

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5794

"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]

5795

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5796

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5797

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5798

},

5799

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5800

"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]

5801

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5802

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

5803

# finalized. This is the deal ID that shows up in serving/reporting etc.

5804

"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]

5805

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5806

# in Ad Manager.

5807

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5808

# This doesn't apply to Private Auction and AdX Preferred Deals.

5809

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

5810

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5811

{ # Represents information for a creative that is associated with a Programmatic

5812

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5813

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5814

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5815

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5816

"sizeType": "A String", # The size type of the ad slot.

5817

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5818

# This field will be present only when size type is `PIXEL`.

5819

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5820

"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]

5821

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5822

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5823

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5824

"sizeType": "A String", # The size type of the ad slot.

5825

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5826

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5831

"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]

5832

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5833

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5834

"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]

5835

# The deal is considered paused if either hasBuyerPaused or

5836

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5837

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5838

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5839

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

5840

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5841

"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]

5842

},

5843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5844

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5845

},

5846

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5847

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5848

# Each update to the proposal or the deal causes the proposal revision number

5849

# to auto-increment. The buyer keeps track of the last revision number they

5850

# know of and pass it in when making an update. If the head revision number

5851

# on the server has since incremented, then an ABORTED error is returned

5852

# during the update operation to let the buyer know that a subsequent update

5853

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5854

"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]

5855

#

5856

# Note: This field may be set only when creating the resource. Modifying

5857

# this field while updating the resource will result in an error.

5858

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5859

"subAccountId": "A String", # Optional sub-account ID for the seller.

5860

"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]

5861

# The seller account ID is then available to buyer in the product.

5862

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5867

<code class="details" id="update">update(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5868

<pre>Update the given proposal at the client known revision number. If the

5869

server revision has advanced since the passed-in

5870

`proposal.proposal_revision`, an `ABORTED` error message will be returned.

5871

Only the buyer-modifiable fields of the proposal will be updated.

5872

5873

Note that the deals in the proposal will be updated to match the passed-in

5874

copy.

5875

If a passed-in deal does not have a `deal_id`, the server will assign a new

5876

unique ID and create the deal.

5877

If passed-in deal has a `deal_id`, it will be updated to match the

5878

passed-in copy.

5879

Any existing deals not present in the passed-in proposal will be deleted.

5880

It is an error to pass in a deal with a `deal_id` not present at head.

5881

5882

Args:

5883

accountId: string, Account ID of the buyer. (required)

5884

proposalId: string, The unique ID of the proposal. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5885

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5886

The object takes the form of:

5887

5888

{ # Note: this resource requires whitelisting for access. Please contact your

5889

# account manager for access to Marketplace resources.

5890

#

5891

# Represents a proposal in the Marketplace. A proposal is the unit of

5892

# negotiation between a seller and a buyer and contains deals which

5893

# are served.

5894

#

5895

# Note: you can not update, create, or otherwise modify Private

5896

# Auction or Preferred Deals deals through the API.

5897

#

5898

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5899

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5900

#

5901

# Note: This field may be set only when creating the resource. Modifying

5902

# this field while updating the resource will result in an error.

5903

# Authorized Buyers account ID.

5904

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5905

},

5906

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5907

"notes": [ # Output only. The notes associated with this proposal.

5908

{ # A proposal may be associated to several notes.

5909

"note": "A String", # The actual note to attach.

5910

# (max-length: 1024 unicode code units)

5911

#

5912

# Note: This field may be set only when creating the resource. Modifying

5913

# this field while updating the resource will result in an error.

5914

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5915

"noteId": "A String", # Output only. The unique ID for the note.

5916

"createTime": "A String", # Output only. The timestamp for when this note was created.

5917

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5918

},

5919

],

5920

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5921

# proposal.

5922

"proposalState": "A String", # Output only. The current state of the proposal.

5923

"sellerContacts": [ # Output only. Contact information for the seller.

5924

{ # Contains information on how a buyer or seller can be reached.

5925

"email": "A String", # Email address for the contact.

5926

"name": "A String", # The name of the contact.

5927

},

5928

],

5929

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5930

# proposal.

5931

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5932

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5933

# left a comment.

5934

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5935

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5936

# operations (max-length: 1024 unicode code units).

5937

},

5938

"displayName": "A String", # The name for the proposal.

5939

"buyerContacts": [ # Contact information for the buyer.

5940

{ # Contains information on how a buyer or seller can be reached.

5941

"email": "A String", # Email address for the contact.

5942

"name": "A String", # The name of the contact.

5943

},

5944

],

5945

"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.

5946

# Authorized Buyers account ID.

5947

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5948

},

5949

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5950

"proposalId": "A String", # Output only. The unique ID of the proposal.

5951

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5952

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5953

{ # A deal represents a segment of inventory for displaying ads on.

5954

# A proposal can contain multiple deals. A deal contains the terms and

5955

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5956

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5957

# PUBLISHER means creative is provided by seller and ADVERTISER means

5958

# creative is provided by buyer.

5959

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5960

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5961

# operations (max-length: 1024 unicode code units).

5962

},

5963

"displayName": "A String", # The name of the deal.

5964

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

5965

"updateTime": "A String", # Output only. The time when the deal was last updated.

5966

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5967

# targeting entity is AND'd together.

5968

{ # Advertisers can target different attributes of an ad slot. For example,

5969

# they can choose to show ads only if the user is in the U.S. Such

5970

# targeting criteria can be specified as part of Shared Targeting.

5971

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5972

# together.

5973

{ # A polymorphic targeting value used as part of Shared Targeting.

5974

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5975

# Filled in when key = GOOG_CREATIVE_SIZE

5976

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5977

# of the creative

5978

# height depend on the type of the targeting.

5979

"height": 42, # The height of the creative.

5980

"width": 42, # The width of the creative

5981

},

5982

"allowedFormats": [ # What formats are allowed by the publisher.

5983

# If this repeated field is empty then all formats are allowed.

5984

# For example, if this field contains AllowedFormatType.AUDIO then the

5985

# publisher only allows an audio ad (without any video).

5986

"A String",

5987

],

5988

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5989

# Companion sizes may be filled in only when creative_size_type = VIDEO

5990

{ # Message depicting the size of the creative. The units of width and

5991

# height depend on the type of the targeting.

5992

"height": 42, # The height of the creative.

5993

"width": 42, # The width of the creative

5994

},

5995

],

5996

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5997

# creative_size_type = CreativeSizeType.VIDEO.

5998

"creativeSizeType": "A String", # The creative size type.

5999

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6000

# only if creative_size_type = CreativeSizeType.NATIVE.

6001

},

6002

"stringValue": "A String", # The string value to include/exclude.

6003

"longValue": "A String", # The long value to include/exclude.

6004

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6005

# Filled in when the key is GOOG_DAYPART_TARGETING.

6006

# The definition of this targeting is derived from the structure

6007

# used by Ad Manager.

6008

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6009

"dayParts": [ # A list of day part targeting criterion.

6010

{ # Daypart targeting message that specifies if the ad can be shown

6011

# only during certain parts of a day/week.

6012

"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).

6013

# The start time is inclusive.

6014

# This field is not available for filtering in PQL queries.

6015

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6016

# types are google.type.Date and `google.protobuf.Timestamp`.

6017

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6018

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6019

# to allow the value "24:00:00" for scenarios like business closing time.

6020

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6021

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6022

# allow the value 60 if it allows leap-seconds.

6023

},

6024

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6025

"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

6026

# granularity). The end time is exclusive. This field is not available

6027

# for filtering in PQL queries.

6028

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6029

# types are google.type.Date and `google.protobuf.Timestamp`.

6030

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6031

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6032

# to allow the value "24:00:00" for scenarios like business closing time.

6033

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6034

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6035

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

6043

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6044

# Third parties may define their own keys.

6045

# A list of permissible keys along with the acceptable values will be

6046

# provided as part of the external documentation.

6047

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6048

# together.

6049

{ # A polymorphic targeting value used as part of Shared Targeting.

6050

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6051

# Filled in when key = GOOG_CREATIVE_SIZE

6052

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6053

# of the creative

6054

# height depend on the type of the targeting.

6055

"height": 42, # The height of the creative.

6056

"width": 42, # The width of the creative

6057

},

6058

"allowedFormats": [ # What formats are allowed by the publisher.

6059

# If this repeated field is empty then all formats are allowed.

6060

# For example, if this field contains AllowedFormatType.AUDIO then the

6061

# publisher only allows an audio ad (without any video).

6062

"A String",

6063

],

6064

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6065

# Companion sizes may be filled in only when creative_size_type = VIDEO

6066

{ # Message depicting the size of the creative. The units of width and

6067

# height depend on the type of the targeting.

6068

"height": 42, # The height of the creative.

6069

"width": 42, # The width of the creative

6070

},

6071

],

6072

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6073

# creative_size_type = CreativeSizeType.VIDEO.

6074

"creativeSizeType": "A String", # The creative size type.

6075

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6076

# only if creative_size_type = CreativeSizeType.NATIVE.

6077

},

6078

"stringValue": "A String", # The string value to include/exclude.

6079

"longValue": "A String", # The long value to include/exclude.

6080

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6081

# Filled in when the key is GOOG_DAYPART_TARGETING.

6082

# The definition of this targeting is derived from the structure

6083

# used by Ad Manager.

6084

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6085

"dayParts": [ # A list of day part targeting criterion.

6086

{ # Daypart targeting message that specifies if the ad can be shown

6087

# only during certain parts of a day/week.

6088

"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).

6089

# The start time is inclusive.

6090

# This field is not available for filtering in PQL queries.

6091

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6092

# types are google.type.Date and `google.protobuf.Timestamp`.

6093

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6094

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6095

# to allow the value "24:00:00" for scenarios like business closing time.

6096

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6097

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6098

# allow the value 60 if it allows leap-seconds.

6099

},

6100

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6101

"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

6102

# granularity). The end time is exclusive. This field is not available

6103

# for filtering in PQL queries.

6104

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6105

# types are google.type.Date and `google.protobuf.Timestamp`.

6106

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6107

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6108

# to allow the value "24:00:00" for scenarios like business closing time.

6109

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6110

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6111

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

6121

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

6122

"availableEndTime": "A String", # Proposed flight end time of the deal.

6123

# This will generally be stored in a granularity of a second.

6124

# A value is not required for Private Auction deals or Preferred Deals.

6125

"syndicationProduct": "A String", # The syndication product associated with the deal.

6126

#

6127

# Note: This field may be set only when creating the resource. Modifying

6128

# this field while updating the resource will result in an error.

6129

"createProductId": "A String", # The product ID from which this deal was created.

6130

#

6131

# Note: This field may be set only when creating the resource. Modifying

6132

# this field while updating the resource will result in an error.

6133

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6134

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6135

# deal.

6136

"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]

6137

# If present on create, and the server `product_revision` has advanced sinced

6138

# the passed-in `create_product_revision`, an `ABORTED` error will be

6139

# returned.

6140

#

6141

# Note: This field may be set only when creating the resource. Modifying

6142

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6143

"sellerContacts": [ # Output only. Seller contact information for the deal.

6144

{ # Contains information on how a buyer or seller can be reached.

6145

"email": "A String", # Email address for the contact.

6146

"name": "A String", # The name of the contact.

6147

},

6148

],

6149

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6150

# This will generally be stored in the granularity of one second since deal

6151

# serving starts at seconds boundary. Any time specified with more

6152

# granularity (e.g., in milliseconds) will be truncated towards the start of

6153

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6154

"createTime": "A String", # Output only. The time of the deal creation.

6155

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6156

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6157

# and expected impressions from the publisher.

6158

"description": "A String", # Publisher provided description for the terms.

6159

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6160

# the API at this time, but can be returned in a get or list request.

6161

"fixedPrices": [ # Fixed price for the specified buyer.

6162

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6163

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6164

# a particular buyer or buyer/advertiser pair, we look for the most specific

6165

# matching rule - we first look for a rule matching the buyer and advertiser,

6166

# next a rule with the buyer but an empty advertiser list, and otherwise look

6167

# for a matching rule where no buyer is set.

6168

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6169

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6170

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6171

"nanos": 42, # Number of nano (10^-9) units of the amount.

6172

# The value must be between -999,999,999 and +999,999,999 inclusive.

6173

# If `units` is positive, `nanos` must be positive or zero.

6174

# If `units` is zero, `nanos` can be positive, zero, or negative.

6175

# If `units` is negative, `nanos` must be negative or zero.

6176

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6177

"units": "A String", # The whole units of the amount.

6178

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6179

},

6180

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6181

},

6182

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6183

# If empty, all advertisers with this buyer pay this price.

6184

"A String",

6185

],

6186

"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

6187

# (if the

6188

# advertisers match, and there's no more specific rule matching the buyer).

6189

# Authorized Buyers account ID.

6190

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6196

# Can be set by buyer or seller.

6197

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6198

# by the seller, but they can be returned in a get or list request.

6199

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6200

# in this private auction.

6201

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6202

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6203

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6204

# a particular buyer or buyer/advertiser pair, we look for the most specific

6205

# matching rule - we first look for a rule matching the buyer and advertiser,

6206

# next a rule with the buyer but an empty advertiser list, and otherwise look

6207

# for a matching rule where no buyer is set.

6208

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6209

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6210

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6211

"nanos": 42, # Number of nano (10^-9) units of the amount.

6212

# The value must be between -999,999,999 and +999,999,999 inclusive.

6213

# If `units` is positive, `nanos` must be positive or zero.

6214

# If `units` is zero, `nanos` can be positive, zero, or negative.

6215

# If `units` is negative, `nanos` must be negative or zero.

6216

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6217

"units": "A String", # The whole units of the amount.

6218

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6219

},

6220

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6221

},

6222

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6223

# If empty, all advertisers with this buyer pay this price.

6224

"A String",

6225

],

6226

"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

6227

# (if the

6228

# advertisers match, and there's no more specific rule matching the buyer).

6229

# Authorized Buyers account ID.

6230

"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.

6236

# Can be set by buyer or seller.

6237

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6238

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6239

"nanos": 42, # Number of nano (10^-9) units of the amount.

6240

# The value must be between -999,999,999 and +999,999,999 inclusive.

6241

# If `units` is positive, `nanos` must be positive or zero.

6242

# If `units` is zero, `nanos` can be positive, zero, or negative.

6243

# If `units` is negative, `nanos` must be negative or zero.

6244

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6245

"units": "A String", # The whole units of the amount.

6246

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6247

},

6248

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6249

},

6250

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6251

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6252

# time zone used to mark the boundaries of a day. It should be an

6253

# IANA TZ name, such as "America/Los_Angeles". For more information,

6254

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

6255

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6256

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6257

# of guaranteed looks that the buyer is guaranteeing to buy.

6258

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6259

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6260

"fixedPrices": [ # Fixed price for the specified buyer.

6261

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6262

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6263

# a particular buyer or buyer/advertiser pair, we look for the most specific

6264

# matching rule - we first look for a rule matching the buyer and advertiser,

6265

# next a rule with the buyer but an empty advertiser list, and otherwise look

6266

# for a matching rule where no buyer is set.

6267

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6268

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6269

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6270

"nanos": 42, # Number of nano (10^-9) units of the amount.

6271

# The value must be between -999,999,999 and +999,999,999 inclusive.

6272

# If `units` is positive, `nanos` must be positive or zero.

6273

# If `units` is zero, `nanos` can be positive, zero, or negative.

6274

# If `units` is negative, `nanos` must be negative or zero.

6275

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6276

"units": "A String", # The whole units of the amount.

6277

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6278

},

6279

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6280

},

6281

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6282

# If empty, all advertisers with this buyer pay this price.

6283

"A String",

6284

],

6285

"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

6286

# (if the

6287

# advertisers match, and there's no more specific rule matching the buyer).

6288

# Authorized Buyers account ID.

6289

"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]

6296

# target ad inventory. For example, they can choose to target ad requests only

6297

# if the user is in the US.

6298

# Multiple types of targeting are always applied as a logical AND, unless noted

6299

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6300

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6301

# included and excluded numeric IDs.

6302

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6303

"A String",

6304

],

6305

"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.

6310

# request. It only applies to Private Auction, AdX Preferred Deals and

6311

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6312

# and Preferred Deals in Ad Manager.

6313

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6314

{ # Represents size of a single ad slot, or a creative.

6315

"width": "A String", # The width of the ad slot in pixels.

6316

# This field will be present only when size type is `PIXEL`.

6317

"sizeType": "A String", # The size type of the ad slot.

6318

"height": "A String", # The height of the ad slot in pixels.

6319

# This field will be present only when size type is `PIXEL`.

6320

},

6321

],

6322

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6323

{ # Represents size of a single ad slot, or a creative.

6324

"width": "A String", # The width of the ad slot in pixels.

6325

# This field will be present only when size type is `PIXEL`.

6326

"sizeType": "A String", # The size type of the ad slot.

6327

"height": "A String", # The height of the ad slot in pixels.

6328

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6333

"targetedPositionTypes": [ # A list of video positions to be included.

6334

# When the included list is present, the excluded list must be empty.

6335

# When the excluded list is present, the included list must be empty.

6336

"A String",

6337

],

6338

"excludedPositionTypes": [ # A list of video positions to be excluded.

6339

# 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.

6344

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6345

# included and excluded numeric IDs.

6346

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6347

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6348

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6349

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6350

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6351

],

6352

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6353

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6354

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6355

# included and excluded numeric IDs.

6356

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6357

"A String",

6358

],

6359

"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.

6364

# included and excluded numeric IDs.

6365

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6366

"A String",

6367

],

6368

"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.

6374

# included and excluded numeric IDs.

6375

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6376

"A String",

6377

],

6378

"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.

6384

# mobile applications.

6385

# Different placement targeting types will be logically OR'ed.

6386

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6387

# For Private Auction and AdX Preferred Deals, URLs are either included or

6388

# excluded.

6389

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6390

# apply.

6391

"targetedUrls": [ # A list of URLs to be included.

6392

"A String",

6393

],

6394

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6399

# This doesn't apply to Auction Packages.

6400

"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]

6401

# display the ads in.

6402

# publishers own.

6403

# Mobile application IDs are from App Store and Google Play Store.

6404

# Android App ID, for example, com.google.android.apps.maps, can be found in

6405

# Google Play Store URL.

6406

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6407

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6408

"targetedAppIds": [ # A list of application IDs to be included.

6409

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6410

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6411

"excludedAppIds": [ # A list of application IDs to be excluded.

6412

"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]

6417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6418

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6419

"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]

6420

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6421

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

6422

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6423

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6424

"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]

6425

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6426

"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]

6427

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6428

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6429

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6430

},

6431

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6432

"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]

6433

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6434

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6435

# finalized. This is the deal ID that shows up in serving/reporting etc.

6436

"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]

6437

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6438

# in Ad Manager.

6439

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6440

# This doesn't apply to Private Auction and AdX Preferred Deals.

6441

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

6442

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6443

{ # Represents information for a creative that is associated with a Programmatic

6444

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6445

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6446

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6447

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6448

"sizeType": "A String", # The size type of the ad slot.

6449

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6450

# This field will be present only when size type is `PIXEL`.

6451

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6452

"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]

6453

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6454

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6455

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6456

"sizeType": "A String", # The size type of the ad slot.

6457

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6458

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6463

"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]

6464

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6465

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6466

"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]

6467

# The deal is considered paused if either hasBuyerPaused or

6468

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6469

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6470

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6471

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

6472

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6473

"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]

6474

},

6475

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6476

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6477

},

6478

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6479

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6480

# Each update to the proposal or the deal causes the proposal revision number

6481

# to auto-increment. The buyer keeps track of the last revision number they

6482

# know of and pass it in when making an update. If the head revision number

6483

# on the server has since incremented, then an ABORTED error is returned

6484

# during the update operation to let the buyer know that a subsequent update

6485

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6486

"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]

6487

#

6488

# Note: This field may be set only when creating the resource. Modifying

6489

# this field while updating the resource will result in an error.

6490

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6491

"subAccountId": "A String", # Optional sub-account ID for the seller.

6492

"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]

6493

# The seller account ID is then available to buyer in the product.

6494

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6495

}

6496

6497

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

6504

6505

{ # Note: this resource requires whitelisting for access. Please contact your

6506

# account manager for access to Marketplace resources.

6507

#

6508

# Represents a proposal in the Marketplace. A proposal is the unit of

6509

# negotiation between a seller and a buyer and contains deals which

6510

# are served.

6511

#

6512

# Note: you can not update, create, or otherwise modify Private

6513

# Auction or Preferred Deals deals through the API.

6514

#

6515

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6516

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

6517

#

6518

# Note: This field may be set only when creating the resource. Modifying

6519

# this field while updating the resource will result in an error.

6520

# Authorized Buyers account ID.

6521

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6522

},

6523

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

6524

"notes": [ # Output only. The notes associated with this proposal.

6525

{ # A proposal may be associated to several notes.

6526

"note": "A String", # The actual note to attach.

6527

# (max-length: 1024 unicode code units)

6528

#

6529

# Note: This field may be set only when creating the resource. Modifying

6530

# this field while updating the resource will result in an error.

6531

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

6532

"noteId": "A String", # Output only. The unique ID for the note.

6533

"createTime": "A String", # Output only. The timestamp for when this note was created.

6534

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

6535

},

6536

],

6537

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6538

# proposal.

6539

"proposalState": "A String", # Output only. The current state of the proposal.

6540

"sellerContacts": [ # Output only. Contact information for the seller.

6541

{ # Contains information on how a buyer or seller can be reached.

6542

"email": "A String", # Email address for the contact.

6543

"name": "A String", # The name of the contact.

6544

},

6545

],

6546

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

6547

# proposal.

6548

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

6549

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

6550

# left a comment.

6551

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

6552

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6553

# operations (max-length: 1024 unicode code units).

6554

},

6555

"displayName": "A String", # The name for the proposal.

6556

"buyerContacts": [ # Contact information for the buyer.

6557

{ # Contains information on how a buyer or seller can be reached.

6558

"email": "A String", # Email address for the contact.

6559

"name": "A String", # The name of the contact.

6560

},

6561

],

6562

"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.

6563

# Authorized Buyers account ID.

6564

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6565

},

6566

"updateTime": "A String", # Output only. The time when the proposal was last revised.

6567

"proposalId": "A String", # Output only. The unique ID of the proposal.

6568

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6569

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

6570

{ # A deal represents a segment of inventory for displaying ads on.

6571

# A proposal can contain multiple deals. A deal contains the terms and

6572

# targeting information that is used for serving.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6573

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6574

# PUBLISHER means creative is provided by seller and ADVERTISER means

6575

# creative is provided by buyer.

6576

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6577

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6578

# operations (max-length: 1024 unicode code units).

6579

},

6580

"displayName": "A String", # The name of the deal.

6581

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

6582

"updateTime": "A String", # Output only. The time when the deal was last updated.

6583

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6584

# targeting entity is AND'd together.

6585

{ # Advertisers can target different attributes of an ad slot. For example,

6586

# they can choose to show ads only if the user is in the U.S. Such

6587

# targeting criteria can be specified as part of Shared Targeting.

6588

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6589

# together.

6590

{ # A polymorphic targeting value used as part of Shared Targeting.

6591

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6592

# Filled in when key = GOOG_CREATIVE_SIZE

6593

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6594

# of the creative

6595

# height depend on the type of the targeting.

6596

"height": 42, # The height of the creative.

6597

"width": 42, # The width of the creative

6598

},

6599

"allowedFormats": [ # What formats are allowed by the publisher.

6600

# If this repeated field is empty then all formats are allowed.

6601

# For example, if this field contains AllowedFormatType.AUDIO then the

6602

# publisher only allows an audio ad (without any video).

6603

"A String",

6604

],

6605

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6606

# Companion sizes may be filled in only when creative_size_type = VIDEO

6607

{ # Message depicting the size of the creative. The units of width and

6608

# height depend on the type of the targeting.

6609

"height": 42, # The height of the creative.

6610

"width": 42, # The width of the creative

6611

},

6612

],

6613

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6614

# creative_size_type = CreativeSizeType.VIDEO.

6615

"creativeSizeType": "A String", # The creative size type.

6616

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6617

# only if creative_size_type = CreativeSizeType.NATIVE.

6618

},

6619

"stringValue": "A String", # The string value to include/exclude.

6620

"longValue": "A String", # The long value to include/exclude.

6621

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6622

# Filled in when the key is GOOG_DAYPART_TARGETING.

6623

# The definition of this targeting is derived from the structure

6624

# used by Ad Manager.

6625

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6626

"dayParts": [ # A list of day part targeting criterion.

6627

{ # Daypart targeting message that specifies if the ad can be shown

6628

# only during certain parts of a day/week.

6629

"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).

6630

# The start time is inclusive.

6631

# This field is not available for filtering in PQL queries.

6632

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6633

# types are google.type.Date and `google.protobuf.Timestamp`.

6634

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6635

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6636

# to allow the value "24:00:00" for scenarios like business closing time.

6637

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6638

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6639

# allow the value 60 if it allows leap-seconds.

6640

},

6641

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6642

"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

6643

# granularity). The end time is exclusive. This field is not available

6644

# for filtering in PQL queries.

6645

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6646

# types are google.type.Date and `google.protobuf.Timestamp`.

6647

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6648

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6649

# to allow the value "24:00:00" for scenarios like business closing time.

6650

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6651

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6652

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

6660

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6661

# Third parties may define their own keys.

6662

# A list of permissible keys along with the acceptable values will be

6663

# provided as part of the external documentation.

6664

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6665

# together.

6666

{ # A polymorphic targeting value used as part of Shared Targeting.

6667

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6668

# Filled in when key = GOOG_CREATIVE_SIZE

6669

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6670

# of the creative

6671

# height depend on the type of the targeting.

6672

"height": 42, # The height of the creative.

6673

"width": 42, # The width of the creative

6674

},

6675

"allowedFormats": [ # What formats are allowed by the publisher.

6676

# If this repeated field is empty then all formats are allowed.

6677

# For example, if this field contains AllowedFormatType.AUDIO then the

6678

# publisher only allows an audio ad (without any video).

6679

"A String",

6680

],

6681

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6682

# Companion sizes may be filled in only when creative_size_type = VIDEO

6683

{ # Message depicting the size of the creative. The units of width and

6684

# height depend on the type of the targeting.

6685

"height": 42, # The height of the creative.

6686

"width": 42, # The width of the creative

6687

},

6688

],

6689

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6690

# creative_size_type = CreativeSizeType.VIDEO.

6691

"creativeSizeType": "A String", # The creative size type.

6692

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6693

# only if creative_size_type = CreativeSizeType.NATIVE.

6694

},

6695

"stringValue": "A String", # The string value to include/exclude.

6696

"longValue": "A String", # The long value to include/exclude.

6697

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6698

# Filled in when the key is GOOG_DAYPART_TARGETING.

6699

# The definition of this targeting is derived from the structure

6700

# used by Ad Manager.

6701

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6702

"dayParts": [ # A list of day part targeting criterion.

6703

{ # Daypart targeting message that specifies if the ad can be shown

6704

# only during certain parts of a day/week.

6705

"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).

6706

# The start time is inclusive.

6707

# This field is not available for filtering in PQL queries.

6708

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6709

# types are google.type.Date and `google.protobuf.Timestamp`.

6710

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6711

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6712

# to allow the value "24:00:00" for scenarios like business closing time.

6713

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6714

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6715

# allow the value 60 if it allows leap-seconds.

6716

},

6717

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6718

"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

6719

# granularity). The end time is exclusive. This field is not available

6720

# for filtering in PQL queries.

6721

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6722

# types are google.type.Date and `google.protobuf.Timestamp`.

6723

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6724

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6725

# to allow the value "24:00:00" for scenarios like business closing time.

6726

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6727

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6728

# allow the value 60 if it allows leap-seconds.

},

},

],

},

},

],

},

],

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

6738

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

6739

"availableEndTime": "A String", # Proposed flight end time of the deal.

6740

# This will generally be stored in a granularity of a second.

6741

# A value is not required for Private Auction deals or Preferred Deals.

6742

"syndicationProduct": "A String", # The syndication product associated with the deal.

6743

#

6744

# Note: This field may be set only when creating the resource. Modifying

6745

# this field while updating the resource will result in an error.

6746

"createProductId": "A String", # The product ID from which this deal was created.

6747

#

6748

# Note: This field may be set only when creating the resource. Modifying

6749

# this field while updating the resource will result in an error.

6750

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6751

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6752

# deal.

6753

"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]

6754

# If present on create, and the server `product_revision` has advanced sinced

6755

# the passed-in `create_product_revision`, an `ABORTED` error will be

6756

# returned.

6757

#

6758

# Note: This field may be set only when creating the resource. Modifying

6759

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6760

"sellerContacts": [ # Output only. Seller contact information for the deal.

6761

{ # Contains information on how a buyer or seller can be reached.

6762

"email": "A String", # Email address for the contact.

6763

"name": "A String", # The name of the contact.

6764

},

6765

],

6766

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6767

# This will generally be stored in the granularity of one second since deal

6768

# serving starts at seconds boundary. Any time specified with more

6769

# granularity (e.g., in milliseconds) will be truncated towards the start of

6770

# time in seconds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6771

"createTime": "A String", # Output only. The time of the deal creation.

6772

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6773

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6774

# and expected impressions from the publisher.

6775

"description": "A String", # Publisher provided description for the terms.

6776

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6777

# the API at this time, but can be returned in a get or list request.

6778

"fixedPrices": [ # Fixed price for the specified buyer.

6779

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6780

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6781

# a particular buyer or buyer/advertiser pair, we look for the most specific

6782

# matching rule - we first look for a rule matching the buyer and advertiser,

6783

# next a rule with the buyer but an empty advertiser list, and otherwise look

6784

# for a matching rule where no buyer is set.

6785

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6786

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6787

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6788

"nanos": 42, # Number of nano (10^-9) units of the amount.

6789

# The value must be between -999,999,999 and +999,999,999 inclusive.

6790

# If `units` is positive, `nanos` must be positive or zero.

6791

# If `units` is zero, `nanos` can be positive, zero, or negative.

6792

# If `units` is negative, `nanos` must be negative or zero.

6793

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6794

"units": "A String", # The whole units of the amount.

6795

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6796

},

6797

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6798

},

6799

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6800

# If empty, all advertisers with this buyer pay this price.

6801

"A String",

6802

],

6803

"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

6804

# (if the

6805

# advertisers match, and there's no more specific rule matching the buyer).

6806

# Authorized Buyers account ID.

6807

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6813

# Can be set by buyer or seller.

6814

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6815

# by the seller, but they can be returned in a get or list request.

6816

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6817

# in this private auction.

6818

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6819

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6820

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6821

# a particular buyer or buyer/advertiser pair, we look for the most specific

6822

# matching rule - we first look for a rule matching the buyer and advertiser,

6823

# next a rule with the buyer but an empty advertiser list, and otherwise look

6824

# for a matching rule where no buyer is set.

6825

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6826

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6827

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6828

"nanos": 42, # Number of nano (10^-9) units of the amount.

6829

# The value must be between -999,999,999 and +999,999,999 inclusive.

6830

# If `units` is positive, `nanos` must be positive or zero.

6831

# If `units` is zero, `nanos` can be positive, zero, or negative.

6832

# If `units` is negative, `nanos` must be negative or zero.

6833

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6834

"units": "A String", # The whole units of the amount.

6835

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6836

},

6837

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6838

},

6839

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6840

# If empty, all advertisers with this buyer pay this price.

6841

"A String",

6842

],

6843

"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

6844

# (if the

6845

# advertisers match, and there's no more specific rule matching the buyer).

6846

# Authorized Buyers account ID.

6847

"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.

6853

# Can be set by buyer or seller.

6854

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6855

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6856

"nanos": 42, # Number of nano (10^-9) units of the amount.

6857

# The value must be between -999,999,999 and +999,999,999 inclusive.

6858

# If `units` is positive, `nanos` must be positive or zero.

6859

# If `units` is zero, `nanos` can be positive, zero, or negative.

6860

# If `units` is negative, `nanos` must be negative or zero.

6861

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6862

"units": "A String", # The whole units of the amount.

6863

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6864

},

6865

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6866

},

6867

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6868

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6869

# time zone used to mark the boundaries of a day. It should be an

6870

# IANA TZ name, such as "America/Los_Angeles". For more information,

6871

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

6872

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6873

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6874

# of guaranteed looks that the buyer is guaranteeing to buy.

6875

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6876

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6877

"fixedPrices": [ # Fixed price for the specified buyer.

6878

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6879

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6880

# a particular buyer or buyer/advertiser pair, we look for the most specific

6881

# matching rule - we first look for a rule matching the buyer and advertiser,

6882

# next a rule with the buyer but an empty advertiser list, and otherwise look

6883

# for a matching rule where no buyer is set.

6884

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6885

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6886

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6887

"nanos": 42, # Number of nano (10^-9) units of the amount.

6888

# The value must be between -999,999,999 and +999,999,999 inclusive.

6889

# If `units` is positive, `nanos` must be positive or zero.

6890

# If `units` is zero, `nanos` can be positive, zero, or negative.

6891

# If `units` is negative, `nanos` must be negative or zero.

6892

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6893

"units": "A String", # The whole units of the amount.

6894

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6895

},

6896

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6897

},

6898

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6899

# If empty, all advertisers with this buyer pay this price.

6900

"A String",

6901

],

6902

"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

6903

# (if the

6904

# advertisers match, and there's no more specific rule matching the buyer).

6905

# Authorized Buyers account ID.

6906

"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]

6913

# target ad inventory. For example, they can choose to target ad requests only

6914

# if the user is in the US.

6915

# Multiple types of targeting are always applied as a logical AND, unless noted

6916

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6917

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6918

# included and excluded numeric IDs.

6919

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6920

"A String",

6921

],

6922

"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.

6927

# request. It only applies to Private Auction, AdX Preferred Deals and

6928

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6929

# and Preferred Deals in Ad Manager.

6930

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6931

{ # Represents size of a single ad slot, or a creative.

6932

"width": "A String", # The width of the ad slot in pixels.

6933

# This field will be present only when size type is `PIXEL`.

6934

"sizeType": "A String", # The size type of the ad slot.

6935

"height": "A String", # The height of the ad slot in pixels.

6936

# This field will be present only when size type is `PIXEL`.

6937

},

6938

],

6939

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6940

{ # Represents size of a single ad slot, or a creative.

6941

"width": "A String", # The width of the ad slot in pixels.

6942

# This field will be present only when size type is `PIXEL`.

6943

"sizeType": "A String", # The size type of the ad slot.

6944

"height": "A String", # The height of the ad slot in pixels.

6945

# This field will be present only when size type is `PIXEL`.

},

],

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6950

"targetedPositionTypes": [ # A list of video positions to be included.

6951

# When the included list is present, the excluded list must be empty.

6952

# When the excluded list is present, the included list must be empty.

6953

"A String",

6954

],

6955

"excludedPositionTypes": [ # A list of video positions to be excluded.

6956

# 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.

6961

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6962

# included and excluded numeric IDs.

6963

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6964

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6965

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6966

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6967

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6968

],

6969

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6970

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6971

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6972

# included and excluded numeric IDs.

6973

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6974

"A String",

6975

],

6976

"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.

6981

# included and excluded numeric IDs.

6982

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6983

"A String",

6984

],

6985

"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.

6991

# included and excluded numeric IDs.

6992

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6993

"A String",

6994

],

6995

"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.

7001

# mobile applications.

7002

# Different placement targeting types will be logically OR'ed.

7003

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

7004

# For Private Auction and AdX Preferred Deals, URLs are either included or

7005

# excluded.

7006

# For Programmatic Guaranteed and Preferred Deals, this doesn't

7007

# apply.

7008

"targetedUrls": [ # A list of URLs to be included.

7009

"A String",

7010

],

7011

"excludedUrls": [ # A list of URLs to be excluded.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

7016

# This doesn't apply to Auction Packages.

7017

"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]

7018

# display the ads in.

7019

# publishers own.

7020

# Mobile application IDs are from App Store and Google Play Store.

7021

# Android App ID, for example, com.google.android.apps.maps, can be found in

7022

# Google Play Store URL.

7023

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

7024

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7025

"targetedAppIds": [ # A list of application IDs to be included.

7026

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7027

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7028

"excludedAppIds": [ # A list of application IDs to be excluded.

7029

"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]

7034

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7035

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

7036

"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]

7037

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7038

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

7039

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7040

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7041

"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]

7042

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7043

"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]

7044

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7045

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

7046

# which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7047

},

7048

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7049

"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]

7050

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7051

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

7052

# finalized. This is the deal ID that shows up in serving/reporting etc.

7053

"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]

7054

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

7055

# in Ad Manager.

7056

# Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7057

# This doesn't apply to Private Auction and AdX Preferred Deals.

7058

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

7059

"creativeSpecifications": [

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7060

{ # Represents information for a creative that is associated with a Programmatic

7061

# Guaranteed/Preferred Deal in Ad Manager.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7062

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

7063

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7064

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7065

"sizeType": "A String", # The size type of the ad slot.

7066

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7067

# This field will be present only when size type is `PIXEL`.

7068

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7069

"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]

7070

{ # Represents size of a single ad slot, or a creative.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7071

"width": "A String", # The width of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7072

# This field will be present only when size type is `PIXEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7073

"sizeType": "A String", # The size type of the ad slot.

7074

"height": "A String", # The height of the ad slot in pixels.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7075

# This field will be present only when size type is `PIXEL`.

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7080

"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]

7081

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7082

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

7083

"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]

7084

# The deal is considered paused if either hasBuyerPaused or

7085

# hasSellPaused is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7086

"firstPausedBy": "A String", # The role of the person who first paused this deal.

7087

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

7088

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

7089

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

7090

"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]

7091

},

7092

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7093

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7094

},

7095

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7096

"proposalRevision": "A String", # Output only. The revision number for the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7097

# Each update to the proposal or the deal causes the proposal revision number

7098

# to auto-increment. The buyer keeps track of the last revision number they

7099

# know of and pass it in when making an update. If the head revision number

7100

# on the server has since incremented, then an ABORTED error is returned

7101

# during the update operation to let the buyer know that a subsequent update

7102

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7103

"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]

7104

#

7105

# Note: This field may be set only when creating the resource. Modifying

7106

# this field while updating the resource will result in an error.

7107

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7108

"subAccountId": "A String", # Optional sub-account ID for the seller.

7109

"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]

7110

# The seller account ID is then available to buyer in the product.

7111

},

Bu Sun Kim