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

<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.proposals.html">proposals</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

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

90

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

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

96

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

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

102

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

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

108

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

109

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

110

<h3>Method Details</h3>

111

112

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

113

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

114

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

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)

121

body: object, The request body. (required)

122

The object takes the form of:

123

124

{ # Request to accept a proposal.

125

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

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.

147

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

148

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

149

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

150

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

151

},

152

],

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

# was made.

162

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

163

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

164

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

165

},

166

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

167

# proposal.

168

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

169

# Authorized Buyers account ID.

170

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

171

},

172

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

173

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

174

#

175

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

176

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

177

# Ad Manager account ID.

178

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

179

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

180

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

181

},

182

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

183

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

184

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

185

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

186

# targeting information that is used for serving.

187

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

188

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

189

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

190

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

191

# returned.

192

#

193

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

194

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

195

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

196

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

197

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

198

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

199

},

200

],

201

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

202

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

203

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

204

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

205

# time in seconds.

206

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

207

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

208

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

209

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

210

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

211

# in Ad Manager.

212

# Preferred Deal in Ad Manager.

213

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

214

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

215

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

216

"creativeSpecifications": [

217

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

218

# Guaranteed/Preferred Deal in Ad Manager.

219

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

220

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

221

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

222

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

223

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

224

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

225

},

226

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

227

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

228

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

229

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

230

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

231

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

232

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

},

],

},

],

},

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

239

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

240

# if the user is in the US.

241

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

242

# otherwise.

243

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

244

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

245

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

246

"A String",

247

],

248

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

249

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

250

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

"A String",

],

},

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

255

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

256

# included and excluded numeric IDs.

257

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

258

"A String",

259

],

260

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

"A String",

],

},

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

265

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

266

# included and excluded numeric IDs.

267

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

268

"A String",

269

],

270

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

275

# included and excluded numeric IDs.

276

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

277

"A String",

278

],

279

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

"A String",

],

},

},

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

285

# included and excluded numeric IDs.

286

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

287

"A String",

288

],

289

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

"A String",

],

},

},

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

295

# included and excluded numeric IDs.

296

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

297

"A String",

298

],

299

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

304

# mobile applications.

305

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

306

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

307

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

308

# excluded.

309

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

310

# apply.

311

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

312

"A String",

313

],

314

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

"A String",

],

},

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

319

# This doesn't apply to Auction Packages.

320

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

321

# display the ads in.

322

# publishers own.

323

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

324

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

325

# Google Play Store URL.

326

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

327

# First party mobile applications is either included or excluded.

328

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

329

"A String",

330

],

331

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

"A String",

],

},

},

},

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

338

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

339

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

340

# and Preferred Deals in Ad Manager.

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

},

349

],

350

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

351

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

352

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

353

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

354

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

355

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

356

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

},

],

},

},

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

362

#

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

{ # Frequency cap.

371

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

372

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

373

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

374

# which impressions per user are counted and capped.

375

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

376

# specified time period.

377

},

378

],

379

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

380

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

381

},

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

# and expected impressions from the publisher.

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

# for a matching rule where no buyer is set.

403

"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

404

# (if the

405

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

406

# Authorized Buyers account ID.

407

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

408

},

409

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

410

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

411

"A String",

412

],

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

},

},

},

],

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

430

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

431

},

432

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

433

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

434

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

435

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

436

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

437

# Can be set by buyer or seller.

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

# for a matching rule where no buyer is set.

447

"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

448

# (if the

449

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

450

# Authorized Buyers account ID.

451

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

452

},

453

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

454

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

455

"A String",

456

],

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

},

},

},

],

},

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

475

# Can be set by buyer or seller.

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

},

488

},

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

# for a matching rule where no buyer is set.

498

"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

499

# (if the

500

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

501

# Authorized Buyers account ID.

502

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

503

},

504

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

505

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

506

"A String",

507

],

508

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

509

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

510

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

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

},

},

},

],

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

525

# in this private auction.

526

},

527

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

528

},

529

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

530

# PUBLISHER means creative is provided by seller and ADVERTISER means

531

# creative is provided by buyer.

532

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

533

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

534

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

535

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

536

},

537

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

538

#

539

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

540

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

541

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

542

# targeting entity is AND'd together.

543

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

544

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

545

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

546

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

547

# together.

548

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

549

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

550

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

551

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

552

# Filled in when key = GOOG_CREATIVE_SIZE

553

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

554

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

555

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

556

# height depend on the type of the targeting.

557

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

558

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

559

},

560

],

561

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

562

# only if creative_size_type = CreativeSizeType.NATIVE.

563

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

564

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

565

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

566

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

567

"A String",

568

],

569

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

570

# creative_size_type = CreativeSizeType.VIDEO.

571

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

572

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

573

# of the creative

574

# height depend on the type of the targeting.

575

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

576

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

577

},

578

},

579

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

580

# Filled in when the key is GOOG_DAYPART_TARGETING.

581

# The definition of this targeting is derived from the structure

582

# used by Ad Manager.

583

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

584

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

585

# only during certain parts of a day/week.

586

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

587

"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

588

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

589

# for filtering in PQL queries.

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

},

599

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

600

# The start time is inclusive.

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

},

},

],

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

},

},

],

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

618

# together.

619

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

620

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

621

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

622

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

623

# Filled in when key = GOOG_CREATIVE_SIZE

624

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

625

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

626

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

627

# height depend on the type of the targeting.

628

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

629

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

630

},

631

],

632

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

633

# only if creative_size_type = CreativeSizeType.NATIVE.

634

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

635

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

636

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

637

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

638

"A String",

639

],

640

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

641

# creative_size_type = CreativeSizeType.VIDEO.

642

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

643

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

644

# of the creative

645

# height depend on the type of the targeting.

646

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

647

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

648

},

649

},

650

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

651

# Filled in when the key is GOOG_DAYPART_TARGETING.

652

# The definition of this targeting is derived from the structure

653

# used by Ad Manager.

654

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

655

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

656

# only during certain parts of a day/week.

657

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

658

"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

659

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

660

# for filtering in PQL queries.

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

},

670

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

671

# The start time is inclusive.

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

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

680

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

},

},

],

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

},

},

],

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

689

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

690

# Third parties may define their own keys.

691

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

692

# provided as part of the external documentation.

693

},

694

],

695

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

696

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

697

# The deal is considered paused if either hasBuyerPaused or

698

# hasSellPaused is true.

699

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

700

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

701

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

702

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

703

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

704

},

705

},

706

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

# deal.

},

],

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

711

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

712

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

713

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

714

#

715

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

716

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

717

# Authorized Buyers account ID.

718

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

719

},

720

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

721

# proposal.

722

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

723

{ # A proposal may be associated to several notes.

724

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

725

# (max-length: 1024 unicode code units)

726

#

727

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

728

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

729

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

730

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

731

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

732

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

733

},

734

],

735

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

736

# left a comment.

737

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

738

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

739

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

740

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

},

],

}</pre>

</div>

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

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)

756

body: object, The request body. (required)

757

The object takes the form of:

758

759

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

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.

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.

766

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

767

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

768

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

769

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

},

}

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.

782

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

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.

787

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

788

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

789

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

790

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

}</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.

828

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

829

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

830

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

831

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

832

},

833

],

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

# was made.

843

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

844

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

845

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

846

},

847

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

848

# proposal.

849

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

850

# Authorized Buyers account ID.

851

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

852

},

853

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

854

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

855

#

856

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

857

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

858

# Ad Manager account ID.

859

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

860

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

861

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

862

},

863

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

864

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

865

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

866

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

867

# targeting information that is used for serving.

868

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

869

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

870

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

871

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

872

# returned.

873

#

874

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

875

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

876

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

877

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

878

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

879

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

880

},

881

],

882

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

883

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

884

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

885

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

886

# time in seconds.

887

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

888

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

889

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

890

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

891

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

892

# in Ad Manager.

893

# Preferred Deal in Ad Manager.

894

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

895

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

896

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

897

"creativeSpecifications": [

898

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

899

# Guaranteed/Preferred Deal in Ad Manager.

900

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

901

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

902

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

903

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

904

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

905

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

906

},

907

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

908

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

909

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

910

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

911

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

912

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

913

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

},

],

},

],

},

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

920

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

921

# if the user is in the US.

922

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

923

# otherwise.

924

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

925

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

926

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

927

"A String",

928

],

929

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

930

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

931

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

"A String",

],

},

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

936

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

937

# included and excluded numeric IDs.

938

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

939

"A String",

940

],

941

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

"A String",

],

},

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

946

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

947

# included and excluded numeric IDs.

948

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

949

"A String",

950

],

951

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

956

# included and excluded numeric IDs.

957

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

958

"A String",

959

],

960

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

"A String",

],

},

},

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

966

# included and excluded numeric IDs.

967

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

968

"A String",

969

],

970

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

"A String",

],

},

},

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

976

# included and excluded numeric IDs.

977

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

978

"A String",

979

],

980

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

985

# mobile applications.

986

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

987

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

988

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

989

# excluded.

990

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

991

# apply.

992

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

993

"A String",

994

],

995

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

"A String",

],

},

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

1000

# This doesn't apply to Auction Packages.

1001

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

1002

# display the ads in.

1003

# publishers own.

1004

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

1005

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

1006

# Google Play Store URL.

1007

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

1008

# First party mobile applications is either included or excluded.

1009

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

1010

"A String",

1011

],

1012

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

"A String",

],

},

},

},

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

1019

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

1020

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

1021

# and Preferred Deals in Ad Manager.

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

},

1030

],

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

},

],

},

},

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

1043

#

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

{ # Frequency cap.

1052

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

1053

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

1054

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

1055

# which impressions per user are counted and capped.

1056

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

1057

# specified time period.

1058

},

1059

],

1060

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

1061

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

1062

},

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

# and expected impressions from the publisher.

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

# for a matching rule where no buyer is set.

1084

"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

1085

# (if the

1086

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

1087

# Authorized Buyers account ID.

1088

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

1089

},

1090

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

1091

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

1092

"A String",

1093

],

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

},

},

},

],

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

1111

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

1112

},

1113

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

1114

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

1115

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

1116

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

1117

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

1118

# Can be set by buyer or seller.

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

# for a matching rule where no buyer is set.

1128

"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

1129

# (if the

1130

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

1131

# Authorized Buyers account ID.

1132

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

1133

},

1134

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

1135

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

1136

"A String",

1137

],

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

},

},

},

],

},

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

1156

# Can be set by buyer or seller.

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

},

1169

},

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

# for a matching rule where no buyer is set.

1179

"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

1180

# (if the

1181

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

1182

# Authorized Buyers account ID.

1183

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

1184

},

1185

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

1186

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

1187

"A String",

1188

],

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

},

},

},

],

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

1206

# in this private auction.

1207

},

1208

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

1209

},

1210

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

1211

# PUBLISHER means creative is provided by seller and ADVERTISER means

1212

# creative is provided by buyer.

1213

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

1214

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

1215

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

1216

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

1217

},

1218

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

1219

#

1220

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

1221

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

1222

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

1223

# targeting entity is AND'd together.

1224

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

1225

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

1226

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

1227

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

1228

# together.

1229

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

1230

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

1231

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

1232

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

1233

# Filled in when key = GOOG_CREATIVE_SIZE

1234

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

1235

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

1236

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

1237

# height depend on the type of the targeting.

1238

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

1239

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

1240

},

1241

],

1242

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

1243

# only if creative_size_type = CreativeSizeType.NATIVE.

1244

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

1245

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

1246

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

1247

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

1248

"A String",

1249

],

1250

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

1251

# creative_size_type = CreativeSizeType.VIDEO.

1252

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

1253

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

1254

# of the creative

1255

# height depend on the type of the targeting.

1256

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

1257

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

1258

},

1259

},

1260

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

1261

# Filled in when the key is GOOG_DAYPART_TARGETING.

1262

# The definition of this targeting is derived from the structure

1263

# used by Ad Manager.

1264

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

1265

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

1266

# only during certain parts of a day/week.

1267

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

1268

"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

1269

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

1270

# for filtering in PQL queries.

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

},

1280

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

1281

# The start time is inclusive.

1282

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

1283

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

1284

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

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

},

},

],

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

},

},

],

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

1299

# together.

1300

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

1301

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

1302

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

1303

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

1304

# Filled in when key = GOOG_CREATIVE_SIZE

1305

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

1306

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

1307

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

1308

# height depend on the type of the targeting.

1309

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

1310

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

1311

},

1312

],

1313

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

1314

# only if creative_size_type = CreativeSizeType.NATIVE.

1315

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

1316

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

1317

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

1318

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

1319

"A String",

1320

],

1321

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

1322

# creative_size_type = CreativeSizeType.VIDEO.

1323

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

1324

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

1325

# of the creative

1326

# height depend on the type of the targeting.

1327

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

1328

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

1329

},

1330

},

1331

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

1332

# Filled in when the key is GOOG_DAYPART_TARGETING.

1333

# The definition of this targeting is derived from the structure

1334

# used by Ad Manager.

1335

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

1336

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

1337

# only during certain parts of a day/week.

1338

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

1339

"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

1340

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

1341

# for filtering in PQL queries.

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

},

1351

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

1352

# The start time is inclusive.

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

1361

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

},

},

],

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

},

},

],

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

1370

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

1371

# Third parties may define their own keys.

1372

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

1373

# provided as part of the external documentation.

1374

},

1375

],

1376

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

1377

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

1378

# The deal is considered paused if either hasBuyerPaused or

1379

# hasSellPaused is true.

1380

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

1381

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

1382

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

1383

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

1384

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

1385

},

1386

},

1387

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

# deal.

},

],

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

1392

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

1393

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

1394

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

1395

#

1396

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

1397

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

1398

# Authorized Buyers account ID.

1399

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

1400

},

1401

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

1402

# proposal.

1403

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

1404

{ # A proposal may be associated to several notes.

1405

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

1406

# (max-length: 1024 unicode code units)

1407

#

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

},

1415

],

1416

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

1417

# left a comment.

1418

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

1419

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

1420

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

1421

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

},

],

}</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

1442

{ # Request message for indicating that the proposal's setup step is complete.

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.

1464

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

1465

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

1466

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

1467

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

1468

},

1469

],

1470

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

1471

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

1472

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

1473

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

1474

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

1475

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

1476

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

1477

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

1478

# was made.

1479

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

1480

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

1481

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

1482

},

1483

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

1484

# proposal.

1485

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

1486

# Authorized Buyers account ID.

1487

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

1488

},

1489

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

1490

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

1491

#

1492

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

1493

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

1494

# Ad Manager account ID.

1495

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

1496

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

1497

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

1498

},

1499

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

1500

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

1501

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

1502

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

1503

# targeting information that is used for serving.

1504

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

1505

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

1506

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

1507

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

1508

# returned.

1509

#

1510

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

1511

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

1512

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

1513

{ # Contains information on how a buyer or seller can be reached.

1514

"email": "A String", # Email address for the contact.

1515

"name": "A String", # The name of the contact.

1516

},

1517

],

1518

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

1519

# This will generally be stored in the granularity of one second since deal

1520

# serving starts at seconds boundary. Any time specified with more

1521

# granularity (e.g., in milliseconds) will be truncated towards the start of

1522

# time in seconds.

1523

"availableEndTime": "A String", # Proposed flight end time of the deal.

1524

# This will generally be stored in a granularity of a second.

1525

# A value is not required for Private Auction deals or Preferred Deals.

1526

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

1527

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

1528

# in Ad Manager.

1529

# Preferred Deal in Ad Manager.

1530

# This doesn't apply to Private Auction and AdX Preferred Deals.

1531

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

1532

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

1533

"creativeSpecifications": [

1534

{ # Represents information for a creative that is associated with a Programmatic

1535

# Guaranteed/Preferred Deal in Ad Manager.

1536

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

1537

"width": "A String", # The width of the ad slot in pixels.

1538

# This field will be present only when size type is `PIXEL`.

1539

"sizeType": "A String", # The size type of the ad slot.

1540

"height": "A String", # The height of the ad slot in pixels.

1541

# This field will be present only when size type is `PIXEL`.

1542

},

1543

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

1544

{ # Represents size of a single ad slot, or a creative.

1545

"width": "A String", # The width of the ad slot in pixels.

1546

# This field will be present only when size type is `PIXEL`.

1547

"sizeType": "A String", # The size type of the ad slot.

1548

"height": "A String", # The height of the ad slot in pixels.

1549

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

1556

# target ad inventory. For example, they can choose to target ad requests only

1557

# if the user is in the US.

1558

# Multiple types of targeting are always applied as a logical AND, unless noted

1559

# otherwise.

1560

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

1561

"excludedPositionTypes": [ # A list of video positions to be excluded.

1562

# Position types can either be included or excluded (XOR).

1563

"A String",

1564

],

1565

"targetedPositionTypes": [ # A list of video positions to be included.

1566

# When the included list is present, the excluded list must be empty.

1567

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

1572

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

1573

# included and excluded numeric IDs.

1574

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1575

"A String",

1576

],

1577

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

1582

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

1583

# included and excluded numeric IDs.

1584

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1585

"A String",

1586

],

1587

"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.

1592

# included and excluded numeric IDs.

1593

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1594

"A String",

1595

],

1596

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

1602

# included and excluded numeric IDs.

1603

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1604

"A String",

1605

],

1606

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

1612

# included and excluded numeric IDs.

1613

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1614

"A String",

1615

],

1616

"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.

1621

# mobile applications.

1622

# Different placement targeting types will be logically OR'ed.

1623

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

1624

# For Private Auction and AdX Preferred Deals, URLs are either included or

1625

# excluded.

1626

# For Programmatic Guaranteed and Preferred Deals, this doesn't

1627

# apply.

1628

"excludedUrls": [ # A list of URLs to be excluded.

1629

"A String",

1630

],

1631

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

1636

# This doesn't apply to Auction Packages.

1637

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

1638

# display the ads in.

1639

# publishers own.

1640

# Mobile application IDs are from App Store and Google Play Store.

1641

# Android App ID, for example, com.google.android.apps.maps, can be found in

1642

# Google Play Store URL.

1643

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

1644

# First party mobile applications is either included or excluded.

1645

"excludedAppIds": [ # A list of application IDs to be excluded.

1646

"A String",

1647

],

1648

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

1655

# request. It only applies to Private Auction, AdX Preferred Deals and

1656

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

1657

# and Preferred Deals in Ad Manager.

1658

"targetedInventorySizes": [ # A list of inventory sizes to be included.

1659

{ # Represents size of a single ad slot, or a creative.

1660

"width": "A String", # The width of the ad slot in pixels.

1661

# This field will be present only when size type is `PIXEL`.

1662

"sizeType": "A String", # The size type of the ad slot.

1663

"height": "A String", # The height of the ad slot in pixels.

1664

# This field will be present only when size type is `PIXEL`.

1665

},

1666

],

1667

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

1668

{ # Represents size of a single ad slot, or a creative.

1669

"width": "A String", # The width of the ad slot in pixels.

1670

# This field will be present only when size type is `PIXEL`.

1671

"sizeType": "A String", # The size type of the ad slot.

1672

"height": "A String", # The height of the ad slot in pixels.

1673

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

1679

#

1680

# Note: This field may be set only when creating the resource. Modifying

1681

# this field while updating the resource will result in an error.

1682

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

1683

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

1684

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

1685

# to see but are non-negotiable. These are set by the publisher.

1686

"frequencyCaps": [ # Output only. Specifies any frequency caps.

1687

{ # Frequency cap.

1688

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

1689

# amount of time over which impressions per user are counted and capped.

1690

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1691

# which impressions per user are counted and capped.

1692

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

1693

# specified time period.

1694

},

1695

],

1696

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

1697

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

1698

},

1699

"description": "A String", # Description for the deal terms.

1700

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

1701

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

1702

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1703

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

1704

# finalized. This is the deal ID that shows up in serving/reporting etc.

1705

"createTime": "A String", # Output only. The time of the deal creation.

1706

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

1707

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

1708

# and expected impressions from the publisher.

1709

"description": "A String", # Publisher provided description for the terms.

1710

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

1711

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

1712

# of guaranteed looks that the buyer is guaranteeing to buy.

1713

"fixedPrices": [ # Fixed price for the specified buyer.

1714

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1715

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1716

# a particular buyer or buyer/advertiser pair, we look for the most specific

1717

# matching rule - we first look for a rule matching the buyer and advertiser,

1718

# next a rule with the buyer but an empty advertiser list, and otherwise look

1719

# for a matching rule where no buyer is set.

1720

"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

1721

# (if the

1722

# advertisers match, and there's no more specific rule matching the buyer).

1723

# Authorized Buyers account ID.

1724

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1725

},

1726

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1727

# If empty, all advertisers with this buyer pay this price.

1728

"A String",

1729

],

1730

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1731

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1732

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1733

"nanos": 42, # Number of nano (10^-9) units of the amount.

1734

# The value must be between -999,999,999 and +999,999,999 inclusive.

1735

# If `units` is positive, `nanos` must be positive or zero.

1736

# If `units` is zero, `nanos` can be positive, zero, or negative.

1737

# If `units` is negative, `nanos` must be negative or zero.

1738

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1739

"units": "A String", # The whole units of the amount.

1740

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1741

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

1747

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

1748

},

1749

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

1750

# time zone used to mark the boundaries of a day. It should be an

1751

# IANA TZ name, such as "America/Los_Angeles". For more information,

1752

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

1753

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

1754

# Can be set by buyer or seller.

1755

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

1756

# the API at this time, but can be returned in a get or list request.

1757

"fixedPrices": [ # Fixed price for the specified buyer.

1758

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1759

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1760

# a particular buyer or buyer/advertiser pair, we look for the most specific

1761

# matching rule - we first look for a rule matching the buyer and advertiser,

1762

# next a rule with the buyer but an empty advertiser list, and otherwise look

1763

# for a matching rule where no buyer is set.

1764

"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

1765

# (if the

1766

# advertisers match, and there's no more specific rule matching the buyer).

1767

# Authorized Buyers account ID.

1768

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1769

},

1770

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1771

# If empty, all advertisers with this buyer pay this price.

1772

"A String",

1773

],

1774

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1775

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1776

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1777

