Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.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.finalizedProposals.html">finalizedProposals</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

<h3>Method Details</h3>

84

85

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

86

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

87

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

88

The notes will not be returned.

89

90

Args:

91

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

92

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

93

If unspecified, the server will pick an appropriate default.

94

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

95

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

100

but in the future it will be LIST_FILTER.

101

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

102

103

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

cannot be filtered.

Returns:

An object of the form:

108

109

{ # Response message for listing proposals.

110

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

111

"proposals": [ # The list of proposals.

112

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

113

# account manager for access to Marketplace resources.

114

#

115

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

116

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

117

# are served.

118

#

119

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

120

# Auction or Preferred Deals deals through the API.

121

#

122

# Fields are updatable unless noted otherwise.

123

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

124

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

125

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

126

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

127

},

128

],

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

# was made.

138

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

139

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

140

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

141

},

142

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

143

# proposal.

144

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

145

# Authorized Buyers account ID.

146

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

147

},

148

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

149

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

150

#

151

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

152

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

153

# Ad Manager account ID.

154

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

155

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

156

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

157

},

158

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

159

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

160

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

161

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

162

# targeting information that is used for serving.

163

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

164

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

165

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

166

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

167

# returned.

168

#

169

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

170

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

171

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

172

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

173

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

174

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

175

},

176

],

177

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

178

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

179

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

180

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

181

# time in seconds.

182

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

183

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

184

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

185

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

186

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

187

# in Ad Manager.

188

# Preferred Deal in Ad Manager.

189

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

190

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

191

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

192

"creativeSpecifications": [

193

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

194

# Guaranteed/Preferred Deal in Ad Manager.

195

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

196

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

197

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

198

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

199

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

200

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

201

},

202

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

203

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

204

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

205

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

206

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

207

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

208

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

215

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

216

# if the user is in the US.

217

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

218

# otherwise.

219

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

220

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

221

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

222

"A String",

223

],

224

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

225

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

226

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

231

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

232

# included and excluded numeric IDs.

233

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

234

"A String",

235

],

236

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

"A String",

],

},

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

241

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

242

# included and excluded numeric IDs.

243

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

244

"A String",

245

],

246

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

251

# included and excluded numeric IDs.

252

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

253

"A String",

254

],

255

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

261

# included and excluded numeric IDs.

262

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

263

"A String",

264

],

265

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

271

# included and excluded numeric IDs.

272

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

273

"A String",

274

],

275

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

280

# mobile applications.

281

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

282

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

283

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

284

# excluded.

285

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

286

# apply.

287

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

288

"A String",

289

],

290

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

"A String",

],

},

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

295

# This doesn't apply to Auction Packages.

296

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

297

# display the ads in.

298

# publishers own.

299

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

300

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

301

# Google Play Store URL.

302

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

303

# First party mobile applications is either included or excluded.

304

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

305

"A String",

306

],

307

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

314

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

315

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

316

# and Preferred Deals in Ad Manager.

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

},

325

],

326

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

327

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

328

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

329

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

330

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

331

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

332

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

},

],

},

},

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

338

#

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

{ # Frequency cap.

347

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

348

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

349

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

350

# which impressions per user are counted and capped.

351

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

352

# specified time period.

353

},

354

],

355

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

356

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

357

},

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

# and expected impressions from the publisher.

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

# for a matching rule where no buyer is set.

379

"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

380

# (if the

381

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

382

# Authorized Buyers account ID.

383

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

384

},

385

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

386

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

387

"A String",

388

],

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

},

},

},

],

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

406

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

407

},

408

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

409

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

410

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

411

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

412

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

413

# Can be set by buyer or seller.

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

# for a matching rule where no buyer is set.

423

"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

424

# (if the

425

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

426

# Authorized Buyers account ID.

427

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

428

},

429

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

430

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

431

"A String",

432

],

433

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

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

451

# Can be set by buyer or seller.

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

},

464

},

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

# for a matching rule where no buyer is set.

474

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

475

# (if the

476

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

477

# Authorized Buyers account ID.

478

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

479

},

480

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

481

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

482

"A String",

483

],

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

"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

501

# in this private auction.

502

},

503

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

504

},

505

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

506

# PUBLISHER means creative is provided by seller and ADVERTISER means

507

# creative is provided by buyer.

508

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

509

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

510

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

511

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

512

},

513

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

514

#

515

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

516

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

517

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

518

# targeting entity is AND'd together.

519

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

520

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

521

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

522

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

523

# together.

524

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

525

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

526

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

527

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

528

# Filled in when key = GOOG_CREATIVE_SIZE

529

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

530

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

531

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

532

# height depend on the type of the targeting.

533

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

534

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

535

},

536

],

537

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

538

# only if creative_size_type = CreativeSizeType.NATIVE.

539

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

540

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

541

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

542

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

543

"A String",

544

],

545

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

546

# creative_size_type = CreativeSizeType.VIDEO.

547

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

548

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

549

# of the creative

550

# height depend on the type of the targeting.

551

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

552

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

553

},

554

},

555

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

556

# Filled in when the key is GOOG_DAYPART_TARGETING.

557

# The definition of this targeting is derived from the structure

558

# used by Ad Manager.

559

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

560

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

561

# only during certain parts of a day/week.

562

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

563

"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

564

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

565

# for filtering in PQL queries.

566

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

567

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

568

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

569

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

570

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

571

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

572

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

573

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

574

},

575

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

576

# The start time is inclusive.

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

"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

594

# together.

595

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

596

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

597

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

598

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

599

# Filled in when key = GOOG_CREATIVE_SIZE

600

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

601

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

602

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

603

# height depend on the type of the targeting.

604

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

605

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

606

},

607

],

608

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

609

# only if creative_size_type = CreativeSizeType.NATIVE.

610

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

611

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

612

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

613

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

614

"A String",

615

],

616

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

617

# creative_size_type = CreativeSizeType.VIDEO.

618

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

619

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

620

# of the creative

621

# height depend on the type of the targeting.

622

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

623

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

624

},

625

},

626

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

627

# Filled in when the key is GOOG_DAYPART_TARGETING.

628

# The definition of this targeting is derived from the structure

629

# used by Ad Manager.

630

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

631

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

632

# only during certain parts of a day/week.

633

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

634

"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

635

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

636

# for filtering in PQL queries.

637

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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

},

646

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

647

# The start time is inclusive.

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

665

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

666

# Third parties may define their own keys.

667

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

668

# provided as part of the external documentation.

669

},

670

],

671

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

672

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

673

# The deal is considered paused if either hasBuyerPaused or

674

# hasSellPaused is true.

675

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

676

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

677

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

678

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

679

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

680

},

681

},

682

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

687

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

688

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

689

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

690

#

691

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

692

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

693

# Authorized Buyers account ID.

694

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

695

},

696

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

697

# proposal.

698

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

699

{ # A proposal may be associated to several notes.

700

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

701

# (max-length: 1024 unicode code units)

702

#

703

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

704

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

705

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

706

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

707

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

708

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

709

},

710

],

711

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

712

# left a comment.

713

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

714

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

715

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

716

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

},

],

},

],

}</pre>

</div>

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

726

<pre>Retrieves the next page of results.

727

728

Args:

729

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

730

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

731

732

Returns:

733

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

734

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>