"nanos": 42, # Number of nano (10^-9) units of the amount.

1778

# The value must be between -999,999,999 and +999,999,999 inclusive.

1779

# If `units` is positive, `nanos` must be positive or zero.

1780

# If `units` is zero, `nanos` can be positive, zero, or negative.

1781

# If `units` is negative, `nanos` must be negative or zero.

1782

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1783

"units": "A String", # The whole units of the amount.

1784

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1785

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

1792

# Can be set by buyer or seller.

1793

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1794

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1795

"nanos": 42, # Number of nano (10^-9) units of the amount.

1796

# The value must be between -999,999,999 and +999,999,999 inclusive.

1797

# If `units` is positive, `nanos` must be positive or zero.

1798

# If `units` is zero, `nanos` can be positive, zero, or negative.

1799

# If `units` is negative, `nanos` must be negative or zero.

1800

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1801

"units": "A String", # The whole units of the amount.

1802

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1803

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1804

},

1805

},

1806

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

1807

# by the seller, but they can be returned in a get or list request.

1808

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

1809

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1810

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1811

# a particular buyer or buyer/advertiser pair, we look for the most specific

1812

# matching rule - we first look for a rule matching the buyer and advertiser,

1813

# next a rule with the buyer but an empty advertiser list, and otherwise look

1814

# for a matching rule where no buyer is set.

1815

"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

1816

# (if the

1817

# advertisers match, and there's no more specific rule matching the buyer).

1818

# Authorized Buyers account ID.

1819

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1820

},

1821

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1822

# If empty, all advertisers with this buyer pay this price.

1823

"A String",

1824

],

1825

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1826

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1827

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1828

"nanos": 42, # Number of nano (10^-9) units of the amount.

1829

# The value must be between -999,999,999 and +999,999,999 inclusive.

1830

# If `units` is positive, `nanos` must be positive or zero.

1831

# If `units` is zero, `nanos` can be positive, zero, or negative.

1832

# If `units` is negative, `nanos` must be negative or zero.

1833

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1834

"units": "A String", # The whole units of the amount.

1835

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1836

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

1842

# in this private auction.

1843

},

1844

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

1845

},

1846

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

1847

# PUBLISHER means creative is provided by seller and ADVERTISER means

1848

# creative is provided by buyer.

1849

"displayName": "A String", # The name of the deal.

1850

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

1851

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1852

# operations (max-length: 1024 unicode code units).

1853

},

1854

"syndicationProduct": "A String", # The syndication product associated with the deal.

1855

#

1856

# Note: This field may be set only when creating the resource. Modifying

1857

# this field while updating the resource will result in an error.

1858

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

1859

# targeting entity is AND'd together.

1860

{ # Advertisers can target different attributes of an ad slot. For example,

1861

# they can choose to show ads only if the user is in the U.S. Such

1862

# targeting criteria can be specified as part of Shared Targeting.

1863

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

1864

# together.

1865

{ # A polymorphic targeting value used as part of Shared Targeting.

1866

"stringValue": "A String", # The string value to include/exclude.

1867

"longValue": "A String", # The long value to include/exclude.

1868

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1869

# Filled in when key = GOOG_CREATIVE_SIZE

1870

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1871

# Companion sizes may be filled in only when creative_size_type = VIDEO

1872

{ # Message depicting the size of the creative. The units of width and

1873

# height depend on the type of the targeting.

1874

"width": 42, # The width of the creative

1875

"height": 42, # The height of the creative.

1876

},

1877

],

1878

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1879

# only if creative_size_type = CreativeSizeType.NATIVE.

1880

"allowedFormats": [ # What formats are allowed by the publisher.

1881

# If this repeated field is empty then all formats are allowed.

1882

# For example, if this field contains AllowedFormatType.AUDIO then the

1883

# publisher only allows an audio ad (without any video).

1884

"A String",

1885

],

1886

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1887

# creative_size_type = CreativeSizeType.VIDEO.

1888

"creativeSizeType": "A String", # The creative size type.

1889

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1890

# of the creative

1891

# height depend on the type of the targeting.

1892

"width": 42, # The width of the creative

1893

"height": 42, # The height of the creative.

1894

},

1895

},

1896

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1897

# Filled in when the key is GOOG_DAYPART_TARGETING.

1898

# The definition of this targeting is derived from the structure

1899

# used by Ad Manager.

1900

"dayParts": [ # A list of day part targeting criterion.

1901

{ # Daypart targeting message that specifies if the ad can be shown

1902

# only during certain parts of a day/week.

1903

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

1904

"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

1905

# granularity). The end time is exclusive. This field is not available

1906

# for filtering in PQL queries.

1907

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1908

# types are google.type.Date and `google.protobuf.Timestamp`.

1909

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1910

# allow the value 60 if it allows leap-seconds.

1911

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1912

# to allow the value "24:00:00" for scenarios like business closing time.

1913

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1914

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1915

},

1916

"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).

1917

# The start time is inclusive.

1918

# This field is not available for filtering in PQL queries.

1919

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1920

# types are google.type.Date and `google.protobuf.Timestamp`.

1921

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1922

# allow the value 60 if it allows leap-seconds.

1923

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1924

# to allow the value "24:00:00" for scenarios like business closing time.

1925

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1926

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

1935

# together.

1936

{ # A polymorphic targeting value used as part of Shared Targeting.

1937

"stringValue": "A String", # The string value to include/exclude.

1938

"longValue": "A String", # The long value to include/exclude.

1939

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1940

# Filled in when key = GOOG_CREATIVE_SIZE

1941

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1942

# Companion sizes may be filled in only when creative_size_type = VIDEO

1943

{ # Message depicting the size of the creative. The units of width and

1944

# height depend on the type of the targeting.

1945

"width": 42, # The width of the creative

1946

"height": 42, # The height of the creative.

1947

},

1948

],

1949

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1950

# only if creative_size_type = CreativeSizeType.NATIVE.

1951

"allowedFormats": [ # What formats are allowed by the publisher.

1952

# If this repeated field is empty then all formats are allowed.

1953

# For example, if this field contains AllowedFormatType.AUDIO then the

1954

# publisher only allows an audio ad (without any video).

1955

"A String",

1956

],

1957

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1958

# creative_size_type = CreativeSizeType.VIDEO.

1959

"creativeSizeType": "A String", # The creative size type.

1960

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1961

# of the creative

1962

# height depend on the type of the targeting.

1963

"width": 42, # The width of the creative

1964

"height": 42, # The height of the creative.

1965

},

1966

},

1967

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1968

# Filled in when the key is GOOG_DAYPART_TARGETING.

1969

# The definition of this targeting is derived from the structure

1970

# used by Ad Manager.

1971

"dayParts": [ # A list of day part targeting criterion.

1972

{ # Daypart targeting message that specifies if the ad can be shown

1973

# only during certain parts of a day/week.

1974

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

1975

"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

1976

# granularity). The end time is exclusive. This field is not available

1977

# for filtering in PQL queries.

1978

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1979

# types are google.type.Date and `google.protobuf.Timestamp`.

1980

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1981

# allow the value 60 if it allows leap-seconds.

1982

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1983

# to allow the value "24:00:00" for scenarios like business closing time.

1984

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1985

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1986

},

1987

"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).

1988

# The start time is inclusive.

1989

# This field is not available for filtering in PQL queries.

1990

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1991

# types are google.type.Date and `google.protobuf.Timestamp`.

1992

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1993

# allow the value 60 if it allows leap-seconds.

1994

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1995

# to allow the value "24:00:00" for scenarios like business closing time.

1996

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1997

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

2006

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2007

# Third parties may define their own keys.

2008

# A list of permissible keys along with the acceptable values will be

2009

# provided as part of the external documentation.

2010

},

2011

],

2012

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2013

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2014

# The deal is considered paused if either hasBuyerPaused or

2015

# hasSellPaused is true.

2016

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2017

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2018

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2019

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2020

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2021

},

2022

},

2023

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

2028

"displayName": "A String", # The name for the proposal.

2029

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2030

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2031

#

2032

# Note: This field may be set only when creating the resource. Modifying

2033

# this field while updating the resource will result in an error.

2034

# Authorized Buyers account ID.

2035

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2036

},

2037

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2038

# proposal.

2039

"notes": [ # Output only. The notes associated with this proposal.

2040

{ # A proposal may be associated to several notes.

2041

"note": "A String", # The actual note to attach.

2042

# (max-length: 1024 unicode code units)

2043

#

2044

# Note: This field may be set only when creating the resource. Modifying

2045

# this field while updating the resource will result in an error.

2046

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2047

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2048

"createTime": "A String", # Output only. The timestamp for when this note was created.

2049

"noteId": "A String", # Output only. The unique ID for the note.

2050

},

2051

],

2052

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2053

# left a comment.

2054

"buyerContacts": [ # Contact information for the buyer.

2055

{ # Contains information on how a buyer or seller can be reached.

2056

"email": "A String", # Email address for the contact.

2057

"name": "A String", # The name of the contact.

},

],

}</pre>

</div>

<code class="details" id="create">create(accountId, body, x__xgafv=None)</code>

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)

2070

body: object, The request body. (required)

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.

2084

"sellerContacts": [ # Output only. Contact information for the seller.

2085

{ # Contains information on how a buyer or seller can be reached.

2086

"email": "A String", # Email address for the contact.

2087

"name": "A String", # The name of the contact.

2088

},

2089

],

2090

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2091

"proposalState": "A String", # Output only. The current state of the proposal.

2092

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2093

# Each update to the proposal or the deal causes the proposal revision number

2094

# to auto-increment. The buyer keeps track of the last revision number they

2095

# know of and pass it in when making an update. If the head revision number

2096

# on the server has since incremented, then an ABORTED error is returned

2097

# during the update operation to let the buyer know that a subsequent update

2098

# was made.

2099

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2100

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2101

# operations (max-length: 1024 unicode code units).

2102

},

2103

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2104

# proposal.

2105

"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.

2106

# Authorized Buyers account ID.

2107

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2108

},

2109

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2110

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

2111

#

2112

# Note: This field may be set only when creating the resource. Modifying

2113

# this field while updating the resource will result in an error.

2114

# Ad Manager account ID.

2115

"subAccountId": "A String", # Optional sub-account ID for the seller.

2116

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

2117

# The seller account ID is then available to buyer in the product.

2118

},

2119

"deals": [ # The deals associated with this proposal. For Private Auction proposals

2120

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2121

{ # A deal represents a segment of inventory for displaying ads on.

2122

# A proposal can contain multiple deals. A deal contains the terms and

2123

# targeting information that is used for serving.

2124

"updateTime": "A String", # Output only. The time when the deal was last updated.

2125

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

2126

# If present on create, and the server `product_revision` has advanced sinced

2127

# the passed-in `create_product_revision`, an `ABORTED` error will be

2128

# returned.

2129

#

2130

# Note: This field may be set only when creating the resource. Modifying

2131

# this field while updating the resource will result in an error.

2132

"sellerContacts": [ # Output only. Seller contact information for the deal.

2133

{ # Contains information on how a buyer or seller can be reached.

2134

"email": "A String", # Email address for the contact.

2135

"name": "A String", # The name of the contact.

2136

},

2137

],

2138

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

2139

# This will generally be stored in the granularity of one second since deal

2140

# serving starts at seconds boundary. Any time specified with more

2141

# granularity (e.g., in milliseconds) will be truncated towards the start of

2142

# time in seconds.

2143

"availableEndTime": "A String", # Proposed flight end time of the deal.

2144

# This will generally be stored in a granularity of a second.

2145

# A value is not required for Private Auction deals or Preferred Deals.

2146

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2147

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2148

# in Ad Manager.

2149

# Preferred Deal in Ad Manager.

2150

# This doesn't apply to Private Auction and AdX Preferred Deals.

2151

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2152

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2153

"creativeSpecifications": [

2154

{ # Represents information for a creative that is associated with a Programmatic

2155

# Guaranteed/Preferred Deal in Ad Manager.

2156

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2157

"width": "A String", # The width of the ad slot in pixels.

2158

# This field will be present only when size type is `PIXEL`.

2159

"sizeType": "A String", # The size type of the ad slot.

2160

"height": "A String", # The height of the ad slot in pixels.

2161

# This field will be present only when size type is `PIXEL`.

2162

},

2163

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2164

{ # Represents size of a single ad slot, or a creative.

2165

"width": "A String", # The width of the ad slot in pixels.

2166

# This field will be present only when size type is `PIXEL`.

2167

"sizeType": "A String", # The size type of the ad slot.

2168

"height": "A String", # The height of the ad slot in pixels.

2169

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

2176

# target ad inventory. For example, they can choose to target ad requests only

2177

# if the user is in the US.

2178

# Multiple types of targeting are always applied as a logical AND, unless noted

2179

# otherwise.

2180

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2181

"excludedPositionTypes": [ # A list of video positions to be excluded.

2182

# Position types can either be included or excluded (XOR).

2183

"A String",

2184

],

2185

"targetedPositionTypes": [ # A list of video positions to be included.

2186

# When the included list is present, the excluded list must be empty.

2187

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

2192

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

2193

# included and excluded numeric IDs.

2194

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2195

"A String",

2196

],

2197

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2202

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2203

# included and excluded numeric IDs.

2204

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2205

"A String",

2206

],

2207

"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.

2212

# included and excluded numeric IDs.

2213

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2214

"A String",

2215

],

2216

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2222

# included and excluded numeric IDs.

2223

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2224

"A String",

2225

],

2226

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2232

# included and excluded numeric IDs.

2233

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2234

"A String",

2235

],

2236

"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.

2241

# mobile applications.

2242

# Different placement targeting types will be logically OR'ed.

2243

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2244

# For Private Auction and AdX Preferred Deals, URLs are either included or

2245

# excluded.

2246

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2247

# apply.

2248

"excludedUrls": [ # A list of URLs to be excluded.

2249

"A String",

2250

],

2251

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2256

# This doesn't apply to Auction Packages.

2257

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

2258

# display the ads in.

2259

# publishers own.

2260

# Mobile application IDs are from App Store and Google Play Store.

2261

# Android App ID, for example, com.google.android.apps.maps, can be found in

2262

# Google Play Store URL.

2263

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2264

# First party mobile applications is either included or excluded.

2265

"excludedAppIds": [ # A list of application IDs to be excluded.

2266

"A String",

2267

],

2268

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

2275

# request. It only applies to Private Auction, AdX Preferred Deals and

2276

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2277

# and Preferred Deals in Ad Manager.

2278

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2279

{ # Represents size of a single ad slot, or a creative.

2280

"width": "A String", # The width of the ad slot in pixels.

2281

# This field will be present only when size type is `PIXEL`.

2282

"sizeType": "A String", # The size type of the ad slot.

2283

"height": "A String", # The height of the ad slot in pixels.

2284

# This field will be present only when size type is `PIXEL`.

2285

},

2286

],

2287

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2288

{ # Represents size of a single ad slot, or a creative.

2289

"width": "A String", # The width of the ad slot in pixels.

2290

# This field will be present only when size type is `PIXEL`.

2291

"sizeType": "A String", # The size type of the ad slot.

2292

"height": "A String", # The height of the ad slot in pixels.

2293

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

2299

#

2300

# Note: This field may be set only when creating the resource. Modifying

2301

# this field while updating the resource will result in an error.

2302

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

2303

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

2304

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

2305

# to see but are non-negotiable. These are set by the publisher.

2306

"frequencyCaps": [ # Output only. Specifies any frequency caps.

2307

{ # Frequency cap.

2308

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

2309

# amount of time over which impressions per user are counted and capped.

2310

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2311

# which impressions per user are counted and capped.

2312

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

2313

# specified time period.

2314

},

2315

],

2316

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

2317

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

2318

},

2319

"description": "A String", # Description for the deal terms.

2320

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2321

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2322

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2323

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2324

# finalized. This is the deal ID that shows up in serving/reporting etc.

2325

"createTime": "A String", # Output only. The time of the deal creation.

2326

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2327

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2328

# and expected impressions from the publisher.

2329

"description": "A String", # Publisher provided description for the terms.

2330

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2331

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2332

# of guaranteed looks that the buyer is guaranteeing to buy.

2333

"fixedPrices": [ # Fixed price for the specified buyer.

2334

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2335

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2336

# a particular buyer or buyer/advertiser pair, we look for the most specific

2337

# matching rule - we first look for a rule matching the buyer and advertiser,

2338

# next a rule with the buyer but an empty advertiser list, and otherwise look

2339

# for a matching rule where no buyer is set.

2340

"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

2341

# (if the

2342

# advertisers match, and there's no more specific rule matching the buyer).

2343

# Authorized Buyers account ID.

2344

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2345

},

2346

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2347

# If empty, all advertisers with this buyer pay this price.

2348

"A String",

2349

],

2350

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2351

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2352

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2353

"nanos": 42, # Number of nano (10^-9) units of the amount.

2354

# The value must be between -999,999,999 and +999,999,999 inclusive.

2355

# If `units` is positive, `nanos` must be positive or zero.

2356

# If `units` is zero, `nanos` can be positive, zero, or negative.

2357

# If `units` is negative, `nanos` must be negative or zero.

2358

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2359

"units": "A String", # The whole units of the amount.

2360

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2361

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

2367

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2368

},

2369

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2370

# time zone used to mark the boundaries of a day. It should be an

2371

# IANA TZ name, such as "America/Los_Angeles". For more information,

2372

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

2373

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2374

# Can be set by buyer or seller.

2375

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2376

# the API at this time, but can be returned in a get or list request.

2377

"fixedPrices": [ # Fixed price for the specified buyer.

2378

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2379

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2380

# a particular buyer or buyer/advertiser pair, we look for the most specific

2381

# matching rule - we first look for a rule matching the buyer and advertiser,

2382

# next a rule with the buyer but an empty advertiser list, and otherwise look

2383

# for a matching rule where no buyer is set.

2384

"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

2385

# (if the

2386

# advertisers match, and there's no more specific rule matching the buyer).

2387

# Authorized Buyers account ID.

2388

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2389

},

2390

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2391

# If empty, all advertisers with this buyer pay this price.

2392

"A String",

2393

],

2394

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2395

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2396

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2397

"nanos": 42, # Number of nano (10^-9) units of the amount.

2398

# The value must be between -999,999,999 and +999,999,999 inclusive.

2399

# If `units` is positive, `nanos` must be positive or zero.

2400

# If `units` is zero, `nanos` can be positive, zero, or negative.

2401

# If `units` is negative, `nanos` must be negative or zero.

2402

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2403

"units": "A String", # The whole units of the amount.

2404

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2405

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

2412

# Can be set by buyer or seller.

2413

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2414

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2415

"nanos": 42, # Number of nano (10^-9) units of the amount.

2416

# The value must be between -999,999,999 and +999,999,999 inclusive.

2417

# If `units` is positive, `nanos` must be positive or zero.

2418

# If `units` is zero, `nanos` can be positive, zero, or negative.

2419

# If `units` is negative, `nanos` must be negative or zero.

2420

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2421

"units": "A String", # The whole units of the amount.

2422

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2423

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2424

},

2425

},

2426

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

2427

# by the seller, but they can be returned in a get or list request.

2428

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

2429

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2430

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2431

# a particular buyer or buyer/advertiser pair, we look for the most specific

2432

# matching rule - we first look for a rule matching the buyer and advertiser,

2433

# next a rule with the buyer but an empty advertiser list, and otherwise look

2434

# for a matching rule where no buyer is set.

2435

"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

2436

# (if the

2437

# advertisers match, and there's no more specific rule matching the buyer).

2438

# Authorized Buyers account ID.

2439

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2440

},

2441

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2442

# If empty, all advertisers with this buyer pay this price.

2443

"A String",

2444

],

2445

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2446

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2447

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2448

"nanos": 42, # Number of nano (10^-9) units of the amount.

2449

# The value must be between -999,999,999 and +999,999,999 inclusive.

2450

# If `units` is positive, `nanos` must be positive or zero.

2451

# If `units` is zero, `nanos` can be positive, zero, or negative.

2452

# If `units` is negative, `nanos` must be negative or zero.

2453

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2454

"units": "A String", # The whole units of the amount.

2455

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2456

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

2462

# in this private auction.

2463

},

2464

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

2465

},

2466

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2467

# PUBLISHER means creative is provided by seller and ADVERTISER means

2468

# creative is provided by buyer.

2469

"displayName": "A String", # The name of the deal.

2470

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2471

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2472

# operations (max-length: 1024 unicode code units).

2473

},

2474

"syndicationProduct": "A String", # The syndication product associated with the deal.

2475

#

2476

# Note: This field may be set only when creating the resource. Modifying

2477

# this field while updating the resource will result in an error.

2478

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2479

# targeting entity is AND'd together.

2480

{ # Advertisers can target different attributes of an ad slot. For example,

2481

# they can choose to show ads only if the user is in the U.S. Such

2482

# targeting criteria can be specified as part of Shared Targeting.

2483

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2484

# together.

2485

{ # A polymorphic targeting value used as part of Shared Targeting.

2486

"stringValue": "A String", # The string value to include/exclude.

2487

"longValue": "A String", # The long value to include/exclude.

2488

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2489

# Filled in when key = GOOG_CREATIVE_SIZE

2490

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2491

# Companion sizes may be filled in only when creative_size_type = VIDEO

2492

{ # Message depicting the size of the creative. The units of width and

2493

# height depend on the type of the targeting.

2494

"width": 42, # The width of the creative

2495

"height": 42, # The height of the creative.

2496

},

2497

],

2498

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2499

# only if creative_size_type = CreativeSizeType.NATIVE.

2500

"allowedFormats": [ # What formats are allowed by the publisher.

2501

# If this repeated field is empty then all formats are allowed.

2502

# For example, if this field contains AllowedFormatType.AUDIO then the

2503

# publisher only allows an audio ad (without any video).

2504

"A String",

2505

],

2506

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2507

# creative_size_type = CreativeSizeType.VIDEO.

2508

"creativeSizeType": "A String", # The creative size type.

2509

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2510

# of the creative

2511

# height depend on the type of the targeting.

2512

"width": 42, # The width of the creative

2513

"height": 42, # The height of the creative.

2514

},

2515

},

2516

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2517

# Filled in when the key is GOOG_DAYPART_TARGETING.

2518

# The definition of this targeting is derived from the structure

2519

# used by Ad Manager.

2520

"dayParts": [ # A list of day part targeting criterion.

2521

{ # Daypart targeting message that specifies if the ad can be shown

2522

# only during certain parts of a day/week.

2523

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2524

"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

2525

# granularity). The end time is exclusive. This field is not available

2526

# for filtering in PQL queries.

2527

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2528

# types are google.type.Date and `google.protobuf.Timestamp`.

2529

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2530

# allow the value 60 if it allows leap-seconds.

2531

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2532

# to allow the value "24:00:00" for scenarios like business closing time.

2533

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2534

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2535

},

2536

"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).

2537

# The start time is inclusive.

2538

# This field is not available for filtering in PQL queries.

2539

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2540

# types are google.type.Date and `google.protobuf.Timestamp`.

2541

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2542

# allow the value 60 if it allows leap-seconds.

2543

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2544

# to allow the value "24:00:00" for scenarios like business closing time.

2545

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2546

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2555

# together.

2556

{ # A polymorphic targeting value used as part of Shared Targeting.

2557

"stringValue": "A String", # The string value to include/exclude.

2558

"longValue": "A String", # The long value to include/exclude.

2559

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2560

# Filled in when key = GOOG_CREATIVE_SIZE

2561

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2562

# Companion sizes may be filled in only when creative_size_type = VIDEO

2563

{ # Message depicting the size of the creative. The units of width and

2564

# height depend on the type of the targeting.

2565

"width": 42, # The width of the creative

2566

"height": 42, # The height of the creative.

2567

},

2568

],

2569

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2570

# only if creative_size_type = CreativeSizeType.NATIVE.

2571

"allowedFormats": [ # What formats are allowed by the publisher.

2572

# If this repeated field is empty then all formats are allowed.

2573

# For example, if this field contains AllowedFormatType.AUDIO then the

2574

# publisher only allows an audio ad (without any video).

2575

"A String",

2576

],

2577

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2578

# creative_size_type = CreativeSizeType.VIDEO.

2579

"creativeSizeType": "A String", # The creative size type.

2580

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2581

# of the creative

2582

# height depend on the type of the targeting.

2583

"width": 42, # The width of the creative

2584

"height": 42, # The height of the creative.

2585

},

2586

},

2587

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2588

# Filled in when the key is GOOG_DAYPART_TARGETING.

2589

# The definition of this targeting is derived from the structure

2590

# used by Ad Manager.

2591

"dayParts": [ # A list of day part targeting criterion.

2592

{ # Daypart targeting message that specifies if the ad can be shown

2593

# only during certain parts of a day/week.

2594

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

2595

"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

2596

# granularity). The end time is exclusive. This field is not available

2597

# for filtering in PQL queries.

2598

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2599

# types are google.type.Date and `google.protobuf.Timestamp`.

2600

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2601

# allow the value 60 if it allows leap-seconds.

2602

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2603

# to allow the value "24:00:00" for scenarios like business closing time.

2604

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2605

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2606

},

2607

"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).

2608

# The start time is inclusive.

2609

# This field is not available for filtering in PQL queries.

2610

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2611

# types are google.type.Date and `google.protobuf.Timestamp`.

2612

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2613

# allow the value 60 if it allows leap-seconds.

2614

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2615

# to allow the value "24:00:00" for scenarios like business closing time.

2616

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2617

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

2626

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2627

# Third parties may define their own keys.

2628

# A list of permissible keys along with the acceptable values will be

2629

# provided as part of the external documentation.

2630

},

2631

],

2632

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2633

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2634

# The deal is considered paused if either hasBuyerPaused or

2635

# hasSellPaused is true.

2636

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2637

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2638

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2639

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2640

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2641

},

2642

},

2643

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

2648

"displayName": "A String", # The name for the proposal.

2649

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2650

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2651

#

2652

# Note: This field may be set only when creating the resource. Modifying

2653

# this field while updating the resource will result in an error.

2654

# Authorized Buyers account ID.

2655

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2656

},

2657

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2658

# proposal.

2659

"notes": [ # Output only. The notes associated with this proposal.

2660

{ # A proposal may be associated to several notes.

2661

"note": "A String", # The actual note to attach.

2662

# (max-length: 1024 unicode code units)

2663

#

2664

# Note: This field may be set only when creating the resource. Modifying

2665

# this field while updating the resource will result in an error.

2666

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2667

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2668

"createTime": "A String", # Output only. The timestamp for when this note was created.

2669

"noteId": "A String", # Output only. The unique ID for the note.

2670

},

2671

],

2672

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2673

# left a comment.

2674

"buyerContacts": [ # Contact information for the buyer.

2675

{ # Contains information on how a buyer or seller can be reached.

2676

"email": "A String", # Email address for the contact.

2677

"name": "A String", # The name of the contact.

},

],

}

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.

2701

"sellerContacts": [ # Output only. Contact information for the seller.

2702

{ # Contains information on how a buyer or seller can be reached.

2703

"email": "A String", # Email address for the contact.

2704

"name": "A String", # The name of the contact.

2705

},

2706

],

2707

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2708

"proposalState": "A String", # Output only. The current state of the proposal.

2709

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2710

# Each update to the proposal or the deal causes the proposal revision number

2711

# to auto-increment. The buyer keeps track of the last revision number they

2712

# know of and pass it in when making an update. If the head revision number

2713

# on the server has since incremented, then an ABORTED error is returned

2714

# during the update operation to let the buyer know that a subsequent update

2715

# was made.

2716

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2717

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2718

# operations (max-length: 1024 unicode code units).

2719

},

2720

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2721

# proposal.

2722

"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.

2723

# Authorized Buyers account ID.

2724

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2725

},

2726

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2727

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

2728

#

2729

# Note: This field may be set only when creating the resource. Modifying

2730

# this field while updating the resource will result in an error.

2731

# Ad Manager account ID.

2732

"subAccountId": "A String", # Optional sub-account ID for the seller.

2733

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

2734

# The seller account ID is then available to buyer in the product.

2735

},

2736

"deals": [ # The deals associated with this proposal. For Private Auction proposals

2737

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2738

{ # A deal represents a segment of inventory for displaying ads on.

2739

# A proposal can contain multiple deals. A deal contains the terms and

2740

# targeting information that is used for serving.

2741

"updateTime": "A String", # Output only. The time when the deal was last updated.

2742

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

2743

# If present on create, and the server `product_revision` has advanced sinced

2744

# the passed-in `create_product_revision`, an `ABORTED` error will be

2745

# returned.

2746

#

2747

# Note: This field may be set only when creating the resource. Modifying

2748

# this field while updating the resource will result in an error.

2749

"sellerContacts": [ # Output only. Seller contact information for the deal.

2750

{ # Contains information on how a buyer or seller can be reached.

2751

"email": "A String", # Email address for the contact.

2752

"name": "A String", # The name of the contact.

2753

},

2754

],

2755

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

2756

# This will generally be stored in the granularity of one second since deal

2757

# serving starts at seconds boundary. Any time specified with more

2758

# granularity (e.g., in milliseconds) will be truncated towards the start of

2759

# time in seconds.

2760

"availableEndTime": "A String", # Proposed flight end time of the deal.

2761

# This will generally be stored in a granularity of a second.

2762

# A value is not required for Private Auction deals or Preferred Deals.

2763

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2764

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2765

# in Ad Manager.

2766

# Preferred Deal in Ad Manager.

2767

# This doesn't apply to Private Auction and AdX Preferred Deals.

2768

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2769

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2770

"creativeSpecifications": [

2771

{ # Represents information for a creative that is associated with a Programmatic

2772

# Guaranteed/Preferred Deal in Ad Manager.

2773

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2774

"width": "A String", # The width of the ad slot in pixels.

2775

# This field will be present only when size type is `PIXEL`.

2776

"sizeType": "A String", # The size type of the ad slot.

2777

"height": "A String", # The height of the ad slot in pixels.

2778

# This field will be present only when size type is `PIXEL`.

2779

},

2780

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2781

{ # Represents size of a single ad slot, or a creative.

2782

"width": "A String", # The width of the ad slot in pixels.

2783

# This field will be present only when size type is `PIXEL`.

2784

"sizeType": "A String", # The size type of the ad slot.

2785

"height": "A String", # The height of the ad slot in pixels.

2786

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

2793

# target ad inventory. For example, they can choose to target ad requests only

2794

# if the user is in the US.

2795

# Multiple types of targeting are always applied as a logical AND, unless noted

2796

# otherwise.

2797

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2798

"excludedPositionTypes": [ # A list of video positions to be excluded.

2799

# Position types can either be included or excluded (XOR).

2800

"A String",

2801

],

2802

"targetedPositionTypes": [ # A list of video positions to be included.

2803

# When the included list is present, the excluded list must be empty.

2804

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

2809

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

2810

# included and excluded numeric IDs.

2811

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2812

"A String",

2813

],

2814

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2819

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2820

# included and excluded numeric IDs.

2821

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2822

"A String",

2823

],

2824

"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.

2829

# included and excluded numeric IDs.

2830

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2831

"A String",

2832

],

2833

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2839

# included and excluded numeric IDs.

2840

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2841

"A String",

2842

],

2843

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2849

# included and excluded numeric IDs.

2850

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2851

"A String",

2852

],

2853

"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.

2858

# mobile applications.

2859

# Different placement targeting types will be logically OR'ed.

2860

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2861

# For Private Auction and AdX Preferred Deals, URLs are either included or

2862

# excluded.

2863

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2864

# apply.

2865

"excludedUrls": [ # A list of URLs to be excluded.

2866

"A String",

2867

],

2868

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2873

# This doesn't apply to Auction Packages.

2874

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

2875

# display the ads in.

2876

# publishers own.

2877

# Mobile application IDs are from App Store and Google Play Store.

2878

# Android App ID, for example, com.google.android.apps.maps, can be found in

2879

# Google Play Store URL.

2880

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2881

# First party mobile applications is either included or excluded.

2882

"excludedAppIds": [ # A list of application IDs to be excluded.

2883

"A String",

2884

],

2885

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

2892

# request. It only applies to Private Auction, AdX Preferred Deals and

2893

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2894

# and Preferred Deals in Ad Manager.

2895

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2896

{ # Represents size of a single ad slot, or a creative.

2897

"width": "A String", # The width of the ad slot in pixels.

2898

# This field will be present only when size type is `PIXEL`.

2899

"sizeType": "A String", # The size type of the ad slot.

2900

"height": "A String", # The height of the ad slot in pixels.

2901

# This field will be present only when size type is `PIXEL`.

2902

},

2903

],

2904

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2905

{ # Represents size of a single ad slot, or a creative.

2906

"width": "A String", # The width of the ad slot in pixels.

2907

# This field will be present only when size type is `PIXEL`.

2908

"sizeType": "A String", # The size type of the ad slot.

2909

"height": "A String", # The height of the ad slot in pixels.

2910

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

2916

#

2917

# Note: This field may be set only when creating the resource. Modifying

2918

# this field while updating the resource will result in an error.

2919

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

2920

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

2921

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

2922

# to see but are non-negotiable. These are set by the publisher.

2923

"frequencyCaps": [ # Output only. Specifies any frequency caps.

2924

{ # Frequency cap.

2925

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

2926

# amount of time over which impressions per user are counted and capped.

2927

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2928

# which impressions per user are counted and capped.

2929

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

2930

# specified time period.

2931

},

2932

],

2933

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

2934

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

2935

},

2936

"description": "A String", # Description for the deal terms.

2937

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2938

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2939

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2940

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2941

# finalized. This is the deal ID that shows up in serving/reporting etc.

2942

"createTime": "A String", # Output only. The time of the deal creation.

2943

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2944

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2945

# and expected impressions from the publisher.

2946

"description": "A String", # Publisher provided description for the terms.

2947

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2948

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2949

# of guaranteed looks that the buyer is guaranteeing to buy.

2950

"fixedPrices": [ # Fixed price for the specified buyer.

2951

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2952

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2953

# a particular buyer or buyer/advertiser pair, we look for the most specific

2954

# matching rule - we first look for a rule matching the buyer and advertiser,

2955

# next a rule with the buyer but an empty advertiser list, and otherwise look

2956

# for a matching rule where no buyer is set.

2957

"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

2958

# (if the

2959

# advertisers match, and there's no more specific rule matching the buyer).

2960

# Authorized Buyers account ID.

2961

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2962

},

2963

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2964

# If empty, all advertisers with this buyer pay this price.

2965

"A String",

2966

],

2967

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2968

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2969

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2970

"nanos": 42, # Number of nano (10^-9) units of the amount.

2971

# The value must be between -999,999,999 and +999,999,999 inclusive.

2972

# If `units` is positive, `nanos` must be positive or zero.

2973

# If `units` is zero, `nanos` can be positive, zero, or negative.

2974

# If `units` is negative, `nanos` must be negative or zero.

2975

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2976

"units": "A String", # The whole units of the amount.

2977

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2978

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

2984

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2985

},

2986

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2987

# time zone used to mark the boundaries of a day. It should be an

2988

# IANA TZ name, such as "America/Los_Angeles". For more information,

2989

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

2990

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2991

# Can be set by buyer or seller.

2992

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2993

# the API at this time, but can be returned in a get or list request.

2994

"fixedPrices": [ # Fixed price for the specified buyer.

2995

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2996

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2997

# a particular buyer or buyer/advertiser pair, we look for the most specific

2998

# matching rule - we first look for a rule matching the buyer and advertiser,

2999

# next a rule with the buyer but an empty advertiser list, and otherwise look

3000

# for a matching rule where no buyer is set.

3001

"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

3002

# (if the

3003

# advertisers match, and there's no more specific rule matching the buyer).

3004

# Authorized Buyers account ID.

3005

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3006

},

3007

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3008

# If empty, all advertisers with this buyer pay this price.

3009

"A String",

3010

],

3011

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3012

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3013

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3014

"nanos": 42, # Number of nano (10^-9) units of the amount.

3015

# The value must be between -999,999,999 and +999,999,999 inclusive.

3016

# If `units` is positive, `nanos` must be positive or zero.

3017

# If `units` is zero, `nanos` can be positive, zero, or negative.

3018

# If `units` is negative, `nanos` must be negative or zero.

3019

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3020

"units": "A String", # The whole units of the amount.

3021

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3022

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

3029

# Can be set by buyer or seller.

3030

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3031

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3032

"nanos": 42, # Number of nano (10^-9) units of the amount.

3033

# The value must be between -999,999,999 and +999,999,999 inclusive.

3034

# If `units` is positive, `nanos` must be positive or zero.

3035

# If `units` is zero, `nanos` can be positive, zero, or negative.

3036

# If `units` is negative, `nanos` must be negative or zero.

3037

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3038

"units": "A String", # The whole units of the amount.

3039

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3040

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3041

},

3042

},

3043

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3044

# by the seller, but they can be returned in a get or list request.

3045

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3046

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3047

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3048

# a particular buyer or buyer/advertiser pair, we look for the most specific

3049

# matching rule - we first look for a rule matching the buyer and advertiser,

3050

# next a rule with the buyer but an empty advertiser list, and otherwise look

3051

# for a matching rule where no buyer is set.

3052

"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

3053

# (if the

3054

# advertisers match, and there's no more specific rule matching the buyer).

3055

# Authorized Buyers account ID.

3056

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3057

},

3058

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3059

# If empty, all advertisers with this buyer pay this price.

3060

"A String",

3061

],

3062

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3063

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3064

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3065

"nanos": 42, # Number of nano (10^-9) units of the amount.

3066

# The value must be between -999,999,999 and +999,999,999 inclusive.

3067

# If `units` is positive, `nanos` must be positive or zero.

3068

# If `units` is zero, `nanos` can be positive, zero, or negative.

3069

# If `units` is negative, `nanos` must be negative or zero.

3070

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3071

"units": "A String", # The whole units of the amount.

3072

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3073

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

3079

# in this private auction.

3080

},

3081

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3082

},

3083

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3084

# PUBLISHER means creative is provided by seller and ADVERTISER means

3085

# creative is provided by buyer.

3086

"displayName": "A String", # The name of the deal.

3087

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3088

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3089

# operations (max-length: 1024 unicode code units).

3090

},

3091

"syndicationProduct": "A String", # The syndication product associated with the deal.

3092

#

3093

# Note: This field may be set only when creating the resource. Modifying

3094

# this field while updating the resource will result in an error.

3095

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3096

# targeting entity is AND'd together.

3097

{ # Advertisers can target different attributes of an ad slot. For example,

3098

# they can choose to show ads only if the user is in the U.S. Such

3099

# targeting criteria can be specified as part of Shared Targeting.

3100

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

3101

# together.

3102

{ # A polymorphic targeting value used as part of Shared Targeting.

3103

"stringValue": "A String", # The string value to include/exclude.

3104

"longValue": "A String", # The long value to include/exclude.

3105

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3106

# Filled in when key = GOOG_CREATIVE_SIZE

3107

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3108

# Companion sizes may be filled in only when creative_size_type = VIDEO

3109

{ # Message depicting the size of the creative. The units of width and

3110

# height depend on the type of the targeting.

3111

"width": 42, # The width of the creative

3112

"height": 42, # The height of the creative.

3113

},

3114

],

3115

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3116

# only if creative_size_type = CreativeSizeType.NATIVE.

3117

"allowedFormats": [ # What formats are allowed by the publisher.

3118

# If this repeated field is empty then all formats are allowed.

3119

# For example, if this field contains AllowedFormatType.AUDIO then the

3120

# publisher only allows an audio ad (without any video).

3121

"A String",

3122

],

3123

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3124

# creative_size_type = CreativeSizeType.VIDEO.

3125

"creativeSizeType": "A String", # The creative size type.

3126

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3127

# of the creative

3128

# height depend on the type of the targeting.

3129

"width": 42, # The width of the creative

3130

"height": 42, # The height of the creative.

3131

},

3132

},

3133

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3134

# Filled in when the key is GOOG_DAYPART_TARGETING.

3135

# The definition of this targeting is derived from the structure

3136

# used by Ad Manager.

3137

"dayParts": [ # A list of day part targeting criterion.

3138

{ # Daypart targeting message that specifies if the ad can be shown

3139

# only during certain parts of a day/week.

3140

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3141

"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

3142

# granularity). The end time is exclusive. This field is not available

3143

# for filtering in PQL queries.

3144

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3145

# types are google.type.Date and `google.protobuf.Timestamp`.

3146

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3147

# allow the value 60 if it allows leap-seconds.

3148

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3149

# to allow the value "24:00:00" for scenarios like business closing time.

3150

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3151

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3152

},

3153

"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).

3154

# The start time is inclusive.

3155

# This field is not available for filtering in PQL queries.

3156

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3157

# types are google.type.Date and `google.protobuf.Timestamp`.

3158

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3159

# allow the value 60 if it allows leap-seconds.

3160

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3161

# to allow the value "24:00:00" for scenarios like business closing time.

3162

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3163

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3172

# together.

3173

{ # A polymorphic targeting value used as part of Shared Targeting.

3174

"stringValue": "A String", # The string value to include/exclude.

3175

"longValue": "A String", # The long value to include/exclude.

3176

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3177

# Filled in when key = GOOG_CREATIVE_SIZE

3178

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3179

# Companion sizes may be filled in only when creative_size_type = VIDEO

3180

{ # Message depicting the size of the creative. The units of width and

3181

# height depend on the type of the targeting.

3182

"width": 42, # The width of the creative

3183

"height": 42, # The height of the creative.

3184

},

3185

],

3186

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3187

# only if creative_size_type = CreativeSizeType.NATIVE.

3188

"allowedFormats": [ # What formats are allowed by the publisher.

3189

# If this repeated field is empty then all formats are allowed.

3190

# For example, if this field contains AllowedFormatType.AUDIO then the

3191

# publisher only allows an audio ad (without any video).

3192

"A String",

3193

],

3194

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3195

# creative_size_type = CreativeSizeType.VIDEO.

3196

"creativeSizeType": "A String", # The creative size type.

3197

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3198

# of the creative

3199

# height depend on the type of the targeting.

3200

"width": 42, # The width of the creative

3201

"height": 42, # The height of the creative.

3202

},

3203

},

3204

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3205

# Filled in when the key is GOOG_DAYPART_TARGETING.

3206

# The definition of this targeting is derived from the structure

3207

# used by Ad Manager.

3208

"dayParts": [ # A list of day part targeting criterion.

3209

{ # Daypart targeting message that specifies if the ad can be shown

3210

# only during certain parts of a day/week.

3211

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3212

"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

3213

# granularity). The end time is exclusive. This field is not available

3214

# for filtering in PQL queries.

3215

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3216

# types are google.type.Date and `google.protobuf.Timestamp`.

3217

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3218

# allow the value 60 if it allows leap-seconds.

3219

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3220

# to allow the value "24:00:00" for scenarios like business closing time.

3221

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3222

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3223

},

3224

"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).

3225

# The start time is inclusive.

3226

# This field is not available for filtering in PQL queries.

3227

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3228

# types are google.type.Date and `google.protobuf.Timestamp`.

3229

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3230

# allow the value 60 if it allows leap-seconds.

3231

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3232

# to allow the value "24:00:00" for scenarios like business closing time.

3233

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3234

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

3243

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3244

# Third parties may define their own keys.

3245

# A list of permissible keys along with the acceptable values will be

3246

# provided as part of the external documentation.

3247

},

3248

],

3249

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3250

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

3251

# The deal is considered paused if either hasBuyerPaused or

3252

# hasSellPaused is true.

3253

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

3254

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3255

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3256

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

3257

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3258

},

3259

},

3260

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

3265

"displayName": "A String", # The name for the proposal.

3266

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3267

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3268

#

3269

# Note: This field may be set only when creating the resource. Modifying

3270

# this field while updating the resource will result in an error.

3271

# Authorized Buyers account ID.

3272

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3273

},

3274

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3275

# proposal.

3276

"notes": [ # Output only. The notes associated with this proposal.

3277

{ # A proposal may be associated to several notes.

3278

"note": "A String", # The actual note to attach.

3279

# (max-length: 1024 unicode code units)

3280

#

3281

# Note: This field may be set only when creating the resource. Modifying

3282

# this field while updating the resource will result in an error.

3283

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3284

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3285

"createTime": "A String", # Output only. The timestamp for when this note was created.

3286

"noteId": "A String", # Output only. The unique ID for the note.

3287

},

3288

],

3289

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3290

# left a comment.

3291

"buyerContacts": [ # Contact information for the buyer.

3292

{ # Contains information on how a buyer or seller can be reached.

3293

"email": "A String", # Email address for the contact.

3294

"name": "A String", # The name of the contact.

},

],

}</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.

3327

"sellerContacts": [ # Output only. Contact information for the seller.

3328

{ # Contains information on how a buyer or seller can be reached.

3329

"email": "A String", # Email address for the contact.

3330

"name": "A String", # The name of the contact.

3331

},

3332

],

3333

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3334

"proposalState": "A String", # Output only. The current state of the proposal.

3335

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3336

# Each update to the proposal or the deal causes the proposal revision number

3337

# to auto-increment. The buyer keeps track of the last revision number they

3338

# know of and pass it in when making an update. If the head revision number

3339

# on the server has since incremented, then an ABORTED error is returned

3340

# during the update operation to let the buyer know that a subsequent update

3341

# was made.

3342

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3343

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3344

# operations (max-length: 1024 unicode code units).

3345

},

3346

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3347

# proposal.

3348

"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.

3349

# Authorized Buyers account ID.

3350

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3351

},

3352

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

3353

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

3354

#

3355

# Note: This field may be set only when creating the resource. Modifying

3356

# this field while updating the resource will result in an error.

3357

# Ad Manager account ID.

3358

"subAccountId": "A String", # Optional sub-account ID for the seller.

3359

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

3360

# The seller account ID is then available to buyer in the product.

3361

},

3362

"deals": [ # The deals associated with this proposal. For Private Auction proposals

3363

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3364

{ # A deal represents a segment of inventory for displaying ads on.

3365

# A proposal can contain multiple deals. A deal contains the terms and

3366

# targeting information that is used for serving.

3367

"updateTime": "A String", # Output only. The time when the deal was last updated.

3368

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

3369

# If present on create, and the server `product_revision` has advanced sinced

3370

# the passed-in `create_product_revision`, an `ABORTED` error will be

3371

# returned.

3372

#

3373

# Note: This field may be set only when creating the resource. Modifying

3374

# this field while updating the resource will result in an error.

3375

"sellerContacts": [ # Output only. Seller contact information for the deal.

3376

{ # Contains information on how a buyer or seller can be reached.

3377

"email": "A String", # Email address for the contact.

3378

"name": "A String", # The name of the contact.

3379

},

3380

],

3381

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

3382

# This will generally be stored in the granularity of one second since deal

3383

# serving starts at seconds boundary. Any time specified with more

3384

# granularity (e.g., in milliseconds) will be truncated towards the start of

3385

# time in seconds.

3386

"availableEndTime": "A String", # Proposed flight end time of the deal.

3387

# This will generally be stored in a granularity of a second.

3388

# A value is not required for Private Auction deals or Preferred Deals.

3389

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

3390

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

3391

# in Ad Manager.

3392

# Preferred Deal in Ad Manager.

3393

# This doesn't apply to Private Auction and AdX Preferred Deals.

3394

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

3395

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

3396

"creativeSpecifications": [

3397

{ # Represents information for a creative that is associated with a Programmatic

3398

# Guaranteed/Preferred Deal in Ad Manager.

3399

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

3400

"width": "A String", # The width of the ad slot in pixels.

3401

# This field will be present only when size type is `PIXEL`.

3402

"sizeType": "A String", # The size type of the ad slot.

3403

"height": "A String", # The height of the ad slot in pixels.

3404

# This field will be present only when size type is `PIXEL`.

3405

},

3406

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

3407

{ # Represents size of a single ad slot, or a creative.

3408

"width": "A String", # The width of the ad slot in pixels.

3409

# This field will be present only when size type is `PIXEL`.

3410

"sizeType": "A String", # The size type of the ad slot.

3411

"height": "A String", # The height of the ad slot in pixels.

3412

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

3419

# target ad inventory. For example, they can choose to target ad requests only

3420

# if the user is in the US.

3421

# Multiple types of targeting are always applied as a logical AND, unless noted

3422

# otherwise.

3423

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3424

"excludedPositionTypes": [ # A list of video positions to be excluded.

3425

# Position types can either be included or excluded (XOR).

3426

"A String",

3427

],

3428

"targetedPositionTypes": [ # A list of video positions to be included.

3429

# When the included list is present, the excluded list must be empty.

3430

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

3435

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

3436

# included and excluded numeric IDs.

3437

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3438

"A String",

3439

],

3440

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3445

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3446

# included and excluded numeric IDs.

3447

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3448

"A String",

3449

],

3450

"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.

3455

# included and excluded numeric IDs.

3456

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3457

"A String",

3458

],

3459

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3465

# included and excluded numeric IDs.

3466

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3467

"A String",

3468

],

3469

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3475

# included and excluded numeric IDs.

3476

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3477

"A String",

3478

],

3479

"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.

3484

# mobile applications.

3485

# Different placement targeting types will be logically OR'ed.

3486

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3487

# For Private Auction and AdX Preferred Deals, URLs are either included or

3488

# excluded.

3489

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3490

# apply.

3491

"excludedUrls": [ # A list of URLs to be excluded.

3492

"A String",

3493

],

3494

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3499

# This doesn't apply to Auction Packages.

3500

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

3501

# display the ads in.

3502

# publishers own.

3503

# Mobile application IDs are from App Store and Google Play Store.

3504

# Android App ID, for example, com.google.android.apps.maps, can be found in

3505

# Google Play Store URL.

3506

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3507

# First party mobile applications is either included or excluded.

3508

"excludedAppIds": [ # A list of application IDs to be excluded.

3509

"A String",

3510

],

3511

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

3518

# request. It only applies to Private Auction, AdX Preferred Deals and

3519

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3520

# and Preferred Deals in Ad Manager.

3521

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3522

{ # Represents size of a single ad slot, or a creative.

3523

"width": "A String", # The width of the ad slot in pixels.

3524

# This field will be present only when size type is `PIXEL`.

3525

"sizeType": "A String", # The size type of the ad slot.

3526

"height": "A String", # The height of the ad slot in pixels.

3527

# This field will be present only when size type is `PIXEL`.

3528

},

3529

],

3530

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3531

{ # Represents size of a single ad slot, or a creative.

3532

"width": "A String", # The width of the ad slot in pixels.

3533

# This field will be present only when size type is `PIXEL`.

3534

"sizeType": "A String", # The size type of the ad slot.

3535

"height": "A String", # The height of the ad slot in pixels.

3536

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

3542

#

3543

# Note: This field may be set only when creating the resource. Modifying

3544

# this field while updating the resource will result in an error.

3545

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

3546

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

3547

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

3548

# to see but are non-negotiable. These are set by the publisher.

3549

"frequencyCaps": [ # Output only. Specifies any frequency caps.

3550

{ # Frequency cap.

3551

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

3552

# amount of time over which impressions per user are counted and capped.

3553

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3554

# which impressions per user are counted and capped.

3555

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

3556

# specified time period.

3557

},

3558

],

3559

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

3560

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

3561

},

3562

"description": "A String", # Description for the deal terms.

3563

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

3564

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3565

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3566

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3567

# finalized. This is the deal ID that shows up in serving/reporting etc.

3568

"createTime": "A String", # Output only. The time of the deal creation.

3569

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

3570

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

3571

# and expected impressions from the publisher.

3572

"description": "A String", # Publisher provided description for the terms.

3573

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3574

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3575

# of guaranteed looks that the buyer is guaranteeing to buy.

3576

"fixedPrices": [ # Fixed price for the specified buyer.

3577

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3578

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3579

# a particular buyer or buyer/advertiser pair, we look for the most specific

3580

# matching rule - we first look for a rule matching the buyer and advertiser,

3581

# next a rule with the buyer but an empty advertiser list, and otherwise look

3582

# for a matching rule where no buyer is set.

3583

"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

3584

# (if the

3585

# advertisers match, and there's no more specific rule matching the buyer).

3586

# Authorized Buyers account ID.

3587

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3588

},

3589

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3590

# If empty, all advertisers with this buyer pay this price.

3591

"A String",

3592

],

3593

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3594

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3595

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3596

"nanos": 42, # Number of nano (10^-9) units of the amount.

3597

# The value must be between -999,999,999 and +999,999,999 inclusive.

3598

# If `units` is positive, `nanos` must be positive or zero.

3599

# If `units` is zero, `nanos` can be positive, zero, or negative.

3600

# If `units` is negative, `nanos` must be negative or zero.

3601

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3602

"units": "A String", # The whole units of the amount.

3603

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3604

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

3610

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3611

},

3612

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3613

# time zone used to mark the boundaries of a day. It should be an

3614

# IANA TZ name, such as "America/Los_Angeles". For more information,

3615

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

3616

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

3617

# Can be set by buyer or seller.

3618

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3619

# the API at this time, but can be returned in a get or list request.

3620

"fixedPrices": [ # Fixed price for the specified buyer.

3621

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3622

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3623

# a particular buyer or buyer/advertiser pair, we look for the most specific

3624

# matching rule - we first look for a rule matching the buyer and advertiser,

3625

# next a rule with the buyer but an empty advertiser list, and otherwise look

3626

# for a matching rule where no buyer is set.

3627

"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

3628

# (if the

3629

# advertisers match, and there's no more specific rule matching the buyer).

3630

# Authorized Buyers account ID.

3631

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3632

},

3633

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3634

# If empty, all advertisers with this buyer pay this price.

3635

"A String",

3636

],

3637

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3638

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3639

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3640

"nanos": 42, # Number of nano (10^-9) units of the amount.

3641

# The value must be between -999,999,999 and +999,999,999 inclusive.

3642

# If `units` is positive, `nanos` must be positive or zero.

3643

# If `units` is zero, `nanos` can be positive, zero, or negative.

3644

# If `units` is negative, `nanos` must be negative or zero.

3645

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3646

"units": "A String", # The whole units of the amount.

3647

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3648

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

3655

# Can be set by buyer or seller.

3656

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3657

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3658

"nanos": 42, # Number of nano (10^-9) units of the amount.

3659

# The value must be between -999,999,999 and +999,999,999 inclusive.

3660

# If `units` is positive, `nanos` must be positive or zero.

3661

# If `units` is zero, `nanos` can be positive, zero, or negative.

3662

# If `units` is negative, `nanos` must be negative or zero.

3663

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3664

"units": "A String", # The whole units of the amount.

3665

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3666

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3667

},

3668

},

3669

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3670

# by the seller, but they can be returned in a get or list request.

3671

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3672

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3673

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3674

# a particular buyer or buyer/advertiser pair, we look for the most specific

3675

# matching rule - we first look for a rule matching the buyer and advertiser,

3676

# next a rule with the buyer but an empty advertiser list, and otherwise look

3677

# for a matching rule where no buyer is set.

3678

"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

3679

# (if the

3680

# advertisers match, and there's no more specific rule matching the buyer).

3681

# Authorized Buyers account ID.

3682

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3683

},

3684

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3685

# If empty, all advertisers with this buyer pay this price.

3686

"A String",

3687

],

3688

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3689

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3690

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3691

"nanos": 42, # Number of nano (10^-9) units of the amount.

3692

# The value must be between -999,999,999 and +999,999,999 inclusive.

3693

# If `units` is positive, `nanos` must be positive or zero.

3694

# If `units` is zero, `nanos` can be positive, zero, or negative.

3695

# If `units` is negative, `nanos` must be negative or zero.

3696

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3697

"units": "A String", # The whole units of the amount.

3698

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3699

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

3705

# in this private auction.

3706

},

3707

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3708

},

3709

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3710

# PUBLISHER means creative is provided by seller and ADVERTISER means

3711

# creative is provided by buyer.

3712

"displayName": "A String", # The name of the deal.

3713

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3714

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3715

# operations (max-length: 1024 unicode code units).

3716

},

3717

"syndicationProduct": "A String", # The syndication product associated with the deal.

3718

#

3719

# Note: This field may be set only when creating the resource. Modifying

3720

# this field while updating the resource will result in an error.

3721

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3722

# targeting entity is AND'd together.

3723

{ # Advertisers can target different attributes of an ad slot. For example,

3724

# they can choose to show ads only if the user is in the U.S. Such

3725

# targeting criteria can be specified as part of Shared Targeting.

3726

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

3727

# together.

3728

{ # A polymorphic targeting value used as part of Shared Targeting.

3729

"stringValue": "A String", # The string value to include/exclude.

3730

"longValue": "A String", # The long value to include/exclude.

3731

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3732

# Filled in when key = GOOG_CREATIVE_SIZE

3733

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3734

# Companion sizes may be filled in only when creative_size_type = VIDEO

3735

{ # Message depicting the size of the creative. The units of width and

3736

# height depend on the type of the targeting.

3737

"width": 42, # The width of the creative

3738

"height": 42, # The height of the creative.

3739

},

3740

],

3741

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3742

# only if creative_size_type = CreativeSizeType.NATIVE.

3743

"allowedFormats": [ # What formats are allowed by the publisher.

3744

# If this repeated field is empty then all formats are allowed.

3745

# For example, if this field contains AllowedFormatType.AUDIO then the

3746

# publisher only allows an audio ad (without any video).

3747

"A String",

3748

],

3749

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3750

# creative_size_type = CreativeSizeType.VIDEO.

3751

"creativeSizeType": "A String", # The creative size type.

3752

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3753

# of the creative

3754

# height depend on the type of the targeting.

3755

"width": 42, # The width of the creative

3756

"height": 42, # The height of the creative.

3757

},

3758

},

3759

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3760

# Filled in when the key is GOOG_DAYPART_TARGETING.

3761

# The definition of this targeting is derived from the structure

3762

# used by Ad Manager.

3763

"dayParts": [ # A list of day part targeting criterion.

3764

{ # Daypart targeting message that specifies if the ad can be shown

3765

# only during certain parts of a day/week.

3766

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3767

"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

3768

# granularity). The end time is exclusive. This field is not available

3769

# for filtering in PQL queries.

3770

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3771

# types are google.type.Date and `google.protobuf.Timestamp`.

3772

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3773

# allow the value 60 if it allows leap-seconds.

3774

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3775

# to allow the value "24:00:00" for scenarios like business closing time.

3776

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3777

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3778

},

3779

"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).

3780

# The start time is inclusive.

3781

# This field is not available for filtering in PQL queries.

3782

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3783

# types are google.type.Date and `google.protobuf.Timestamp`.

3784

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3785

# allow the value 60 if it allows leap-seconds.

3786

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3787

# to allow the value "24:00:00" for scenarios like business closing time.

3788

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3789

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3798

# together.

3799

{ # A polymorphic targeting value used as part of Shared Targeting.

3800

"stringValue": "A String", # The string value to include/exclude.

3801

"longValue": "A String", # The long value to include/exclude.

3802

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3803

# Filled in when key = GOOG_CREATIVE_SIZE

3804

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3805

# Companion sizes may be filled in only when creative_size_type = VIDEO

3806

{ # Message depicting the size of the creative. The units of width and

3807

# height depend on the type of the targeting.

3808

"width": 42, # The width of the creative

3809

"height": 42, # The height of the creative.

3810

},

3811

],

3812

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3813

# only if creative_size_type = CreativeSizeType.NATIVE.

3814

"allowedFormats": [ # What formats are allowed by the publisher.

3815

# If this repeated field is empty then all formats are allowed.

3816

# For example, if this field contains AllowedFormatType.AUDIO then the

3817

# publisher only allows an audio ad (without any video).

3818

"A String",

3819

],

3820

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3821

# creative_size_type = CreativeSizeType.VIDEO.

3822

"creativeSizeType": "A String", # The creative size type.

3823

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3824

# of the creative

3825

# height depend on the type of the targeting.

3826

"width": 42, # The width of the creative

3827

"height": 42, # The height of the creative.

3828

},

3829

},

3830

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3831

# Filled in when the key is GOOG_DAYPART_TARGETING.

3832

# The definition of this targeting is derived from the structure

3833

# used by Ad Manager.

3834

"dayParts": [ # A list of day part targeting criterion.

3835

{ # Daypart targeting message that specifies if the ad can be shown

3836

# only during certain parts of a day/week.

3837

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

3838

"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

3839

# granularity). The end time is exclusive. This field is not available

3840

# for filtering in PQL queries.

3841

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3842

# types are google.type.Date and `google.protobuf.Timestamp`.

3843

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3844

# allow the value 60 if it allows leap-seconds.

3845

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3846

# to allow the value "24:00:00" for scenarios like business closing time.

3847

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3848

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3849

},

3850

"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).

3851

# The start time is inclusive.

3852

# This field is not available for filtering in PQL queries.

3853

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3854

# types are google.type.Date and `google.protobuf.Timestamp`.

3855

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3856

# allow the value 60 if it allows leap-seconds.

3857

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3858

# to allow the value "24:00:00" for scenarios like business closing time.

3859

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3860

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

3869

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3870

# Third parties may define their own keys.

3871

# A list of permissible keys along with the acceptable values will be

3872

# provided as part of the external documentation.

3873

},

3874

],

3875

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3876

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

3877

# The deal is considered paused if either hasBuyerPaused or

3878

# hasSellPaused is true.

3879

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

3880

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3881

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3882

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

3883

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3884

},

3885

},

3886

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

3891

"displayName": "A String", # The name for the proposal.

3892

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3893

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3894

#

3895

# Note: This field may be set only when creating the resource. Modifying

3896

# this field while updating the resource will result in an error.

3897

# Authorized Buyers account ID.

3898

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3899

},

3900

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3901

# proposal.

3902

"notes": [ # Output only. The notes associated with this proposal.

3903

{ # A proposal may be associated to several notes.

3904

"note": "A String", # The actual note to attach.

3905

# (max-length: 1024 unicode code units)

3906

#

3907

# Note: This field may be set only when creating the resource. Modifying

3908

# this field while updating the resource will result in an error.

3909

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3910

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3911

"createTime": "A String", # Output only. The timestamp for when this note was created.

3912

"noteId": "A String", # Output only. The unique ID for the note.

3913

},

3914

],

3915

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3916

# left a comment.

3917

"buyerContacts": [ # Contact information for the buyer.

3918

{ # Contains information on how a buyer or seller can be reached.

3919

"email": "A String", # Email address for the contact.

3920

"name": "A String", # The name of the contact.

},

],

}</pre>

</div>

<code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filterSyntax=None, filter=None)</code>

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.

3932

A Bidder account can only see its child seats' proposals by specifying

3933

the ChildSeat's accountId in the request path.

3934

3935

Args:

3936

accountId: string, Account ID of the buyer. (required)

3937

pageSize: integer, Requested page size. The server may return fewer results than requested.

3938

If unspecified, the server will pick an appropriate default.

3939

pageToken: string, The page token as returned from ListProposalsResponse.

3940

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL

3945

but in the future it will be LIST_FILTER.

3946

filter: string, An optional PQL filter query used to query for proposals.

3947

3948

Nested repeated fields, such as proposal.deals.targetingCriterion,

cannot be filtered.

Returns:

An object of the form:

3953

3954

{ # Response message for listing proposals.

3955

"nextPageToken": "A String", # Continuation token for fetching the next page of results.

3956

"proposals": [ # The list of proposals.

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.

3968

"sellerContacts": [ # Output only. Contact information for the seller.

3969

{ # Contains information on how a buyer or seller can be reached.

3970

"email": "A String", # Email address for the contact.

3971

"name": "A String", # The name of the contact.

3972

},

3973

],

3974

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3975

"proposalState": "A String", # Output only. The current state of the proposal.

3976

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3977

# Each update to the proposal or the deal causes the proposal revision number

3978

# to auto-increment. The buyer keeps track of the last revision number they

3979

# know of and pass it in when making an update. If the head revision number

3980

# on the server has since incremented, then an ABORTED error is returned

3981

# during the update operation to let the buyer know that a subsequent update

3982

# was made.

3983

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3984

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3985

# operations (max-length: 1024 unicode code units).

3986

},

3987

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3988

# proposal.

3989

"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.

3990

# Authorized Buyers account ID.

3991

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3992

},

3993

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

3994

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

3995

#

3996

# Note: This field may be set only when creating the resource. Modifying

3997

# this field while updating the resource will result in an error.

3998

# Ad Manager account ID.

3999

"subAccountId": "A String", # Optional sub-account ID for the seller.

4000

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

4001

# The seller account ID is then available to buyer in the product.

4002

},

4003

"deals": [ # The deals associated with this proposal. For Private Auction proposals

4004

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4005

{ # A deal represents a segment of inventory for displaying ads on.

4006

# A proposal can contain multiple deals. A deal contains the terms and

4007

# targeting information that is used for serving.

4008

"updateTime": "A String", # Output only. The time when the deal was last updated.

4009

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

4010

# If present on create, and the server `product_revision` has advanced sinced

4011

# the passed-in `create_product_revision`, an `ABORTED` error will be

4012

# returned.

4013

#

4014

# Note: This field may be set only when creating the resource. Modifying

4015

# this field while updating the resource will result in an error.

4016

"sellerContacts": [ # Output only. Seller contact information for the deal.

4017

{ # Contains information on how a buyer or seller can be reached.

4018

"email": "A String", # Email address for the contact.

4019

"name": "A String", # The name of the contact.

4020

},

4021

],

4022

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

4023

# This will generally be stored in the granularity of one second since deal

4024

# serving starts at seconds boundary. Any time specified with more

4025

# granularity (e.g., in milliseconds) will be truncated towards the start of

4026

# time in seconds.

4027

"availableEndTime": "A String", # Proposed flight end time of the deal.

4028

# This will generally be stored in a granularity of a second.

4029

# A value is not required for Private Auction deals or Preferred Deals.

4030

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4031

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4032

# in Ad Manager.

4033

# Preferred Deal in Ad Manager.

4034

# This doesn't apply to Private Auction and AdX Preferred Deals.

4035

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

4036

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4037

"creativeSpecifications": [

4038

{ # Represents information for a creative that is associated with a Programmatic

4039

# Guaranteed/Preferred Deal in Ad Manager.

4040

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4041

"width": "A String", # The width of the ad slot in pixels.

4042

# This field will be present only when size type is `PIXEL`.

4043

"sizeType": "A String", # The size type of the ad slot.

4044

"height": "A String", # The height of the ad slot in pixels.

4045

# This field will be present only when size type is `PIXEL`.

4046

},

4047

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4048

{ # Represents size of a single ad slot, or a creative.

4049

"width": "A String", # The width of the ad slot in pixels.

4050

# This field will be present only when size type is `PIXEL`.

4051

"sizeType": "A String", # The size type of the ad slot.

4052

"height": "A String", # The height of the ad slot in pixels.

4053

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

4060

# target ad inventory. For example, they can choose to target ad requests only

4061

# if the user is in the US.

4062

# Multiple types of targeting are always applied as a logical AND, unless noted

4063

# otherwise.

4064

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

4065

"excludedPositionTypes": [ # A list of video positions to be excluded.

4066

# Position types can either be included or excluded (XOR).

4067

"A String",

4068

],

4069

"targetedPositionTypes": [ # A list of video positions to be included.

4070

# When the included list is present, the excluded list must be empty.

4071

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

4076

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

4077

# included and excluded numeric IDs.

4078

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4079

"A String",

4080

],

4081

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4086

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4087

# included and excluded numeric IDs.

4088

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4089

"A String",

4090

],

4091

"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.

4096

# included and excluded numeric IDs.

4097

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4098

"A String",

4099

],

4100

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4106

# included and excluded numeric IDs.

4107

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4108

"A String",

4109

],

4110

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4116

# included and excluded numeric IDs.

4117

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4118

"A String",

4119

],

4120

"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.

4125

# mobile applications.

4126

# Different placement targeting types will be logically OR'ed.

4127

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4128

# For Private Auction and AdX Preferred Deals, URLs are either included or

4129

# excluded.

4130

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4131

# apply.

4132

"excludedUrls": [ # A list of URLs to be excluded.

4133

"A String",

4134

],

4135

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4140

# This doesn't apply to Auction Packages.

4141

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

4142

# display the ads in.

4143

# publishers own.

4144

# Mobile application IDs are from App Store and Google Play Store.

4145

# Android App ID, for example, com.google.android.apps.maps, can be found in

4146

# Google Play Store URL.

4147

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4148

# First party mobile applications is either included or excluded.

4149

"excludedAppIds": [ # A list of application IDs to be excluded.

4150

"A String",

4151

],

4152

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

4159

# request. It only applies to Private Auction, AdX Preferred Deals and

4160

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4161

# and Preferred Deals in Ad Manager.

4162

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4163

{ # Represents size of a single ad slot, or a creative.

4164

"width": "A String", # The width of the ad slot in pixels.

4165

# This field will be present only when size type is `PIXEL`.

4166

"sizeType": "A String", # The size type of the ad slot.

4167

"height": "A String", # The height of the ad slot in pixels.

4168

# This field will be present only when size type is `PIXEL`.

4169

},

4170

],

4171

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4172

{ # Represents size of a single ad slot, or a creative.

4173

"width": "A String", # The width of the ad slot in pixels.

4174

# This field will be present only when size type is `PIXEL`.

4175

"sizeType": "A String", # The size type of the ad slot.

4176

"height": "A String", # The height of the ad slot in pixels.

4177

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

4183

#

4184

# Note: This field may be set only when creating the resource. Modifying

4185

# this field while updating the resource will result in an error.

4186

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

4187

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

4188

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

4189

# to see but are non-negotiable. These are set by the publisher.

4190

"frequencyCaps": [ # Output only. Specifies any frequency caps.

4191

{ # Frequency cap.

4192

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

4193

# amount of time over which impressions per user are counted and capped.

4194

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4195

# which impressions per user are counted and capped.

4196

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

4197

# specified time period.

4198

},

4199

],

4200

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

4201

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

4202

},

4203

"description": "A String", # Description for the deal terms.

4204

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

4205

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4206

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4207

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4208

# finalized. This is the deal ID that shows up in serving/reporting etc.

4209

"createTime": "A String", # Output only. The time of the deal creation.

4210

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4211

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4212

# and expected impressions from the publisher.

4213

"description": "A String", # Publisher provided description for the terms.

4214

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4215

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4216

# of guaranteed looks that the buyer is guaranteeing to buy.

4217

"fixedPrices": [ # Fixed price for the specified buyer.

4218

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4219

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4220

# a particular buyer or buyer/advertiser pair, we look for the most specific

4221

# matching rule - we first look for a rule matching the buyer and advertiser,

4222

# next a rule with the buyer but an empty advertiser list, and otherwise look

4223

# for a matching rule where no buyer is set.

4224

"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

4225

# (if the

4226

# advertisers match, and there's no more specific rule matching the buyer).

4227

# Authorized Buyers account ID.

4228

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4229

},

4230

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4231

# If empty, all advertisers with this buyer pay this price.

4232

"A String",

4233

],

4234

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4235

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4236

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4237

"nanos": 42, # Number of nano (10^-9) units of the amount.

4238

# The value must be between -999,999,999 and +999,999,999 inclusive.

4239

# If `units` is positive, `nanos` must be positive or zero.

4240

# If `units` is zero, `nanos` can be positive, zero, or negative.

4241

# If `units` is negative, `nanos` must be negative or zero.

4242

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4243

"units": "A String", # The whole units of the amount.

4244

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4245

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

4251

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4252

},

4253

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4254

# time zone used to mark the boundaries of a day. It should be an

4255

# IANA TZ name, such as "America/Los_Angeles". For more information,

4256

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

4257

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4258

# Can be set by buyer or seller.

4259

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4260

# the API at this time, but can be returned in a get or list request.

4261

"fixedPrices": [ # Fixed price for the specified buyer.

4262

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4263

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4264

# a particular buyer or buyer/advertiser pair, we look for the most specific

4265

# matching rule - we first look for a rule matching the buyer and advertiser,

4266

# next a rule with the buyer but an empty advertiser list, and otherwise look

4267

# for a matching rule where no buyer is set.

4268

"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

4269

# (if the

4270

# advertisers match, and there's no more specific rule matching the buyer).

4271

# Authorized Buyers account ID.

4272

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4273

},

4274

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4275

# If empty, all advertisers with this buyer pay this price.

4276

"A String",

4277

],

4278

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4279

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4280

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4281

"nanos": 42, # Number of nano (10^-9) units of the amount.

4282

# The value must be between -999,999,999 and +999,999,999 inclusive.

4283

# If `units` is positive, `nanos` must be positive or zero.

4284

# If `units` is zero, `nanos` can be positive, zero, or negative.

4285

# If `units` is negative, `nanos` must be negative or zero.

4286

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4287

"units": "A String", # The whole units of the amount.

4288

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4289

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

4296

# Can be set by buyer or seller.

4297

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4298

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4299

"nanos": 42, # Number of nano (10^-9) units of the amount.

4300

# The value must be between -999,999,999 and +999,999,999 inclusive.

4301

# If `units` is positive, `nanos` must be positive or zero.

4302

# If `units` is zero, `nanos` can be positive, zero, or negative.

4303

# If `units` is negative, `nanos` must be negative or zero.

4304

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4305

"units": "A String", # The whole units of the amount.

4306

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4307

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4308

},

4309

},

4310

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4311

# by the seller, but they can be returned in a get or list request.

4312

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4313

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4314

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4315

# a particular buyer or buyer/advertiser pair, we look for the most specific

4316

# matching rule - we first look for a rule matching the buyer and advertiser,

4317

# next a rule with the buyer but an empty advertiser list, and otherwise look

4318

# for a matching rule where no buyer is set.

4319

"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

4320

# (if the

4321

# advertisers match, and there's no more specific rule matching the buyer).

4322

# Authorized Buyers account ID.

4323

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4324

},

4325

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4326

# If empty, all advertisers with this buyer pay this price.

4327

"A String",

4328

],

4329

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4330

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4331

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4332

"nanos": 42, # Number of nano (10^-9) units of the amount.

4333

# The value must be between -999,999,999 and +999,999,999 inclusive.

4334

# If `units` is positive, `nanos` must be positive or zero.

4335

# If `units` is zero, `nanos` can be positive, zero, or negative.

4336

# If `units` is negative, `nanos` must be negative or zero.

4337

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4338

"units": "A String", # The whole units of the amount.

4339

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4340

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

4346

# in this private auction.

4347

},

4348

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

4349

},

4350

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4351

# PUBLISHER means creative is provided by seller and ADVERTISER means

4352

# creative is provided by buyer.

4353

"displayName": "A String", # The name of the deal.

4354

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4355

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4356

# operations (max-length: 1024 unicode code units).

4357

},

4358

"syndicationProduct": "A String", # The syndication product associated with the deal.

4359

#

4360

# Note: This field may be set only when creating the resource. Modifying

4361

# this field while updating the resource will result in an error.

4362

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4363

# targeting entity is AND'd together.

4364

{ # Advertisers can target different attributes of an ad slot. For example,

4365

# they can choose to show ads only if the user is in the U.S. Such

4366

# targeting criteria can be specified as part of Shared Targeting.

4367

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4368

# together.

4369

{ # A polymorphic targeting value used as part of Shared Targeting.

4370

"stringValue": "A String", # The string value to include/exclude.

4371

"longValue": "A String", # The long value to include/exclude.

4372

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4373

# Filled in when key = GOOG_CREATIVE_SIZE

4374

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4375

# Companion sizes may be filled in only when creative_size_type = VIDEO

4376

{ # Message depicting the size of the creative. The units of width and

4377

# height depend on the type of the targeting.

4378

"width": 42, # The width of the creative

4379

"height": 42, # The height of the creative.

4380

},

4381

],

4382

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4383

# only if creative_size_type = CreativeSizeType.NATIVE.

4384

"allowedFormats": [ # What formats are allowed by the publisher.

4385

# If this repeated field is empty then all formats are allowed.

4386

# For example, if this field contains AllowedFormatType.AUDIO then the

4387

# publisher only allows an audio ad (without any video).

4388

"A String",

4389

],

4390

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4391

# creative_size_type = CreativeSizeType.VIDEO.

4392

"creativeSizeType": "A String", # The creative size type.

4393

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4394

# of the creative

4395

# height depend on the type of the targeting.

4396

"width": 42, # The width of the creative

4397

"height": 42, # The height of the creative.

4398

},

4399

},

4400

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4401

# Filled in when the key is GOOG_DAYPART_TARGETING.

4402

# The definition of this targeting is derived from the structure

4403

# used by Ad Manager.

4404

"dayParts": [ # A list of day part targeting criterion.

4405

{ # Daypart targeting message that specifies if the ad can be shown

4406

# only during certain parts of a day/week.

4407

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4408

"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

4409

# granularity). The end time is exclusive. This field is not available

4410

# for filtering in PQL queries.

4411

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4412

# types are google.type.Date and `google.protobuf.Timestamp`.

4413

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4414

# allow the value 60 if it allows leap-seconds.

4415

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4416

# to allow the value "24:00:00" for scenarios like business closing time.

4417

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4418

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4419

},

4420

"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).

4421

# The start time is inclusive.

4422

# This field is not available for filtering in PQL queries.

4423

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4424

# types are google.type.Date and `google.protobuf.Timestamp`.

4425

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4426

# allow the value 60 if it allows leap-seconds.

4427

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4428

# to allow the value "24:00:00" for scenarios like business closing time.

4429

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4430

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4439

# together.

4440

{ # A polymorphic targeting value used as part of Shared Targeting.

4441

"stringValue": "A String", # The string value to include/exclude.

4442

"longValue": "A String", # The long value to include/exclude.

4443

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4444

# Filled in when key = GOOG_CREATIVE_SIZE

4445

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4446

# Companion sizes may be filled in only when creative_size_type = VIDEO

4447

{ # Message depicting the size of the creative. The units of width and

4448

# height depend on the type of the targeting.

4449

"width": 42, # The width of the creative

4450

"height": 42, # The height of the creative.

4451

},

4452

],

4453

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4454

# only if creative_size_type = CreativeSizeType.NATIVE.

4455

"allowedFormats": [ # What formats are allowed by the publisher.

4456

# If this repeated field is empty then all formats are allowed.

4457

# For example, if this field contains AllowedFormatType.AUDIO then the

4458

# publisher only allows an audio ad (without any video).

4459

"A String",

4460

],

4461

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4462

# creative_size_type = CreativeSizeType.VIDEO.

4463

"creativeSizeType": "A String", # The creative size type.

4464

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4465

# of the creative

4466

# height depend on the type of the targeting.

4467

"width": 42, # The width of the creative

4468

"height": 42, # The height of the creative.

4469

},

4470

},

4471

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4472

# Filled in when the key is GOOG_DAYPART_TARGETING.

4473

# The definition of this targeting is derived from the structure

4474

# used by Ad Manager.

4475

"dayParts": [ # A list of day part targeting criterion.

4476

{ # Daypart targeting message that specifies if the ad can be shown

4477

# only during certain parts of a day/week.

4478

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

4479

"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

4480

# granularity). The end time is exclusive. This field is not available

4481

# for filtering in PQL queries.

4482

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4483

# types are google.type.Date and `google.protobuf.Timestamp`.

4484

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4485

# allow the value 60 if it allows leap-seconds.

4486

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4487

# to allow the value "24:00:00" for scenarios like business closing time.

4488

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4489

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4490

},

4491

"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).

4492

# The start time is inclusive.

4493

# This field is not available for filtering in PQL queries.

4494

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4495

# types are google.type.Date and `google.protobuf.Timestamp`.

4496

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4497

# allow the value 60 if it allows leap-seconds.

4498

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4499

# to allow the value "24:00:00" for scenarios like business closing time.

4500

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4501

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

4510

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4511

# Third parties may define their own keys.

4512

# A list of permissible keys along with the acceptable values will be

4513

# provided as part of the external documentation.

4514

},

4515

],

4516

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4517

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

4518

# The deal is considered paused if either hasBuyerPaused or

4519

# hasSellPaused is true.

4520

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

4521

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4522

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4523

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

4524

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4525

},

4526

},

4527

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

4532

"displayName": "A String", # The name for the proposal.

4533

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

4534

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

4535

#

4536

# Note: This field may be set only when creating the resource. Modifying

4537

# this field while updating the resource will result in an error.

4538

# Authorized Buyers account ID.

4539

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4540

},

4541

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4542

# proposal.

4543

"notes": [ # Output only. The notes associated with this proposal.

4544

{ # A proposal may be associated to several notes.

4545

"note": "A String", # The actual note to attach.

4546

# (max-length: 1024 unicode code units)

4547

#

4548

# Note: This field may be set only when creating the resource. Modifying

4549

# this field while updating the resource will result in an error.

4550

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

4551

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

4552

"createTime": "A String", # Output only. The timestamp for when this note was created.

4553

"noteId": "A String", # Output only. The unique ID for the note.

4554

},

4555

],

4556

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

4557

# left a comment.

4558

"buyerContacts": [ # Contact information for the buyer.

4559

{ # Contains information on how a buyer or seller can be reached.

4560

"email": "A String", # Email address for the contact.

4561

"name": "A String", # The name of the contact.

},

],

},

],

}</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:

4578

A request object that you can call 'execute()' on to request the next

4579

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="pause">pause(accountId, proposalId, body, x__xgafv=None)</code>

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)

4597

body: object, The request body. (required)

4598

The object takes the form of:

4599

4600

{ # Request message to pause serving for an already-finalized proposal.

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.

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.

4625

"sellerContacts": [ # Output only. Contact information for the seller.

4626

{ # Contains information on how a buyer or seller can be reached.

4627

"email": "A String", # Email address for the contact.

4628

"name": "A String", # The name of the contact.

4629

},

4630

],

4631

"updateTime": "A String", # Output only. The time when the proposal was last revised.

4632

"proposalState": "A String", # Output only. The current state of the proposal.

4633

"proposalRevision": "A String", # Output only. The revision number for the proposal.

4634

# Each update to the proposal or the deal causes the proposal revision number

4635

# to auto-increment. The buyer keeps track of the last revision number they

4636

# know of and pass it in when making an update. If the head revision number

4637

# on the server has since incremented, then an ABORTED error is returned

4638

# during the update operation to let the buyer know that a subsequent update

4639

# was made.

4640

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

4641

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4642

# operations (max-length: 1024 unicode code units).

4643

},

4644

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

4645

# proposal.

4646

"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.

4647

# Authorized Buyers account ID.

4648

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4649

},

4650

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

4651

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

4652

#

4653

# Note: This field may be set only when creating the resource. Modifying

4654

# this field while updating the resource will result in an error.

4655

# Ad Manager account ID.

4656

"subAccountId": "A String", # Optional sub-account ID for the seller.

4657

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

4658

# The seller account ID is then available to buyer in the product.

4659

},

4660

"deals": [ # The deals associated with this proposal. For Private Auction proposals

4661

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4662

{ # A deal represents a segment of inventory for displaying ads on.

4663

# A proposal can contain multiple deals. A deal contains the terms and

4664

# targeting information that is used for serving.

4665

"updateTime": "A String", # Output only. The time when the deal was last updated.

4666

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

4667

# If present on create, and the server `product_revision` has advanced sinced

4668

# the passed-in `create_product_revision`, an `ABORTED` error will be

4669

# returned.

4670

#

4671

# Note: This field may be set only when creating the resource. Modifying

4672

# this field while updating the resource will result in an error.

4673

"sellerContacts": [ # Output only. Seller contact information for the deal.

4674

{ # Contains information on how a buyer or seller can be reached.

4675

"email": "A String", # Email address for the contact.

4676

"name": "A String", # The name of the contact.

4677

},

4678

],

4679

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

4680

# This will generally be stored in the granularity of one second since deal

4681

# serving starts at seconds boundary. Any time specified with more

4682

# granularity (e.g., in milliseconds) will be truncated towards the start of

4683

# time in seconds.

4684

"availableEndTime": "A String", # Proposed flight end time of the deal.

4685

# This will generally be stored in a granularity of a second.

4686

# A value is not required for Private Auction deals or Preferred Deals.

4687

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4688

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4689

# in Ad Manager.

4690

# Preferred Deal in Ad Manager.

4691

# This doesn't apply to Private Auction and AdX Preferred Deals.

4692

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

4693

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4694

"creativeSpecifications": [

4695

{ # Represents information for a creative that is associated with a Programmatic

4696

# Guaranteed/Preferred Deal in Ad Manager.

4697

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4698

"width": "A String", # The width of the ad slot in pixels.

4699

# This field will be present only when size type is `PIXEL`.

4700

"sizeType": "A String", # The size type of the ad slot.

4701

"height": "A String", # The height of the ad slot in pixels.

4702

# This field will be present only when size type is `PIXEL`.

4703

},

4704

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4705

{ # Represents size of a single ad slot, or a creative.

4706

"width": "A String", # The width of the ad slot in pixels.

4707

# This field will be present only when size type is `PIXEL`.

4708

"sizeType": "A String", # The size type of the ad slot.

4709

"height": "A String", # The height of the ad slot in pixels.

4710

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

4717

# target ad inventory. For example, they can choose to target ad requests only

4718

# if the user is in the US.

4719

# Multiple types of targeting are always applied as a logical AND, unless noted

4720

# otherwise.

4721

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

4722

"excludedPositionTypes": [ # A list of video positions to be excluded.

4723

# Position types can either be included or excluded (XOR).

4724

"A String",

4725

],

4726

"targetedPositionTypes": [ # A list of video positions to be included.

4727

# When the included list is present, the excluded list must be empty.

4728

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

4733

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

4734

# included and excluded numeric IDs.

4735

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4736

"A String",

4737

],

4738

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4743

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4744

# included and excluded numeric IDs.

4745

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4746

"A String",

4747

],

4748

"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.

4753

# included and excluded numeric IDs.

4754

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4755

"A String",

4756

],

4757

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4763

# included and excluded numeric IDs.

4764

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4765

"A String",

4766

],

4767

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4773

# included and excluded numeric IDs.

4774

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4775

"A String",

4776

],

4777

"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.

4782

# mobile applications.

4783

# Different placement targeting types will be logically OR'ed.

4784

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4785

# For Private Auction and AdX Preferred Deals, URLs are either included or

4786

# excluded.

4787

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4788

# apply.

4789

"excludedUrls": [ # A list of URLs to be excluded.

4790

"A String",

4791

],

4792

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4797

# This doesn't apply to Auction Packages.

4798

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

4799

# display the ads in.

4800

# publishers own.

4801

# Mobile application IDs are from App Store and Google Play Store.

4802

# Android App ID, for example, com.google.android.apps.maps, can be found in

4803

# Google Play Store URL.

4804

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4805

# First party mobile applications is either included or excluded.

4806

"excludedAppIds": [ # A list of application IDs to be excluded.

4807

"A String",

4808

],

4809

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

4816

# request. It only applies to Private Auction, AdX Preferred Deals and

4817

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4818

# and Preferred Deals in Ad Manager.

4819

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4820

{ # Represents size of a single ad slot, or a creative.

4821

"width": "A String", # The width of the ad slot in pixels.

4822

# This field will be present only when size type is `PIXEL`.

4823

"sizeType": "A String", # The size type of the ad slot.

4824

"height": "A String", # The height of the ad slot in pixels.

4825

# This field will be present only when size type is `PIXEL`.

4826

},

4827

],

4828

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4829

{ # Represents size of a single ad slot, or a creative.

4830

"width": "A String", # The width of the ad slot in pixels.

4831

# This field will be present only when size type is `PIXEL`.

4832

"sizeType": "A String", # The size type of the ad slot.

4833

"height": "A String", # The height of the ad slot in pixels.

4834

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

4840

#

4841

# Note: This field may be set only when creating the resource. Modifying

4842

# this field while updating the resource will result in an error.

4843

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

4844

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

4845

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

4846

# to see but are non-negotiable. These are set by the publisher.

4847

"frequencyCaps": [ # Output only. Specifies any frequency caps.

4848

{ # Frequency cap.

4849

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

4850

# amount of time over which impressions per user are counted and capped.

4851

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4852

# which impressions per user are counted and capped.

4853

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

4854

# specified time period.

4855

},

4856

],

4857

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

4858

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

4859

},

4860

"description": "A String", # Description for the deal terms.

4861

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

4862

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4863

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4864

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4865

# finalized. This is the deal ID that shows up in serving/reporting etc.

4866

"createTime": "A String", # Output only. The time of the deal creation.

4867

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4868

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4869

# and expected impressions from the publisher.

4870

"description": "A String", # Publisher provided description for the terms.

4871

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4872

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4873

# of guaranteed looks that the buyer is guaranteeing to buy.

4874

"fixedPrices": [ # Fixed price for the specified buyer.

4875

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4876

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4877

# a particular buyer or buyer/advertiser pair, we look for the most specific

4878

# matching rule - we first look for a rule matching the buyer and advertiser,

4879

# next a rule with the buyer but an empty advertiser list, and otherwise look

4880

# for a matching rule where no buyer is set.

4881

"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

4882

# (if the

4883

# advertisers match, and there's no more specific rule matching the buyer).

4884

# Authorized Buyers account ID.

4885

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4886

},

4887

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4888

# If empty, all advertisers with this buyer pay this price.

4889

"A String",

4890

],

4891

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4892

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4893

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4894

"nanos": 42, # Number of nano (10^-9) units of the amount.

4895

# The value must be between -999,999,999 and +999,999,999 inclusive.

4896

# If `units` is positive, `nanos` must be positive or zero.

4897

# If `units` is zero, `nanos` can be positive, zero, or negative.

4898

# If `units` is negative, `nanos` must be negative or zero.

4899

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4900

"units": "A String", # The whole units of the amount.

4901

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4902

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

4908

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4909

},

4910

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4911

# time zone used to mark the boundaries of a day. It should be an

4912

# IANA TZ name, such as "America/Los_Angeles". For more information,

4913

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

4914

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4915

# Can be set by buyer or seller.

4916

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4917

# the API at this time, but can be returned in a get or list request.

4918

"fixedPrices": [ # Fixed price for the specified buyer.

4919

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4920

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4921

# a particular buyer or buyer/advertiser pair, we look for the most specific

4922

# matching rule - we first look for a rule matching the buyer and advertiser,

4923

# next a rule with the buyer but an empty advertiser list, and otherwise look

4924

# for a matching rule where no buyer is set.

4925

"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

4926

# (if the

4927

# advertisers match, and there's no more specific rule matching the buyer).

4928

# Authorized Buyers account ID.

4929

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4930

},

4931

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4932

# If empty, all advertisers with this buyer pay this price.

4933

"A String",

4934

],

4935

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4936

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4937

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4938

"nanos": 42, # Number of nano (10^-9) units of the amount.

4939

# The value must be between -999,999,999 and +999,999,999 inclusive.

4940

# If `units` is positive, `nanos` must be positive or zero.

4941

# If `units` is zero, `nanos` can be positive, zero, or negative.

4942

# If `units` is negative, `nanos` must be negative or zero.

4943

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4944

"units": "A String", # The whole units of the amount.

4945

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4946

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

4953

# Can be set by buyer or seller.

4954

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4955

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4956

"nanos": 42, # Number of nano (10^-9) units of the amount.

4957

# The value must be between -999,999,999 and +999,999,999 inclusive.

4958

# If `units` is positive, `nanos` must be positive or zero.

4959

# If `units` is zero, `nanos` can be positive, zero, or negative.

4960

# If `units` is negative, `nanos` must be negative or zero.

4961

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4962

"units": "A String", # The whole units of the amount.

4963

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4964

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4965

},

4966

},

4967

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4968

# by the seller, but they can be returned in a get or list request.

4969

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4970

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4971

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4972

# a particular buyer or buyer/advertiser pair, we look for the most specific

4973

# matching rule - we first look for a rule matching the buyer and advertiser,

4974

# next a rule with the buyer but an empty advertiser list, and otherwise look

4975

# for a matching rule where no buyer is set.

4976

"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

4977

# (if the

4978

# advertisers match, and there's no more specific rule matching the buyer).

4979

# Authorized Buyers account ID.

4980

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4981

},

4982

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4983

# If empty, all advertisers with this buyer pay this price.

4984

"A String",

4985

],

4986

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4987

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4988

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4989

"nanos": 42, # Number of nano (10^-9) units of the amount.

4990

# The value must be between -999,999,999 and +999,999,999 inclusive.

4991

# If `units` is positive, `nanos` must be positive or zero.

4992

# If `units` is zero, `nanos` can be positive, zero, or negative.

4993

# If `units` is negative, `nanos` must be negative or zero.

4994

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4995

"units": "A String", # The whole units of the amount.

4996

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4997

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

5003

# in this private auction.

5004

},

5005

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

5006

},

5007

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5008

# PUBLISHER means creative is provided by seller and ADVERTISER means

5009

# creative is provided by buyer.

5010

"displayName": "A String", # The name of the deal.

5011

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5012

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5013

# operations (max-length: 1024 unicode code units).

5014

},

5015

"syndicationProduct": "A String", # The syndication product associated with the deal.

5016

#

5017

# Note: This field may be set only when creating the resource. Modifying

5018

# this field while updating the resource will result in an error.

5019

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5020

# targeting entity is AND'd together.

5021

{ # Advertisers can target different attributes of an ad slot. For example,

5022

# they can choose to show ads only if the user is in the U.S. Such

5023

# targeting criteria can be specified as part of Shared Targeting.

5024

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5025

# together.

5026

{ # A polymorphic targeting value used as part of Shared Targeting.

5027

"stringValue": "A String", # The string value to include/exclude.

5028

"longValue": "A String", # The long value to include/exclude.

5029

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5030

# Filled in when key = GOOG_CREATIVE_SIZE

5031

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5032

# Companion sizes may be filled in only when creative_size_type = VIDEO

5033

{ # Message depicting the size of the creative. The units of width and

5034

# height depend on the type of the targeting.

5035

"width": 42, # The width of the creative

5036

"height": 42, # The height of the creative.

5037

},

5038

],

5039

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5040

# only if creative_size_type = CreativeSizeType.NATIVE.

5041

"allowedFormats": [ # What formats are allowed by the publisher.

5042

# If this repeated field is empty then all formats are allowed.

5043

# For example, if this field contains AllowedFormatType.AUDIO then the

5044

# publisher only allows an audio ad (without any video).

5045

"A String",

5046

],

5047

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5048

# creative_size_type = CreativeSizeType.VIDEO.

5049

"creativeSizeType": "A String", # The creative size type.

5050

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5051

# of the creative

5052

# height depend on the type of the targeting.

5053

"width": 42, # The width of the creative

5054

"height": 42, # The height of the creative.

5055

},

5056

},

5057

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5058

# Filled in when the key is GOOG_DAYPART_TARGETING.

5059

# The definition of this targeting is derived from the structure

5060

# used by Ad Manager.

5061

"dayParts": [ # A list of day part targeting criterion.

5062

{ # Daypart targeting message that specifies if the ad can be shown

5063

# only during certain parts of a day/week.

5064

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5065

"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

5066

# granularity). The end time is exclusive. This field is not available

5067

# for filtering in PQL queries.

5068

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5069

# types are google.type.Date and `google.protobuf.Timestamp`.

5070

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5071

# allow the value 60 if it allows leap-seconds.

5072

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5073

# to allow the value "24:00:00" for scenarios like business closing time.

5074

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5075

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5076

},

5077

"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).

5078

# The start time is inclusive.

5079

# This field is not available for filtering in PQL queries.

5080

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5081

# types are google.type.Date and `google.protobuf.Timestamp`.

5082

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5083

# allow the value 60 if it allows leap-seconds.

5084

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5085

# to allow the value "24:00:00" for scenarios like business closing time.

5086

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5087

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5096

# together.

5097

{ # A polymorphic targeting value used as part of Shared Targeting.

5098

"stringValue": "A String", # The string value to include/exclude.

5099

"longValue": "A String", # The long value to include/exclude.

5100

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5101

# Filled in when key = GOOG_CREATIVE_SIZE

5102

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5103

# Companion sizes may be filled in only when creative_size_type = VIDEO

5104

{ # Message depicting the size of the creative. The units of width and

5105

# height depend on the type of the targeting.

5106

"width": 42, # The width of the creative

5107

"height": 42, # The height of the creative.

5108

},

5109

],

5110

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5111

# only if creative_size_type = CreativeSizeType.NATIVE.

5112

"allowedFormats": [ # What formats are allowed by the publisher.

5113

# If this repeated field is empty then all formats are allowed.

5114

# For example, if this field contains AllowedFormatType.AUDIO then the

5115

# publisher only allows an audio ad (without any video).

5116

"A String",

5117

],

5118

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5119

# creative_size_type = CreativeSizeType.VIDEO.

5120

"creativeSizeType": "A String", # The creative size type.

5121

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5122

# of the creative

5123

# height depend on the type of the targeting.

5124

"width": 42, # The width of the creative

5125

"height": 42, # The height of the creative.

5126

},

5127

},

5128

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5129

# Filled in when the key is GOOG_DAYPART_TARGETING.

5130

# The definition of this targeting is derived from the structure

5131

# used by Ad Manager.

5132

"dayParts": [ # A list of day part targeting criterion.

5133

{ # Daypart targeting message that specifies if the ad can be shown

5134

# only during certain parts of a day/week.

5135

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5136

"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

5137

# granularity). The end time is exclusive. This field is not available

5138

# for filtering in PQL queries.

5139

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5140

# types are google.type.Date and `google.protobuf.Timestamp`.

5141

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5142

# allow the value 60 if it allows leap-seconds.

5143

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5144

# to allow the value "24:00:00" for scenarios like business closing time.

5145

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5146

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5147

},

5148

"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).

5149

# The start time is inclusive.

5150

# This field is not available for filtering in PQL queries.

5151

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5152

# types are google.type.Date and `google.protobuf.Timestamp`.

5153

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5154

# allow the value 60 if it allows leap-seconds.

5155

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5156

# to allow the value "24:00:00" for scenarios like business closing time.

5157

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5158

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

5167

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5168

# Third parties may define their own keys.

5169

# A list of permissible keys along with the acceptable values will be

5170

# provided as part of the external documentation.

5171

},

5172

],

5173

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5174

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

5175

# The deal is considered paused if either hasBuyerPaused or

5176

# hasSellPaused is true.

5177

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

5178

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5179

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5180

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

5181

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5182

},

5183

},

5184

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

5189

"displayName": "A String", # The name for the proposal.

5190

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5191

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5192

#

5193

# Note: This field may be set only when creating the resource. Modifying

5194

# this field while updating the resource will result in an error.

5195

# Authorized Buyers account ID.

5196

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5197

},

5198

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5199

# proposal.

5200

"notes": [ # Output only. The notes associated with this proposal.

5201

{ # A proposal may be associated to several notes.

5202

"note": "A String", # The actual note to attach.

5203

# (max-length: 1024 unicode code units)

5204

#

5205

# Note: This field may be set only when creating the resource. Modifying

5206

# this field while updating the resource will result in an error.

5207

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5208

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5209

"createTime": "A String", # Output only. The timestamp for when this note was created.

5210

"noteId": "A String", # Output only. The unique ID for the note.

5211

},

5212

],

5213

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5214

# left a comment.

5215

"buyerContacts": [ # Contact information for the buyer.

5216

{ # Contains information on how a buyer or seller can be reached.

5217

"email": "A String", # Email address for the contact.

5218

"name": "A String", # The name of the contact.

},

],

}</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.

5267

"sellerContacts": [ # Output only. Contact information for the seller.

5268

{ # Contains information on how a buyer or seller can be reached.

5269

"email": "A String", # Email address for the contact.

5270

"name": "A String", # The name of the contact.

5271

},

5272

],

5273

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5274

"proposalState": "A String", # Output only. The current state of the proposal.

5275

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5276

# Each update to the proposal or the deal causes the proposal revision number

5277

# to auto-increment. The buyer keeps track of the last revision number they

5278

# know of and pass it in when making an update. If the head revision number

5279

# on the server has since incremented, then an ABORTED error is returned

5280

# during the update operation to let the buyer know that a subsequent update

5281

# was made.

5282

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5283

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5284

# operations (max-length: 1024 unicode code units).

5285

},

5286

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5287

# proposal.

5288

"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.

5289

# Authorized Buyers account ID.

5290

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5291

},

5292

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5293

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

5294

#

5295

# Note: This field may be set only when creating the resource. Modifying

5296

# this field while updating the resource will result in an error.

5297

# Ad Manager account ID.

5298

"subAccountId": "A String", # Optional sub-account ID for the seller.

5299

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

5300

# The seller account ID is then available to buyer in the product.

5301

},

5302

"deals": [ # The deals associated with this proposal. For Private Auction proposals

5303

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5304

{ # A deal represents a segment of inventory for displaying ads on.

5305

# A proposal can contain multiple deals. A deal contains the terms and

5306

# targeting information that is used for serving.

5307

"updateTime": "A String", # Output only. The time when the deal was last updated.

5308

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

5309

# If present on create, and the server `product_revision` has advanced sinced

5310

# the passed-in `create_product_revision`, an `ABORTED` error will be

5311

# returned.

5312

#

5313

# Note: This field may be set only when creating the resource. Modifying

5314

# this field while updating the resource will result in an error.

5315

"sellerContacts": [ # Output only. Seller contact information for the deal.

5316

{ # Contains information on how a buyer or seller can be reached.

5317

"email": "A String", # Email address for the contact.

5318

"name": "A String", # The name of the contact.

5319

},

5320

],

5321

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

5322

# This will generally be stored in the granularity of one second since deal

5323

# serving starts at seconds boundary. Any time specified with more

5324

# granularity (e.g., in milliseconds) will be truncated towards the start of

5325

# time in seconds.

5326

"availableEndTime": "A String", # Proposed flight end time of the deal.

5327

# This will generally be stored in a granularity of a second.

5328

# A value is not required for Private Auction deals or Preferred Deals.

5329

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

5330

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5331

# in Ad Manager.

5332

# Preferred Deal in Ad Manager.

5333

# This doesn't apply to Private Auction and AdX Preferred Deals.

5334

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

5335

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

5336

"creativeSpecifications": [

5337

{ # Represents information for a creative that is associated with a Programmatic

5338

# Guaranteed/Preferred Deal in Ad Manager.

5339

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5340

"width": "A String", # The width of the ad slot in pixels.

5341

# This field will be present only when size type is `PIXEL`.

5342

"sizeType": "A String", # The size type of the ad slot.

5343

"height": "A String", # The height of the ad slot in pixels.

5344

# This field will be present only when size type is `PIXEL`.

5345

},

5346

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

5347

{ # Represents size of a single ad slot, or a creative.

5348

"width": "A String", # The width of the ad slot in pixels.

5349

# This field will be present only when size type is `PIXEL`.

5350

"sizeType": "A String", # The size type of the ad slot.

5351

"height": "A String", # The height of the ad slot in pixels.

5352

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

5359

# target ad inventory. For example, they can choose to target ad requests only

5360

# if the user is in the US.

5361

# Multiple types of targeting are always applied as a logical AND, unless noted

5362

# otherwise.

5363

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5364

"excludedPositionTypes": [ # A list of video positions to be excluded.

5365

# Position types can either be included or excluded (XOR).

5366

"A String",

5367

],

5368

"targetedPositionTypes": [ # A list of video positions to be included.

5369

# When the included list is present, the excluded list must be empty.

5370

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

5375

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

5376

# included and excluded numeric IDs.

5377

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5378

"A String",

5379

],

5380

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5385

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5386

# included and excluded numeric IDs.

5387

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5388

"A String",

5389

],

5390

"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.

5395

# included and excluded numeric IDs.

5396

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5397

"A String",

5398

],

5399

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5405

# included and excluded numeric IDs.

5406

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5407

"A String",

5408

],

5409

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5415

# included and excluded numeric IDs.

5416

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5417

"A String",

5418

],

5419

"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.

5424

# mobile applications.

5425

# Different placement targeting types will be logically OR'ed.

5426

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5427

# For Private Auction and AdX Preferred Deals, URLs are either included or

5428

# excluded.

5429

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5430

# apply.

5431

"excludedUrls": [ # A list of URLs to be excluded.

5432

"A String",

5433

],

5434

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5439

# This doesn't apply to Auction Packages.

5440

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

5441

# display the ads in.

5442

# publishers own.

5443

# Mobile application IDs are from App Store and Google Play Store.

5444

# Android App ID, for example, com.google.android.apps.maps, can be found in

5445

# Google Play Store URL.

5446

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5447

# First party mobile applications is either included or excluded.

5448

"excludedAppIds": [ # A list of application IDs to be excluded.

5449

"A String",

5450

],

5451

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

5458

# request. It only applies to Private Auction, AdX Preferred Deals and

5459

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5460

# and Preferred Deals in Ad Manager.

5461

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5462

{ # Represents size of a single ad slot, or a creative.

5463

"width": "A String", # The width of the ad slot in pixels.

5464

# This field will be present only when size type is `PIXEL`.

5465

"sizeType": "A String", # The size type of the ad slot.

5466

"height": "A String", # The height of the ad slot in pixels.

5467

# This field will be present only when size type is `PIXEL`.

5468

},

5469

],

5470

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5471

{ # Represents size of a single ad slot, or a creative.

5472

"width": "A String", # The width of the ad slot in pixels.

5473

# This field will be present only when size type is `PIXEL`.

5474

"sizeType": "A String", # The size type of the ad slot.

5475

"height": "A String", # The height of the ad slot in pixels.

5476

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

5482

#

5483

# Note: This field may be set only when creating the resource. Modifying

5484

# this field while updating the resource will result in an error.

5485

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

5486

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

5487

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

5488

# to see but are non-negotiable. These are set by the publisher.

5489

"frequencyCaps": [ # Output only. Specifies any frequency caps.

5490

{ # Frequency cap.

5491

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

5492

# amount of time over which impressions per user are counted and capped.

5493

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5494

# which impressions per user are counted and capped.

5495

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

5496

# specified time period.

5497

},

5498

],

5499

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

5500

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

5501

},

5502

"description": "A String", # Description for the deal terms.

5503

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

5504

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5505

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5506

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

5507

# finalized. This is the deal ID that shows up in serving/reporting etc.

5508

"createTime": "A String", # Output only. The time of the deal creation.

5509

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

5510

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

5511

# and expected impressions from the publisher.

5512

"description": "A String", # Publisher provided description for the terms.

5513

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

5514

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

5515

# of guaranteed looks that the buyer is guaranteeing to buy.

5516

"fixedPrices": [ # Fixed price for the specified buyer.

5517

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5518

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5519

# a particular buyer or buyer/advertiser pair, we look for the most specific

5520

# matching rule - we first look for a rule matching the buyer and advertiser,

5521

# next a rule with the buyer but an empty advertiser list, and otherwise look

5522

# for a matching rule where no buyer is set.

5523

"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

5524

# (if the

5525

# advertisers match, and there's no more specific rule matching the buyer).

5526

# Authorized Buyers account ID.

5527

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5528

},

5529

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5530

# If empty, all advertisers with this buyer pay this price.

5531

"A String",

5532

],

5533

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5534

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5535

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5536

"nanos": 42, # Number of nano (10^-9) units of the amount.

5537

# The value must be between -999,999,999 and +999,999,999 inclusive.

5538

# If `units` is positive, `nanos` must be positive or zero.

5539

# If `units` is zero, `nanos` can be positive, zero, or negative.

5540

# If `units` is negative, `nanos` must be negative or zero.

5541

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5542

"units": "A String", # The whole units of the amount.

5543

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5544

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

5550

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

5551

},

5552

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

5553

# time zone used to mark the boundaries of a day. It should be an

5554

# IANA TZ name, such as "America/Los_Angeles". For more information,

5555

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

5556

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

5557

# Can be set by buyer or seller.

5558

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

5559

# the API at this time, but can be returned in a get or list request.

5560

"fixedPrices": [ # Fixed price for the specified buyer.

5561

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5562

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5563

# a particular buyer or buyer/advertiser pair, we look for the most specific

5564

# matching rule - we first look for a rule matching the buyer and advertiser,

5565

# next a rule with the buyer but an empty advertiser list, and otherwise look

5566

# for a matching rule where no buyer is set.

5567

"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

5568

# (if the

5569

# advertisers match, and there's no more specific rule matching the buyer).

5570

# Authorized Buyers account ID.

5571

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5572

},

5573

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5574

# If empty, all advertisers with this buyer pay this price.

5575

"A String",

5576

],

5577

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5578

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5579

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5580

"nanos": 42, # Number of nano (10^-9) units of the amount.

5581

# The value must be between -999,999,999 and +999,999,999 inclusive.

5582

# If `units` is positive, `nanos` must be positive or zero.

5583

# If `units` is zero, `nanos` can be positive, zero, or negative.

5584

# If `units` is negative, `nanos` must be negative or zero.

5585

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5586

"units": "A String", # The whole units of the amount.

5587

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5588

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

5595

# Can be set by buyer or seller.

5596

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5597

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5598

"nanos": 42, # Number of nano (10^-9) units of the amount.

5599

# The value must be between -999,999,999 and +999,999,999 inclusive.

5600

# If `units` is positive, `nanos` must be positive or zero.

5601

# If `units` is zero, `nanos` can be positive, zero, or negative.

5602

# If `units` is negative, `nanos` must be negative or zero.

5603

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5604

"units": "A String", # The whole units of the amount.

5605

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5606

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5607

},

5608

},

5609

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

5610

# by the seller, but they can be returned in a get or list request.

5611

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

5612

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5613

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5614

# a particular buyer or buyer/advertiser pair, we look for the most specific

5615

# matching rule - we first look for a rule matching the buyer and advertiser,

5616

# next a rule with the buyer but an empty advertiser list, and otherwise look

5617

# for a matching rule where no buyer is set.

5618

"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

5619

# (if the

5620

# advertisers match, and there's no more specific rule matching the buyer).

5621

# Authorized Buyers account ID.

5622

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5623

},

5624

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5625

# If empty, all advertisers with this buyer pay this price.

5626

"A String",

5627

],

5628

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5629

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5630

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5631

"nanos": 42, # Number of nano (10^-9) units of the amount.

5632

# The value must be between -999,999,999 and +999,999,999 inclusive.

5633

# If `units` is positive, `nanos` must be positive or zero.

5634

# If `units` is zero, `nanos` can be positive, zero, or negative.

5635

# If `units` is negative, `nanos` must be negative or zero.

5636

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5637

"units": "A String", # The whole units of the amount.

5638

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5639

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

5645

# in this private auction.

5646

},

5647

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

5648

},

5649

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5650

# PUBLISHER means creative is provided by seller and ADVERTISER means

5651

# creative is provided by buyer.

5652

"displayName": "A String", # The name of the deal.

5653

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5654

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5655

# operations (max-length: 1024 unicode code units).

5656

},

5657

"syndicationProduct": "A String", # The syndication product associated with the deal.

5658

#

5659

# Note: This field may be set only when creating the resource. Modifying

5660

# this field while updating the resource will result in an error.

5661

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5662

# targeting entity is AND'd together.

5663

{ # Advertisers can target different attributes of an ad slot. For example,

5664

# they can choose to show ads only if the user is in the U.S. Such

5665

# targeting criteria can be specified as part of Shared Targeting.

5666

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5667

# together.

5668

{ # A polymorphic targeting value used as part of Shared Targeting.

5669

"stringValue": "A String", # The string value to include/exclude.

5670

"longValue": "A String", # The long value to include/exclude.

5671

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5672

# Filled in when key = GOOG_CREATIVE_SIZE

5673

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5674

# Companion sizes may be filled in only when creative_size_type = VIDEO

5675

{ # Message depicting the size of the creative. The units of width and

5676

# height depend on the type of the targeting.

5677

"width": 42, # The width of the creative

5678

"height": 42, # The height of the creative.

5679

},

5680

],

5681

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5682

# only if creative_size_type = CreativeSizeType.NATIVE.

5683

"allowedFormats": [ # What formats are allowed by the publisher.

5684

# If this repeated field is empty then all formats are allowed.

5685

# For example, if this field contains AllowedFormatType.AUDIO then the

5686

# publisher only allows an audio ad (without any video).

5687

"A String",

5688

],

5689

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5690

# creative_size_type = CreativeSizeType.VIDEO.

5691

"creativeSizeType": "A String", # The creative size type.

5692

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5693

# of the creative

5694

# height depend on the type of the targeting.

5695

"width": 42, # The width of the creative

5696

"height": 42, # The height of the creative.

5697

},

5698

},

5699

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5700

# Filled in when the key is GOOG_DAYPART_TARGETING.

5701

# The definition of this targeting is derived from the structure

5702

# used by Ad Manager.

5703

"dayParts": [ # A list of day part targeting criterion.

5704

{ # Daypart targeting message that specifies if the ad can be shown

5705

# only during certain parts of a day/week.

5706

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5707

"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

5708

# granularity). The end time is exclusive. This field is not available

5709

# for filtering in PQL queries.

5710

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5711

# types are google.type.Date and `google.protobuf.Timestamp`.

5712

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5713

# allow the value 60 if it allows leap-seconds.

5714

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5715

# to allow the value "24:00:00" for scenarios like business closing time.

5716

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5717

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5718

},

5719

"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).

5720

# The start time is inclusive.

5721

# This field is not available for filtering in PQL queries.

5722

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5723

# types are google.type.Date and `google.protobuf.Timestamp`.

5724

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5725

# allow the value 60 if it allows leap-seconds.

5726

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5727

# to allow the value "24:00:00" for scenarios like business closing time.

5728

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5729

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5738

# together.

5739

{ # A polymorphic targeting value used as part of Shared Targeting.

5740

"stringValue": "A String", # The string value to include/exclude.

5741

"longValue": "A String", # The long value to include/exclude.

5742

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5743

# Filled in when key = GOOG_CREATIVE_SIZE

5744

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5745

# Companion sizes may be filled in only when creative_size_type = VIDEO

5746

{ # Message depicting the size of the creative. The units of width and

5747

# height depend on the type of the targeting.

5748

"width": 42, # The width of the creative

5749

"height": 42, # The height of the creative.

5750

},

5751

],

5752

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5753

# only if creative_size_type = CreativeSizeType.NATIVE.

5754

"allowedFormats": [ # What formats are allowed by the publisher.

5755

# If this repeated field is empty then all formats are allowed.

5756

# For example, if this field contains AllowedFormatType.AUDIO then the

5757

# publisher only allows an audio ad (without any video).

5758

"A String",

5759

],

5760

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5761

# creative_size_type = CreativeSizeType.VIDEO.

5762

"creativeSizeType": "A String", # The creative size type.

5763

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5764

# of the creative

5765

# height depend on the type of the targeting.

5766

"width": 42, # The width of the creative

5767

"height": 42, # The height of the creative.

5768

},

5769

},

5770

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5771

# Filled in when the key is GOOG_DAYPART_TARGETING.

5772

# The definition of this targeting is derived from the structure

5773

# used by Ad Manager.

5774

"dayParts": [ # A list of day part targeting criterion.

5775

{ # Daypart targeting message that specifies if the ad can be shown

5776

# only during certain parts of a day/week.

5777

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

5778

"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

5779

# granularity). The end time is exclusive. This field is not available

5780

# for filtering in PQL queries.

5781

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5782

# types are google.type.Date and `google.protobuf.Timestamp`.

5783

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5784

# allow the value 60 if it allows leap-seconds.

5785

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5786

# to allow the value "24:00:00" for scenarios like business closing time.

5787

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5788

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5789

},

5790

"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).

5791

# The start time is inclusive.

5792

# This field is not available for filtering in PQL queries.

5793

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5794

# types are google.type.Date and `google.protobuf.Timestamp`.

5795

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5796

# allow the value 60 if it allows leap-seconds.

5797

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5798

# to allow the value "24:00:00" for scenarios like business closing time.

5799

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5800

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

5809

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5810

# Third parties may define their own keys.

5811

# A list of permissible keys along with the acceptable values will be

5812

# provided as part of the external documentation.

5813

},

5814

],

5815

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5816

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

5817

# The deal is considered paused if either hasBuyerPaused or

5818

# hasSellPaused is true.

5819

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

5820

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5821

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5822

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

5823

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5824

},

5825

},

5826

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

5831

"displayName": "A String", # The name for the proposal.

5832

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5833

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5834

#

5835

# Note: This field may be set only when creating the resource. Modifying

5836

# this field while updating the resource will result in an error.

5837

# Authorized Buyers account ID.

5838

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5839

},

5840

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5841

# proposal.

5842

"notes": [ # Output only. The notes associated with this proposal.

5843

{ # A proposal may be associated to several notes.

5844

"note": "A String", # The actual note to attach.

5845

# (max-length: 1024 unicode code units)

5846

#

5847

# Note: This field may be set only when creating the resource. Modifying

5848

# this field while updating the resource will result in an error.

5849

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5850

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5851

"createTime": "A String", # Output only. The timestamp for when this note was created.

5852

"noteId": "A String", # Output only. The unique ID for the note.

5853

},

5854

],

5855

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5856

# left a comment.

5857

"buyerContacts": [ # Contact information for the buyer.

5858

{ # Contains information on how a buyer or seller can be reached.

5859

"email": "A String", # Email address for the contact.

5860

"name": "A String", # The name of the contact.

},

],

}</pre>

</div>

<code class="details" id="update">update(accountId, proposalId, body, x__xgafv=None)</code>

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)

5885

body: object, The request body. (required)

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.

5899

"sellerContacts": [ # Output only. Contact information for the seller.

5900

{ # Contains information on how a buyer or seller can be reached.

5901

"email": "A String", # Email address for the contact.

5902

"name": "A String", # The name of the contact.

5903

},

5904

],

5905

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5906

"proposalState": "A String", # Output only. The current state of the proposal.

5907

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5908

# Each update to the proposal or the deal causes the proposal revision number

5909

# to auto-increment. The buyer keeps track of the last revision number they

5910

# know of and pass it in when making an update. If the head revision number

5911

# on the server has since incremented, then an ABORTED error is returned

5912

# during the update operation to let the buyer know that a subsequent update

5913

# was made.

5914

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5915

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5916

# operations (max-length: 1024 unicode code units).

5917

},

5918

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5919

# proposal.

5920

"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.

5921

# Authorized Buyers account ID.

5922

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5923

},

5924

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5925

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

5926

#

5927

# Note: This field may be set only when creating the resource. Modifying

5928

# this field while updating the resource will result in an error.

5929

# Ad Manager account ID.

5930

"subAccountId": "A String", # Optional sub-account ID for the seller.

5931

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

5932

# The seller account ID is then available to buyer in the product.

5933

},

5934

"deals": [ # The deals associated with this proposal. For Private Auction proposals

5935

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5936

{ # A deal represents a segment of inventory for displaying ads on.

5937

# A proposal can contain multiple deals. A deal contains the terms and

5938

# targeting information that is used for serving.

5939

"updateTime": "A String", # Output only. The time when the deal was last updated.

5940

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

5941

# If present on create, and the server `product_revision` has advanced sinced

5942

# the passed-in `create_product_revision`, an `ABORTED` error will be

5943

# returned.

5944

#

5945

# Note: This field may be set only when creating the resource. Modifying

5946

# this field while updating the resource will result in an error.

5947

"sellerContacts": [ # Output only. Seller contact information for the deal.

5948

{ # Contains information on how a buyer or seller can be reached.

5949

"email": "A String", # Email address for the contact.

5950

"name": "A String", # The name of the contact.

5951

},

5952

],

5953

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

5954

# This will generally be stored in the granularity of one second since deal

5955

# serving starts at seconds boundary. Any time specified with more

5956

# granularity (e.g., in milliseconds) will be truncated towards the start of

5957

# time in seconds.

5958

"availableEndTime": "A String", # Proposed flight end time of the deal.

5959

# This will generally be stored in a granularity of a second.

5960

# A value is not required for Private Auction deals or Preferred Deals.

5961

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

5962

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5963

# in Ad Manager.

5964

# Preferred Deal in Ad Manager.

5965

# This doesn't apply to Private Auction and AdX Preferred Deals.

5966

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

5967

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

5968

"creativeSpecifications": [

5969

{ # Represents information for a creative that is associated with a Programmatic

5970

# Guaranteed/Preferred Deal in Ad Manager.

5971

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5972

"width": "A String", # The width of the ad slot in pixels.

5973

# This field will be present only when size type is `PIXEL`.

5974

"sizeType": "A String", # The size type of the ad slot.

5975

"height": "A String", # The height of the ad slot in pixels.

5976

# This field will be present only when size type is `PIXEL`.

5977

},

5978

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

5979

{ # Represents size of a single ad slot, or a creative.

5980

"width": "A String", # The width of the ad slot in pixels.

5981

# This field will be present only when size type is `PIXEL`.

5982

"sizeType": "A String", # The size type of the ad slot.

5983

"height": "A String", # The height of the ad slot in pixels.

5984

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

5991

# target ad inventory. For example, they can choose to target ad requests only

5992

# if the user is in the US.

5993

# Multiple types of targeting are always applied as a logical AND, unless noted

5994

# otherwise.

5995

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5996

"excludedPositionTypes": [ # A list of video positions to be excluded.

5997

# Position types can either be included or excluded (XOR).

5998

"A String",

5999

],

6000

"targetedPositionTypes": [ # A list of video positions to be included.

6001

# When the included list is present, the excluded list must be empty.

6002

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

6007

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

6008

# included and excluded numeric IDs.

6009

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6010

"A String",

6011

],

6012

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6017

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6018

# included and excluded numeric IDs.

6019

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6020

"A String",

6021

],

6022

"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.

6027

# included and excluded numeric IDs.

6028

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6029

"A String",

6030

],

6031

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6037

# included and excluded numeric IDs.

6038

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6039

"A String",

6040

],

6041

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6047

# included and excluded numeric IDs.

6048

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6049

"A String",

6050

],

6051

"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.

6056

# mobile applications.

6057

# Different placement targeting types will be logically OR'ed.

6058

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6059

# For Private Auction and AdX Preferred Deals, URLs are either included or

6060

# excluded.

6061

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6062

# apply.

6063

"excludedUrls": [ # A list of URLs to be excluded.

6064

"A String",

6065

],

6066

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6071

# This doesn't apply to Auction Packages.

6072

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

6073

# display the ads in.

6074

# publishers own.

6075

# Mobile application IDs are from App Store and Google Play Store.

6076

# Android App ID, for example, com.google.android.apps.maps, can be found in

6077

# Google Play Store URL.

6078

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6079

# First party mobile applications is either included or excluded.

6080

"excludedAppIds": [ # A list of application IDs to be excluded.

6081

"A String",

6082

],

6083

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

6090

# request. It only applies to Private Auction, AdX Preferred Deals and

6091

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6092

# and Preferred Deals in Ad Manager.

6093

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6094

{ # Represents size of a single ad slot, or a creative.

6095

"width": "A String", # The width of the ad slot in pixels.

6096

# This field will be present only when size type is `PIXEL`.

6097

"sizeType": "A String", # The size type of the ad slot.

6098

"height": "A String", # The height of the ad slot in pixels.

6099

# This field will be present only when size type is `PIXEL`.

6100

},

6101

],

6102

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6103

{ # Represents size of a single ad slot, or a creative.

6104

"width": "A String", # The width of the ad slot in pixels.

6105

# This field will be present only when size type is `PIXEL`.

6106

"sizeType": "A String", # The size type of the ad slot.

6107

"height": "A String", # The height of the ad slot in pixels.

6108

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

6114

#

6115

# Note: This field may be set only when creating the resource. Modifying

6116

# this field while updating the resource will result in an error.

6117

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

6118

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

6119

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

6120

# to see but are non-negotiable. These are set by the publisher.

6121

"frequencyCaps": [ # Output only. Specifies any frequency caps.

6122

{ # Frequency cap.

6123

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

6124

# amount of time over which impressions per user are counted and capped.

6125

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6126

# which impressions per user are counted and capped.

6127

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

6128

# specified time period.

6129

},

6130

],

6131

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

6132

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

6133

},

6134

"description": "A String", # Description for the deal terms.

6135

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

6136

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6137

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6138

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6139

# finalized. This is the deal ID that shows up in serving/reporting etc.

6140

"createTime": "A String", # Output only. The time of the deal creation.

6141

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6142

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6143

# and expected impressions from the publisher.

6144

"description": "A String", # Publisher provided description for the terms.

6145

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6146

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6147

# of guaranteed looks that the buyer is guaranteeing to buy.

6148

"fixedPrices": [ # Fixed price for the specified buyer.

6149

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6150

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6151

# a particular buyer or buyer/advertiser pair, we look for the most specific

6152

# matching rule - we first look for a rule matching the buyer and advertiser,

6153

# next a rule with the buyer but an empty advertiser list, and otherwise look

6154

# for a matching rule where no buyer is set.

6155

"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

6156

# (if the

6157

# advertisers match, and there's no more specific rule matching the buyer).

6158

# Authorized Buyers account ID.

6159

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6160

},

6161

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6162

# If empty, all advertisers with this buyer pay this price.

6163

"A String",

6164

],

6165

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6166

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6167

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6168

"nanos": 42, # Number of nano (10^-9) units of the amount.

6169

# The value must be between -999,999,999 and +999,999,999 inclusive.

6170

# If `units` is positive, `nanos` must be positive or zero.

6171

# If `units` is zero, `nanos` can be positive, zero, or negative.

6172

# If `units` is negative, `nanos` must be negative or zero.

6173

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6174

"units": "A String", # The whole units of the amount.

6175

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6176

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6182

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6183

},

6184

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6185

# time zone used to mark the boundaries of a day. It should be an

6186

# IANA TZ name, such as "America/Los_Angeles". For more information,

6187

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

6188

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6189

# Can be set by buyer or seller.

6190

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6191

# the API at this time, but can be returned in a get or list request.

6192

"fixedPrices": [ # Fixed price for the specified buyer.

6193

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6194

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6195

# a particular buyer or buyer/advertiser pair, we look for the most specific

6196

# matching rule - we first look for a rule matching the buyer and advertiser,

6197

# next a rule with the buyer but an empty advertiser list, and otherwise look

6198

# for a matching rule where no buyer is set.

6199

"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

6200

# (if the

6201

# advertisers match, and there's no more specific rule matching the buyer).

6202

# Authorized Buyers account ID.

6203

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6204

},

6205

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6206

# If empty, all advertisers with this buyer pay this price.

6207

"A String",

6208

],

6209

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6210

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6211

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6212

"nanos": 42, # Number of nano (10^-9) units of the amount.

6213

# The value must be between -999,999,999 and +999,999,999 inclusive.

6214

# If `units` is positive, `nanos` must be positive or zero.

6215

# If `units` is zero, `nanos` can be positive, zero, or negative.

6216

# If `units` is negative, `nanos` must be negative or zero.

6217

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6218

"units": "A String", # The whole units of the amount.

6219

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6220

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

6227

# Can be set by buyer or seller.

6228

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6229

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6230

"nanos": 42, # Number of nano (10^-9) units of the amount.

6231

# The value must be between -999,999,999 and +999,999,999 inclusive.

6232

# If `units` is positive, `nanos` must be positive or zero.

6233

# If `units` is zero, `nanos` can be positive, zero, or negative.

6234

# If `units` is negative, `nanos` must be negative or zero.

6235

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6236

"units": "A String", # The whole units of the amount.

6237

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6238

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6239

},

6240

},

6241

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6242

# by the seller, but they can be returned in a get or list request.

6243

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6244

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6245

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6246

# a particular buyer or buyer/advertiser pair, we look for the most specific

6247

# matching rule - we first look for a rule matching the buyer and advertiser,

6248

# next a rule with the buyer but an empty advertiser list, and otherwise look

6249

# for a matching rule where no buyer is set.

6250

"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

6251

# (if the

6252

# advertisers match, and there's no more specific rule matching the buyer).

6253

# Authorized Buyers account ID.

6254

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6255

},

6256

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6257

# If empty, all advertisers with this buyer pay this price.

6258

"A String",

6259

],

6260

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6261

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6262

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6263

"nanos": 42, # Number of nano (10^-9) units of the amount.

6264

# The value must be between -999,999,999 and +999,999,999 inclusive.

6265

# If `units` is positive, `nanos` must be positive or zero.

6266

# If `units` is zero, `nanos` can be positive, zero, or negative.

6267

# If `units` is negative, `nanos` must be negative or zero.

6268

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6269

"units": "A String", # The whole units of the amount.

6270

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6271

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6277

# in this private auction.

6278

},

6279

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6280

},

6281

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6282

# PUBLISHER means creative is provided by seller and ADVERTISER means

6283

# creative is provided by buyer.

6284

"displayName": "A String", # The name of the deal.

6285

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6286

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6287

# operations (max-length: 1024 unicode code units).

6288

},

6289

"syndicationProduct": "A String", # The syndication product associated with the deal.

6290

#

6291

# Note: This field may be set only when creating the resource. Modifying

6292

# this field while updating the resource will result in an error.

6293

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6294

# targeting entity is AND'd together.

6295

{ # Advertisers can target different attributes of an ad slot. For example,

6296

# they can choose to show ads only if the user is in the U.S. Such

6297

# targeting criteria can be specified as part of Shared Targeting.

6298

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6299

# together.

6300

{ # A polymorphic targeting value used as part of Shared Targeting.

6301

"stringValue": "A String", # The string value to include/exclude.

6302

"longValue": "A String", # The long value to include/exclude.

6303

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6304

# Filled in when key = GOOG_CREATIVE_SIZE

6305

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6306

# Companion sizes may be filled in only when creative_size_type = VIDEO

6307

{ # Message depicting the size of the creative. The units of width and

6308

# height depend on the type of the targeting.

6309

"width": 42, # The width of the creative

6310

"height": 42, # The height of the creative.

6311

},

6312

],

6313

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6314

# only if creative_size_type = CreativeSizeType.NATIVE.

6315

"allowedFormats": [ # What formats are allowed by the publisher.

6316

# If this repeated field is empty then all formats are allowed.

6317

# For example, if this field contains AllowedFormatType.AUDIO then the

6318

# publisher only allows an audio ad (without any video).

6319

"A String",

6320

],

6321

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6322

# creative_size_type = CreativeSizeType.VIDEO.

6323

"creativeSizeType": "A String", # The creative size type.

6324

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6325

# of the creative

6326

# height depend on the type of the targeting.

6327

"width": 42, # The width of the creative

6328

"height": 42, # The height of the creative.

6329

},

6330

},

6331

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6332

# Filled in when the key is GOOG_DAYPART_TARGETING.

6333

# The definition of this targeting is derived from the structure

6334

# used by Ad Manager.

6335

"dayParts": [ # A list of day part targeting criterion.

6336

{ # Daypart targeting message that specifies if the ad can be shown

6337

# only during certain parts of a day/week.

6338

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6339

"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

6340

# granularity). The end time is exclusive. This field is not available

6341

# for filtering in PQL queries.

6342

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6343

# types are google.type.Date and `google.protobuf.Timestamp`.

6344

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6345

# allow the value 60 if it allows leap-seconds.

6346

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6347

# to allow the value "24:00:00" for scenarios like business closing time.

6348

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6349

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6350

},

6351

"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).

6352

# The start time is inclusive.

6353

# This field is not available for filtering in PQL queries.

6354

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6355

# types are google.type.Date and `google.protobuf.Timestamp`.

6356

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6357

# allow the value 60 if it allows leap-seconds.

6358

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6359

# to allow the value "24:00:00" for scenarios like business closing time.

6360

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6361

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6370

# together.

6371

{ # A polymorphic targeting value used as part of Shared Targeting.

6372

"stringValue": "A String", # The string value to include/exclude.

6373

"longValue": "A String", # The long value to include/exclude.

6374

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6375

# Filled in when key = GOOG_CREATIVE_SIZE

6376

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6377

# Companion sizes may be filled in only when creative_size_type = VIDEO

6378

{ # Message depicting the size of the creative. The units of width and

6379

# height depend on the type of the targeting.

6380

"width": 42, # The width of the creative

6381

"height": 42, # The height of the creative.

6382

},

6383

],

6384

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6385

# only if creative_size_type = CreativeSizeType.NATIVE.

6386

"allowedFormats": [ # What formats are allowed by the publisher.

6387

# If this repeated field is empty then all formats are allowed.

6388

# For example, if this field contains AllowedFormatType.AUDIO then the

6389

# publisher only allows an audio ad (without any video).

6390

"A String",

6391

],

6392

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6393

# creative_size_type = CreativeSizeType.VIDEO.

6394

"creativeSizeType": "A String", # The creative size type.

6395

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6396

# of the creative

6397

# height depend on the type of the targeting.

6398

"width": 42, # The width of the creative

6399

"height": 42, # The height of the creative.

6400

},

6401

},

6402

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6403

# Filled in when the key is GOOG_DAYPART_TARGETING.

6404

# The definition of this targeting is derived from the structure

6405

# used by Ad Manager.

6406

"dayParts": [ # A list of day part targeting criterion.

6407

{ # Daypart targeting message that specifies if the ad can be shown

6408

# only during certain parts of a day/week.

6409

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6410

"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

6411

# granularity). The end time is exclusive. This field is not available

6412

# for filtering in PQL queries.

6413

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6414

# types are google.type.Date and `google.protobuf.Timestamp`.

6415

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6416

# allow the value 60 if it allows leap-seconds.

6417

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6418

# to allow the value "24:00:00" for scenarios like business closing time.

6419

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6420

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6421

},

6422

"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).

6423

# The start time is inclusive.

6424

# This field is not available for filtering in PQL queries.

6425

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6426

# types are google.type.Date and `google.protobuf.Timestamp`.

6427

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6428

# allow the value 60 if it allows leap-seconds.

6429

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6430

# to allow the value "24:00:00" for scenarios like business closing time.

6431

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6432

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

6441

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6442

# Third parties may define their own keys.

6443

# A list of permissible keys along with the acceptable values will be

6444

# provided as part of the external documentation.

6445

},

6446

],

6447

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6448

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

6449

# The deal is considered paused if either hasBuyerPaused or

6450

# hasSellPaused is true.

6451

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

6452

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6453

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6454

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

6455

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6456

},

6457

},

6458

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

6463

"displayName": "A String", # The name for the proposal.

6464

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

6465

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

6466

#

6467

# Note: This field may be set only when creating the resource. Modifying

6468

# this field while updating the resource will result in an error.

6469

# Authorized Buyers account ID.

6470

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6471

},

6472

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6473

# proposal.

6474

"notes": [ # Output only. The notes associated with this proposal.

6475

{ # A proposal may be associated to several notes.

6476

"note": "A String", # The actual note to attach.

6477

# (max-length: 1024 unicode code units)

6478

#

6479

# Note: This field may be set only when creating the resource. Modifying

6480

# this field while updating the resource will result in an error.

6481

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

6482

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

6483

"createTime": "A String", # Output only. The timestamp for when this note was created.

6484

"noteId": "A String", # Output only. The unique ID for the note.

6485

},

6486

],

6487

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

6488

# left a comment.

6489

"buyerContacts": [ # Contact information for the buyer.

6490

{ # Contains information on how a buyer or seller can be reached.

6491

"email": "A String", # Email address for the contact.

6492

"name": "A String", # The name of the contact.

},

],

}

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.

6516

"sellerContacts": [ # Output only. Contact information for the seller.

6517

{ # Contains information on how a buyer or seller can be reached.

6518

"email": "A String", # Email address for the contact.

6519

"name": "A String", # The name of the contact.

6520

},

6521

],

6522

"updateTime": "A String", # Output only. The time when the proposal was last revised.

6523

"proposalState": "A String", # Output only. The current state of the proposal.

6524

"proposalRevision": "A String", # Output only. The revision number for the proposal.

6525

# Each update to the proposal or the deal causes the proposal revision number

6526

# to auto-increment. The buyer keeps track of the last revision number they

6527

# know of and pass it in when making an update. If the head revision number

6528

# on the server has since incremented, then an ABORTED error is returned

6529

# during the update operation to let the buyer know that a subsequent update

6530

# was made.

6531

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

6532

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6533

# operations (max-length: 1024 unicode code units).

6534

},

6535

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

6536

# proposal.

6537

"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.

6538

# Authorized Buyers account ID.

6539

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6540

},

6541

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

6542

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

6543

#

6544

# Note: This field may be set only when creating the resource. Modifying

6545

# this field while updating the resource will result in an error.

6546

# Ad Manager account ID.

6547

"subAccountId": "A String", # Optional sub-account ID for the seller.

6548

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

6549

# The seller account ID is then available to buyer in the product.

6550

},

6551

"deals": [ # The deals associated with this proposal. For Private Auction proposals

6552

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

6553

{ # A deal represents a segment of inventory for displaying ads on.

6554

# A proposal can contain multiple deals. A deal contains the terms and

6555

# targeting information that is used for serving.

6556

"updateTime": "A String", # Output only. The time when the deal was last updated.

6557

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

6558

# If present on create, and the server `product_revision` has advanced sinced

6559

# the passed-in `create_product_revision`, an `ABORTED` error will be

6560

# returned.

6561

#

6562

# Note: This field may be set only when creating the resource. Modifying

6563

# this field while updating the resource will result in an error.

6564

"sellerContacts": [ # Output only. Seller contact information for the deal.

6565

{ # Contains information on how a buyer or seller can be reached.

6566

"email": "A String", # Email address for the contact.

6567

"name": "A String", # The name of the contact.

6568

},

6569

],

6570

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

6571

# This will generally be stored in the granularity of one second since deal

6572

# serving starts at seconds boundary. Any time specified with more

6573

# granularity (e.g., in milliseconds) will be truncated towards the start of

6574

# time in seconds.

6575

"availableEndTime": "A String", # Proposed flight end time of the deal.

6576

# This will generally be stored in a granularity of a second.

6577

# A value is not required for Private Auction deals or Preferred Deals.

6578

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

6579

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6580

# in Ad Manager.

6581

# Preferred Deal in Ad Manager.

6582

# This doesn't apply to Private Auction and AdX Preferred Deals.

6583

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

6584

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

6585

"creativeSpecifications": [

6586

{ # Represents information for a creative that is associated with a Programmatic

6587

# Guaranteed/Preferred Deal in Ad Manager.

6588

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6589

"width": "A String", # The width of the ad slot in pixels.

6590

# This field will be present only when size type is `PIXEL`.

6591

"sizeType": "A String", # The size type of the ad slot.

6592

"height": "A String", # The height of the ad slot in pixels.

6593

# This field will be present only when size type is `PIXEL`.

6594

},

6595

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

6596

{ # Represents size of a single ad slot, or a creative.

6597

"width": "A String", # The width of the ad slot in pixels.

6598

# This field will be present only when size type is `PIXEL`.

6599

"sizeType": "A String", # The size type of the ad slot.

6600

"height": "A String", # The height of the ad slot in pixels.

6601

# This field will be present only when size type is `PIXEL`.

},

],

},

],

},

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

6608

# target ad inventory. For example, they can choose to target ad requests only

6609

# if the user is in the US.

6610

# Multiple types of targeting are always applied as a logical AND, unless noted

6611

# otherwise.

6612

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6613

"excludedPositionTypes": [ # A list of video positions to be excluded.

6614

# Position types can either be included or excluded (XOR).

6615

"A String",

6616

],

6617

"targetedPositionTypes": [ # A list of video positions to be included.

6618

# When the included list is present, the excluded list must be empty.

6619

# When the excluded list is present, the included list must be empty.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

6624

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

6625

# included and excluded numeric IDs.

6626

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6627

"A String",

6628

],

6629

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6634

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6635

# included and excluded numeric IDs.

6636

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6637

"A String",

6638

],

6639

"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.

6644

# included and excluded numeric IDs.

6645

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6646

"A String",

6647

],

6648

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6654

# included and excluded numeric IDs.

6655

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6656

"A String",

6657

],

6658

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

"A String",

],

},

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6664

# included and excluded numeric IDs.

6665

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6666

"A String",

6667

],

6668

"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.

6673

# mobile applications.

6674

# Different placement targeting types will be logically OR'ed.

6675

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6676

# For Private Auction and AdX Preferred Deals, URLs are either included or

6677

# excluded.

6678

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6679

# apply.

6680

"excludedUrls": [ # A list of URLs to be excluded.

6681

"A String",

6682

],

6683

"targetedUrls": [ # A list of URLs to be included.

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6688

# This doesn't apply to Auction Packages.

6689

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

6690

# display the ads in.

6691

# publishers own.

6692

# Mobile application IDs are from App Store and Google Play Store.

6693

# Android App ID, for example, com.google.android.apps.maps, can be found in

6694

# Google Play Store URL.

6695

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6696

# First party mobile applications is either included or excluded.

6697

"excludedAppIds": [ # A list of application IDs to be excluded.

6698

"A String",

6699

],

6700

"targetedAppIds": [ # A list of application IDs to be included.

"A String",

],

},

},

},

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

6707

# request. It only applies to Private Auction, AdX Preferred Deals and

6708

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6709

# and Preferred Deals in Ad Manager.

6710

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6711

{ # Represents size of a single ad slot, or a creative.

6712

"width": "A String", # The width of the ad slot in pixels.

6713

# This field will be present only when size type is `PIXEL`.

6714

"sizeType": "A String", # The size type of the ad slot.

6715

"height": "A String", # The height of the ad slot in pixels.

6716

# This field will be present only when size type is `PIXEL`.

6717

},

6718

],

6719

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6720

{ # Represents size of a single ad slot, or a creative.

6721

"width": "A String", # The width of the ad slot in pixels.

6722

# This field will be present only when size type is `PIXEL`.

6723

"sizeType": "A String", # The size type of the ad slot.

6724

"height": "A String", # The height of the ad slot in pixels.

6725

# This field will be present only when size type is `PIXEL`.

},

],

},

},

"createProductId": "A String", # The product ID from which this deal was created.

6731

#

6732

# Note: This field may be set only when creating the resource. Modifying

6733

# this field while updating the resource will result in an error.

6734

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

6735

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

6736

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

6737

# to see but are non-negotiable. These are set by the publisher.

6738

"frequencyCaps": [ # Output only. Specifies any frequency caps.

6739

{ # Frequency cap.

6740

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

6741

# amount of time over which impressions per user are counted and capped.

6742

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6743

# which impressions per user are counted and capped.

6744

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

6745

# specified time period.

6746

},

6747

],

6748

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

6749

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

6750

},

6751

"description": "A String", # Description for the deal terms.

6752

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

6753

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6754

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6755

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6756

# finalized. This is the deal ID that shows up in serving/reporting etc.

6757

"createTime": "A String", # Output only. The time of the deal creation.

6758

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6759

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6760

# and expected impressions from the publisher.

6761

"description": "A String", # Publisher provided description for the terms.

6762

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6763

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6764

# of guaranteed looks that the buyer is guaranteeing to buy.

6765

"fixedPrices": [ # Fixed price for the specified buyer.

6766

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6767

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6768

# a particular buyer or buyer/advertiser pair, we look for the most specific

6769

# matching rule - we first look for a rule matching the buyer and advertiser,

6770

# next a rule with the buyer but an empty advertiser list, and otherwise look

6771

# for a matching rule where no buyer is set.

6772

"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

6773

# (if the

6774

# advertisers match, and there's no more specific rule matching the buyer).

6775

# Authorized Buyers account ID.

6776

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6777

},

6778

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6779

# If empty, all advertisers with this buyer pay this price.

6780

"A String",

6781

],

6782

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6783

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6784

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6785

"nanos": 42, # Number of nano (10^-9) units of the amount.

6786

# The value must be between -999,999,999 and +999,999,999 inclusive.

6787

# If `units` is positive, `nanos` must be positive or zero.

6788

# If `units` is zero, `nanos` can be positive, zero, or negative.

6789

# If `units` is negative, `nanos` must be negative or zero.

6790

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6791

"units": "A String", # The whole units of the amount.

6792

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6793

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6799

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6800

},

6801

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6802

# time zone used to mark the boundaries of a day. It should be an

6803

# IANA TZ name, such as "America/Los_Angeles". For more information,

6804

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

6805

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6806

# Can be set by buyer or seller.

6807

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6808

# the API at this time, but can be returned in a get or list request.

6809

"fixedPrices": [ # Fixed price for the specified buyer.

6810

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6811

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6812

# a particular buyer or buyer/advertiser pair, we look for the most specific

6813

# matching rule - we first look for a rule matching the buyer and advertiser,

6814

# next a rule with the buyer but an empty advertiser list, and otherwise look

6815

# for a matching rule where no buyer is set.

6816

"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

6817

# (if the

6818

# advertisers match, and there's no more specific rule matching the buyer).

6819

# Authorized Buyers account ID.

6820

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6821

},

6822

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6823

# If empty, all advertisers with this buyer pay this price.

6824

"A String",

6825

],

6826

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6827

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6828

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6829

"nanos": 42, # Number of nano (10^-9) units of the amount.

6830

# The value must be between -999,999,999 and +999,999,999 inclusive.

6831

# If `units` is positive, `nanos` must be positive or zero.

6832

# If `units` is zero, `nanos` can be positive, zero, or negative.

6833

# If `units` is negative, `nanos` must be negative or zero.

6834

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6835

"units": "A String", # The whole units of the amount.

6836

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6837

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

6844

# Can be set by buyer or seller.

6845

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6846

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6847

"nanos": 42, # Number of nano (10^-9) units of the amount.

6848

# The value must be between -999,999,999 and +999,999,999 inclusive.

6849

# If `units` is positive, `nanos` must be positive or zero.

6850

# If `units` is zero, `nanos` can be positive, zero, or negative.

6851

# If `units` is negative, `nanos` must be negative or zero.

6852

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6853

"units": "A String", # The whole units of the amount.

6854

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6855

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6856

},

6857

},

6858

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6859

# by the seller, but they can be returned in a get or list request.

6860

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6861

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6862

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6863

# a particular buyer or buyer/advertiser pair, we look for the most specific

6864

# matching rule - we first look for a rule matching the buyer and advertiser,

6865

# next a rule with the buyer but an empty advertiser list, and otherwise look

6866

# for a matching rule where no buyer is set.

6867

"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

6868

# (if the

6869

# advertisers match, and there's no more specific rule matching the buyer).

6870

# Authorized Buyers account ID.

6871

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6872

},

6873

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6874

# If empty, all advertisers with this buyer pay this price.

6875

"A String",

6876

],

6877

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6878

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6879

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6880

"nanos": 42, # Number of nano (10^-9) units of the amount.

6881

# The value must be between -999,999,999 and +999,999,999 inclusive.

6882

# If `units` is positive, `nanos` must be positive or zero.

6883

# If `units` is zero, `nanos` can be positive, zero, or negative.

6884

# If `units` is negative, `nanos` must be negative or zero.

6885

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6886

"units": "A String", # The whole units of the amount.

6887

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6888

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6894

# in this private auction.

6895

},

6896

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6897

},

6898

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6899

# PUBLISHER means creative is provided by seller and ADVERTISER means

6900

# creative is provided by buyer.

6901

"displayName": "A String", # The name of the deal.

6902

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6903

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6904

# operations (max-length: 1024 unicode code units).

6905

},

6906

"syndicationProduct": "A String", # The syndication product associated with the deal.

6907

#

6908

# Note: This field may be set only when creating the resource. Modifying

6909

# this field while updating the resource will result in an error.

6910

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6911

# targeting entity is AND'd together.

6912

{ # Advertisers can target different attributes of an ad slot. For example,

6913

# they can choose to show ads only if the user is in the U.S. Such

6914

# targeting criteria can be specified as part of Shared Targeting.

6915

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6916

# together.

6917

{ # A polymorphic targeting value used as part of Shared Targeting.

6918

"stringValue": "A String", # The string value to include/exclude.

6919

"longValue": "A String", # The long value to include/exclude.

6920

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6921

# Filled in when key = GOOG_CREATIVE_SIZE

6922

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6923

# Companion sizes may be filled in only when creative_size_type = VIDEO

6924

{ # Message depicting the size of the creative. The units of width and

6925

# height depend on the type of the targeting.

6926

"width": 42, # The width of the creative

6927

"height": 42, # The height of the creative.

6928

},

6929

],

6930

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6931

# only if creative_size_type = CreativeSizeType.NATIVE.

6932

"allowedFormats": [ # What formats are allowed by the publisher.

6933

# If this repeated field is empty then all formats are allowed.

6934

# For example, if this field contains AllowedFormatType.AUDIO then the

6935

# publisher only allows an audio ad (without any video).

6936

"A String",

6937

],

6938

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6939

# creative_size_type = CreativeSizeType.VIDEO.

6940

"creativeSizeType": "A String", # The creative size type.

6941

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6942

# of the creative

6943

# height depend on the type of the targeting.

6944

"width": 42, # The width of the creative

6945

"height": 42, # The height of the creative.

6946

},

6947

},

6948

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6949

# Filled in when the key is GOOG_DAYPART_TARGETING.

6950

# The definition of this targeting is derived from the structure

6951

# used by Ad Manager.

6952

"dayParts": [ # A list of day part targeting criterion.

6953

{ # Daypart targeting message that specifies if the ad can be shown

6954

# only during certain parts of a day/week.

6955

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

6956

"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

6957

# granularity). The end time is exclusive. This field is not available

6958

# for filtering in PQL queries.

6959

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6960

# types are google.type.Date and `google.protobuf.Timestamp`.

6961

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6962

# allow the value 60 if it allows leap-seconds.

6963

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6964

# to allow the value "24:00:00" for scenarios like business closing time.

6965

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6966

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6967

},

6968

"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).

6969

# The start time is inclusive.

6970

# This field is not available for filtering in PQL queries.

6971

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6972

# types are google.type.Date and `google.protobuf.Timestamp`.

6973

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6974

# allow the value 60 if it allows leap-seconds.

6975

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6976

# to allow the value "24:00:00" for scenarios like business closing time.

6977

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6978

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6987

# together.

6988

{ # A polymorphic targeting value used as part of Shared Targeting.

6989

"stringValue": "A String", # The string value to include/exclude.

6990

"longValue": "A String", # The long value to include/exclude.

6991

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6992

# Filled in when key = GOOG_CREATIVE_SIZE

6993

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6994

# Companion sizes may be filled in only when creative_size_type = VIDEO

6995

{ # Message depicting the size of the creative. The units of width and

6996

# height depend on the type of the targeting.

6997

"width": 42, # The width of the creative

6998

"height": 42, # The height of the creative.

6999

},

7000

],

7001

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

7002

# only if creative_size_type = CreativeSizeType.NATIVE.

7003

"allowedFormats": [ # What formats are allowed by the publisher.

7004

# If this repeated field is empty then all formats are allowed.

7005

# For example, if this field contains AllowedFormatType.AUDIO then the

7006

# publisher only allows an audio ad (without any video).

7007

"A String",

7008

],

7009

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

7010

# creative_size_type = CreativeSizeType.VIDEO.

7011

"creativeSizeType": "A String", # The creative size type.

7012

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

7013

# of the creative

7014

# height depend on the type of the targeting.

7015

"width": 42, # The width of the creative

7016

"height": 42, # The height of the creative.

7017

},

7018

},

7019

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

7020

# Filled in when the key is GOOG_DAYPART_TARGETING.

7021

# The definition of this targeting is derived from the structure

7022

# used by Ad Manager.

7023

"dayParts": [ # A list of day part targeting criterion.

7024

{ # Daypart targeting message that specifies if the ad can be shown

7025

# only during certain parts of a day/week.

7026

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

7027

"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

7028

# granularity). The end time is exclusive. This field is not available

7029

# for filtering in PQL queries.

7030

# or are specified elsewhere. An API may choose to allow leap seconds. Related

7031

# types are google.type.Date and `google.protobuf.Timestamp`.

7032

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

7033

# allow the value 60 if it allows leap-seconds.

7034

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

7035

# to allow the value "24:00:00" for scenarios like business closing time.

7036

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

7037

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

7038

},

7039

"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).

7040

# The start time is inclusive.

7041

# This field is not available for filtering in PQL queries.

7042

# or are specified elsewhere. An API may choose to allow leap seconds. Related

7043

# types are google.type.Date and `google.protobuf.Timestamp`.

7044

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

7045

# allow the value 60 if it allows leap-seconds.

7046

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

7047

# to allow the value "24:00:00" for scenarios like business closing time.

7048

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

7049

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

},

},

],

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

},

},

],

"key": "A String", # The key representing the shared targeting criterion.

7058

# Targeting criteria defined by Google ad servers will begin with GOOG_.

7059

# Third parties may define their own keys.

7060

# A list of permissible keys along with the acceptable values will be

7061

# provided as part of the external documentation.

7062

},

7063

],

7064

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

7065

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

7066

# The deal is considered paused if either hasBuyerPaused or

7067

# hasSellPaused is true.

7068

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

7069

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

7070

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

7071

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

7072

"firstPausedBy": "A String", # The role of the person who first paused this deal.

7073

},

7074

},

7075

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

# deal.

},

],

"proposalId": "A String", # Output only. The unique ID of the proposal.

7080

"displayName": "A String", # The name for the proposal.

7081

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

7082

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

7083

#

7084

# Note: This field may be set only when creating the resource. Modifying

7085

# this field while updating the resource will result in an error.

7086

# Authorized Buyers account ID.

7087

"accountId": "A String", # Authorized Buyers account ID of the buyer.

7088

},

7089

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

7090

# proposal.

7091

"notes": [ # Output only. The notes associated with this proposal.

7092

{ # A proposal may be associated to several notes.

7093

"note": "A String", # The actual note to attach.

7094

# (max-length: 1024 unicode code units)

7095

#

7096

# Note: This field may be set only when creating the resource. Modifying

7097

# this field while updating the resource will result in an error.

7098

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

7099

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

7100

"createTime": "A String", # Output only. The timestamp for when this note was created.

7101

"noteId": "A String", # Output only. The unique ID for the note.

7102

},

7103

],

7104

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

7105

# left a comment.

7106

"buyerContacts": [ # Contact information for the buyer.

7107

{ # Contains information on how a buyer or seller can be reached.

7108

"email": "A String", # Email address for the contact.

7109

"name": "A String", # The name of the contact.

},

],

}</pre>

</div>

</body></html>