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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

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

83

84

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

85

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

86

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

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

94

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

95

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Dan O'Meara

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

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

117

118

Args:

119

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

120

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

Dan O'Meara

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

[diff] [blame]

121

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

122

The object takes the form of:

123

124

{ # Request to accept a proposal.

Bu Sun Kim

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

}

127

128

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

135

136

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

137

# account manager for access to Marketplace resources.

138

#

139

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

140

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

141

# are served.

142

#

143

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

144

# Auction or Preferred Deals deals through the API.

145

#

146

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

147

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

148

{ # A proposal may be associated to several notes.

149

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

150

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

151

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

152

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

153

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

154

# (max-length: 1024 unicode code units)

155

#

156

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

157

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

158

},

159

],

160

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

161

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

162

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

163

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

164

},

165

],

Bu Sun Kim

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

[diff] [blame]

166

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

Bu Sun Kim

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

[diff] [blame]

167

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

168

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

169

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

170

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

171

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

172

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

Bu Sun Kim

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

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

175

# if the user is in the US.

176

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

177

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

178

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

179

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

180

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

181

"A String",

182

],

183

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

184

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

185

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

186

"A String",

187

],

188

},

Bu Sun Kim

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

[diff] [blame]

189

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

190

# mobile applications.

191

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

192

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

193

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

194

# excluded.

195

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

196

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

197

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

Bu Sun Kim

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

[diff] [blame]

198

"A String",

199

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

200

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

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

205

# This doesn't apply to Auction Packages.

206

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

Dan O'Meara

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

[diff] [blame]

207

# display the ads in.

208

# publishers own.

209

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

210

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

211

# Google Play Store URL.

212

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

213

# First party mobile applications is either included or excluded.

Bu Sun Kim

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

[diff] [blame]

214

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

Bu Sun Kim

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

[diff] [blame]

215

"A String",

Dan O'Meara

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

[diff] [blame]

216

],

Bu Sun Kim

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

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

"A String",

Dan O'Meara

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

[diff] [blame]

],

},

},

},

Bu Sun Kim

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

[diff] [blame]

223

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

224

# included and excluded numeric IDs.

225

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

226

"A String",

227

],

228

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

229

"A String",

230

],

231

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

232

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

233

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

234

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

235

# and Preferred Deals in Ad Manager.

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

},

244

],

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

},

253

],

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

Bu Sun Kim

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

[diff] [blame]

256

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

257

# included and excluded numeric IDs.

258

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

259

"A String",

260

],

261

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

"A String",

],

},

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

266

# included and excluded numeric IDs.

267

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

268

"A String",

269

],

270

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

271

"A String",

272

],

273

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

274

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

275

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

276

# included and excluded numeric IDs.

277

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

278

"A String",

279

],

280

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

"A String",

],

},

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

285

# included and excluded numeric IDs.

286

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

287

"A String",

288

],

289

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

"A String",

],

},

},

Bu Sun Kim

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

[diff] [blame]

294

},

Bu Sun Kim

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

[diff] [blame]

295

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

296

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

297

# deal.

298

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

299

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

300

# in Ad Manager.

301

# Preferred Deal in Ad Manager.

302

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

303

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

304

"creativeSpecifications": [

305

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

306

# Guaranteed/Preferred Deal in Ad Manager.

307

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

308

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

309

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

310

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

311

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

312

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

313

},

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

},

322

],

Bu Sun Kim

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

[diff] [blame]

323

},

324

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

325

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

Bu Sun Kim

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

[diff] [blame]

326

},

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

330

# returned.

331

#

332

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

333

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

Bu Sun Kim

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

[diff] [blame]

334

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

335

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

336

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

337

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

338

},

339

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

340

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

341

# The deal is considered paused if either hasBuyerPaused or

342

# hasSellPaused is true.

343

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

344

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

345

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

346

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

347

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

348

},

349

},

350

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

351

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

352

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

353

# PUBLISHER means creative is provided by seller and ADVERTISER means

354

# creative is provided by buyer.

355

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

356

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

357

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

358

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

359

# time in seconds.

360

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

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

364

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

Bu Sun Kim

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

[diff] [blame]

365

},

Bu Sun Kim

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

[diff] [blame]

366

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

367

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

368

#

369

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

370

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

371

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

Bu Sun Kim

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

[diff] [blame]

372

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

373

#

374

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

375

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

376

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

377

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

378

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

379

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

380

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

381

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

382

{ # Frequency cap.

383

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

384

# which impressions per user are counted and capped.

385

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

386

# specified time period.

387

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

388

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

389

},

390

],

391

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

392

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

393

},

394

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

395

# targeting entity is AND'd together.

396

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

397

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

398

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

399

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

400

# together.

401

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

402

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

403

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

404

# Filled in when the key is GOOG_DAYPART_TARGETING.

405

# The definition of this targeting is derived from the structure

406

# used by Ad Manager.

407

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

408

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

409

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

410

# only during certain parts of a day/week.

411

"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

412

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

413

# for filtering in PQL queries.

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

},

423

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

424

# The start time is inclusive.

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

},

435

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

},

],

},

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

440

# Filled in when key = GOOG_CREATIVE_SIZE

441

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

442

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

443

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

444

# height depend on the type of the targeting.

445

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

446

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

447

},

448

],

449

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

450

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

451

# creative_size_type = CreativeSizeType.VIDEO.

452

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

453

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

454

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

455

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

456

"A String",

457

],

458

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

459

# of the creative

460

# height depend on the type of the targeting.

461

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

462

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

463

},

464

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

465

# only if creative_size_type = CreativeSizeType.NATIVE.

466

},

467

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

468

},

469

],

470

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

471

# together.

472

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

473

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

474

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

475

# Filled in when the key is GOOG_DAYPART_TARGETING.

476

# The definition of this targeting is derived from the structure

477

# used by Ad Manager.

478

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

479

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

480

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

481

# only during certain parts of a day/week.

482

"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

483

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

484

# for filtering in PQL queries.

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

},

494

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

495

# The start time is inclusive.

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

},

506

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

},

],

},

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

511

# Filled in when key = GOOG_CREATIVE_SIZE

512

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

513

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

514

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

515

# height depend on the type of the targeting.

516

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

517

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

518

},

519

],

520

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

521

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

522

# creative_size_type = CreativeSizeType.VIDEO.

523

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

524

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

525

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

526

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

527

"A String",

528

],

529

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

530

# of the creative

531

# height depend on the type of the targeting.

532

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

533

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

534

},

535

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

536

# only if creative_size_type = CreativeSizeType.NATIVE.

537

},

538

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

539

},

540

],

541

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

542

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

543

# Third parties may define their own keys.

544

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

545

# provided as part of the external documentation.

546

},

547

],

548

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

549

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

550

# and expected impressions from the publisher.

551

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

552

# Can be set by buyer or seller.

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

# for a matching rule where no buyer is set.

563

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

564

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

565

"A String",

566

],

567

"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

568

# (if the

569

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

570

# Authorized Buyers account ID.

571

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

572

},

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

591

# Can be set by buyer or seller.

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

},

604

},

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

# for a matching rule where no buyer is set.

617

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

618

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

619

"A String",

620

],

621

"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

622

# (if the

623

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

624

# Authorized Buyers account ID.

625

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

626

},

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

},

},

},

],

},

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

# for a matching rule where no buyer is set.

653

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

654

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

655

"A String",

656

],

657

"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

658

# (if the

659

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

660

# Authorized Buyers account ID.

661

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

662

},

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

"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

680

# in this private auction.

681

},

682

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

683

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

684

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

685

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

686

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

687

},

688

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

689

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

690

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

691

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

Bu Sun Kim

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

[diff] [blame]

692

},

693

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

694

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

695

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

696

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

697

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

698

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

699

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

700

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

701

# was made.

702

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

703

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

704

# proposal.

Bu Sun Kim

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

[diff] [blame]

705

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

Dan O'Meara

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

[diff] [blame]

706

#

707

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

708

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

709

# Ad Manager account ID.

Bu Sun Kim

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

[diff] [blame]

710

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

711

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

Dan O'Meara

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

[diff] [blame]

712

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

713

},

Bu Sun Kim

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

[diff] [blame]

714

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

715

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

716

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

717

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

718

},

719

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

720

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

721

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

722

# left a comment.

723

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

724

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

725

# Authorized Buyers account ID.

726

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

727

},

728

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

729

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

730

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

731

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

732

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

733

},

Bu Sun Kim

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

[diff] [blame]

734

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

735

# proposal.

Bu Sun Kim

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

[diff] [blame]

736

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

737

#

738

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

739

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

740

# Authorized Buyers account ID.

741

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

742

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

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

749

a unique ID by the server.

750

The proposal revision number will not increase when associated with a

new note.

Args:

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

755

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

Dan O'Meara

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

[diff] [blame]

756

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

757

The object takes the form of:

758

759

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

Bu Sun Kim

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

[diff] [blame]

760

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

Bu Sun Kim

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

[diff] [blame]

761

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

762

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

763

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

764

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

Bu Sun Kim

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

[diff] [blame]

765

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

Bu Sun Kim

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

[diff] [blame]

766

# (max-length: 1024 unicode code units)

767

#

768

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

769

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

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

780

781

{ # A proposal may be associated to several notes.

Bu Sun Kim

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

[diff] [blame]

782

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

783

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

784

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

785

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

Bu Sun Kim

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

[diff] [blame]

786

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

Bu Sun Kim

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

[diff] [blame]

787

# (max-length: 1024 unicode code units)

788

#

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

796

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

797

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

798

a negotiation unilaterally.

799

800

Args:

801

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

802

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

803

body: object, The request body.

804

The object takes the form of:

805

806

{ # Request to cancel an ongoing negotiation.

807

}

808

809

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

816

817

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

818

# account manager for access to Marketplace resources.

819

#

820

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

821

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

822

# are served.

823

#

824

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

825

# Auction or Preferred Deals deals through the API.

826

#

827

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

828

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

829

{ # A proposal may be associated to several notes.

830

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

831

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

832

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

833

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

834

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

835

# (max-length: 1024 unicode code units)

836

#

837

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

838

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

839

},

840

],

841

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

842

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

843

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

844

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

845

},

846

],

Bu Sun Kim

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

[diff] [blame]

847

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

Bu Sun Kim

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

[diff] [blame]

848

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

849

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

850

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

851

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

852

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

853

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

Bu Sun Kim

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

[diff] [blame]

854

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

Bu Sun Kim

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

[diff] [blame]

855

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

856

# if the user is in the US.

857

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

858

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

859

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

860

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

861

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

862

"A String",

863

],

864

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

865

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

866

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

867

"A String",

868

],

869

},

Bu Sun Kim

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

[diff] [blame]

870

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

871

# mobile applications.

872

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

873

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

874

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

875

# excluded.

876

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

877

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

878

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

Bu Sun Kim

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

[diff] [blame]

879

"A String",

880

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

881

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

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

886

# This doesn't apply to Auction Packages.

887

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

Dan O'Meara

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

[diff] [blame]

888

# display the ads in.

889

# publishers own.

890

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

891

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

892

# Google Play Store URL.

893

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

894

# First party mobile applications is either included or excluded.

Bu Sun Kim

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

[diff] [blame]

895

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

Bu Sun Kim

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

[diff] [blame]

896

"A String",

Dan O'Meara

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

[diff] [blame]

897

],

Bu Sun Kim

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

[diff] [blame]

898

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

Bu Sun Kim

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

[diff] [blame]

899

"A String",

Dan O'Meara

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

[diff] [blame]

],

},

},

},

Bu Sun Kim

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

[diff] [blame]

904

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

905

# included and excluded numeric IDs.

906

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

907

"A String",

908

],

909

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

910

"A String",

911

],

912

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

913

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

914

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

915

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

916

# and Preferred Deals in Ad Manager.

917

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

918

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

919

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

920

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

921

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

922

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

923

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

924

},

925

],

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

},

934

],

935

},

Bu Sun Kim

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

[diff] [blame]

936

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

Bu Sun Kim

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

[diff] [blame]

937

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

938

# included and excluded numeric IDs.

939

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

940

"A String",

941

],

942

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

"A String",

],

},

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

947

# included and excluded numeric IDs.

948

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

949

"A String",

950

],

951

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

952

"A String",

953

],

954

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

955

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

956

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

957

# included and excluded numeric IDs.

958

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

959

"A String",

960

],

961

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

"A String",

],

},

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

966

# included and excluded numeric IDs.

967

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

968

"A String",

969

],

970

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

"A String",

],

},

},

Bu Sun Kim

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

[diff] [blame]

975

},

Bu Sun Kim

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

[diff] [blame]

976

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

977

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

978

# deal.

979

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

980

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

981

# in Ad Manager.

982

# Preferred Deal in Ad Manager.

983

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

984

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

985

"creativeSpecifications": [

986

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

987

# Guaranteed/Preferred Deal in Ad Manager.

988

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

989

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

990

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

991

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

992

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

993

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

994

},

995

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

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

},

1003

],

Bu Sun Kim

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

[diff] [blame]

1004

},

1005

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

},

Bu Sun Kim

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

[diff] [blame]

1008

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

1009

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

1010

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

1011

# returned.

1012

#

1013

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

1014

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

Bu Sun Kim

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

[diff] [blame]

1015

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1016

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

1017

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

1018

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

1019

},

1020

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

1021

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

1022

# The deal is considered paused if either hasBuyerPaused or

1023

# hasSellPaused is true.

1024

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

1025

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

1026

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

1027

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

1028

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

1029

},

1030

},

1031

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

1032

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

1033

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

1034

# PUBLISHER means creative is provided by seller and ADVERTISER means

1035

# creative is provided by buyer.

1036

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

1037

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

1038

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

1039

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

1040

# time in seconds.

1041

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

Bu Sun Kim

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

[diff] [blame]

1042

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

1043

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

1044

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

1045

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

Bu Sun Kim

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

[diff] [blame]

1046

},

Bu Sun Kim

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

[diff] [blame]

1047

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1048

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

1049

#

1050

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

1051

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

1052

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

Bu Sun Kim

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

[diff] [blame]

1053

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

1054

#

1055

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

1056

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

{ # Frequency cap.

1064

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

1065

# which impressions per user are counted and capped.

1066

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

1067

# specified time period.

1068

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

1069

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

1070

},

1071

],

1072

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

1073

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

1074

},

1075

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

1076

# targeting entity is AND'd together.

1077

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

1078

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

1079

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

1080

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

1081

# together.

1082

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

1083

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

1084

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

1085

# Filled in when the key is GOOG_DAYPART_TARGETING.

1086

# The definition of this targeting is derived from the structure

1087

# used by Ad Manager.

1088

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

1089

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

1090

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

1091

# only during certain parts of a day/week.

1092

"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

1093

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

1094

# for filtering in PQL queries.

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

},

1104

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

1105

# The start time is inclusive.

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

},

1116

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

},

],

},

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

1121

# Filled in when key = GOOG_CREATIVE_SIZE

1122

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

1123

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

1124

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

1125

# height depend on the type of the targeting.

1126

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

1127

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

1128

},

1129

],

1130

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

1131

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

1132

# creative_size_type = CreativeSizeType.VIDEO.

1133

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

1134

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

1135

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

1136

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

1137

"A String",

1138

],

1139

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

1140

# of the creative

1141

# height depend on the type of the targeting.

1142

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

1143

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

1144

},

1145

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

1146

# only if creative_size_type = CreativeSizeType.NATIVE.

1147

},

1148

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

1149

},

1150

],

1151

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

1152

# together.

1153

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

1154

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

1155

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

1156

# Filled in when the key is GOOG_DAYPART_TARGETING.

1157

# The definition of this targeting is derived from the structure

1158

# used by Ad Manager.

1159

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

1160

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

1161

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

1162

# only during certain parts of a day/week.

1163

"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

1164

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

1165

# for filtering in PQL queries.

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

},

1175

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

1176

# The start time is inclusive.

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

},

1187

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

},

],

},

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

1192

# Filled in when key = GOOG_CREATIVE_SIZE

1193

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

1194

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

1195

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

1196

# height depend on the type of the targeting.

1197

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

1198

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

1199

},

1200

],

1201

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

1202

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

1203

# creative_size_type = CreativeSizeType.VIDEO.

1204

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

1205

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

1206

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

1207

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

1208

"A String",

1209

],

1210

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

1211

# of the creative

1212

# height depend on the type of the targeting.

1213

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

1214

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

1215

},

1216

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

1217

# only if creative_size_type = CreativeSizeType.NATIVE.

1218

},

1219

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

1220

},

1221

],

1222

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

1223

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

1224

# Third parties may define their own keys.

1225

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

1226

# provided as part of the external documentation.

1227

},

1228

],

1229

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

1230

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

1231

# and expected impressions from the publisher.

1232

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

1233

# Can be set by buyer or seller.

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

# for a matching rule where no buyer is set.

1244

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

1245

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

1246

"A String",

1247

],

1248

"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

1249

# (if the

1250

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

1251

# Authorized Buyers account ID.

1252

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

1253

},

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1272

# Can be set by buyer or seller.

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

# If `units` is zero, `nanos` can be positive, zero, or negative.

1281

# If `units` is negative, `nanos` must be negative or zero.

1282

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1283

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1284

},

1285

},

1286

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

1287

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

1288

# of guaranteed looks that the buyer is guaranteeing to buy.

1289

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

1290

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

1291

"fixedPrices": [ # Fixed price for the specified buyer.

1292

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1293

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1294

# a particular buyer or buyer/advertiser pair, we look for the most specific

1295

# matching rule - we first look for a rule matching the buyer and advertiser,

1296

# next a rule with the buyer but an empty advertiser list, and otherwise look

1297

# for a matching rule where no buyer is set.

1298

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1299

# If empty, all advertisers with this buyer pay this price.

1300

"A String",

1301

],

1302

"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

1303

# (if the

1304

# advertisers match, and there's no more specific rule matching the buyer).

1305

# Authorized Buyers account ID.

1306

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1307

},

1308

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1309

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1310

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1311

"units": "A String", # The whole units of the amount.

1312

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1313

"nanos": 42, # Number of nano (10^-9) units of the amount.

1314

# The value must be between -999,999,999 and +999,999,999 inclusive.

1315

# If `units` is positive, `nanos` must be positive or zero.

1316

# If `units` is zero, `nanos` can be positive, zero, or negative.

1317

# If `units` is negative, `nanos` must be negative or zero.

1318

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1319

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

1326

# by the seller, but they can be returned in a get or list request.

1327

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

1328

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1329

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1330

# a particular buyer or buyer/advertiser pair, we look for the most specific

1331

# matching rule - we first look for a rule matching the buyer and advertiser,

1332

# next a rule with the buyer but an empty advertiser list, and otherwise look

1333

# for a matching rule where no buyer is set.

1334

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1335

# If empty, all advertisers with this buyer pay this price.

1336

"A String",

1337

],

1338

"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

1339

# (if the

1340

# advertisers match, and there's no more specific rule matching the buyer).

1341

# Authorized Buyers account ID.

1342

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1343

},

1344

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1345

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1346

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1347

"units": "A String", # The whole units of the amount.

1348

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1349

"nanos": 42, # Number of nano (10^-9) units of the amount.

1350

# The value must be between -999,999,999 and +999,999,999 inclusive.

1351

# If `units` is positive, `nanos` must be positive or zero.

1352

# If `units` is zero, `nanos` can be positive, zero, or negative.

1353

# If `units` is negative, `nanos` must be negative or zero.

1354

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1355

"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

1361

# in this private auction.

1362

},

1363

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

1364

# time zone used to mark the boundaries of a day. It should be an

1365

# IANA TZ name, such as "America/Los_Angeles". For more information,

1366

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

1367

"description": "A String", # Publisher provided description for the terms.

1368

},

1369

"availableEndTime": "A String", # Proposed flight end time of the deal.

1370

# This will generally be stored in a granularity of a second.

1371

# A value is not required for Private Auction deals or Preferred Deals.

1372

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1373

},

1374

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1375

"proposalState": "A String", # Output only. The current state of the proposal.

1376

"proposalRevision": "A String", # Output only. The revision number for the proposal.

1377

# Each update to the proposal or the deal causes the proposal revision number

1378

# to auto-increment. The buyer keeps track of the last revision number they

1379

# know of and pass it in when making an update. If the head revision number

1380

# on the server has since incremented, then an ABORTED error is returned

1381

# during the update operation to let the buyer know that a subsequent update

1382

# was made.

1383

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

1384

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1385

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1386

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1387

#

1388

# Note: This field may be set only when creating the resource. Modifying

1389

# this field while updating the resource will result in an error.

1390

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1391

"subAccountId": "A String", # Optional sub-account ID for the seller.

1392

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1393

# The seller account ID is then available to buyer in the product.

1394

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1395

"buyerContacts": [ # Contact information for the buyer.

1396

{ # Contains information on how a buyer or seller can be reached.

1397

"name": "A String", # The name of the contact.

1398

"email": "A String", # Email address for the contact.

1399

},

1400

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1401

"displayName": "A String", # The name for the proposal.

1402

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

1403

# left a comment.

1404

"proposalId": "A String", # Output only. The unique ID of the proposal.

1405

"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.

1406

# Authorized Buyers account ID.

1407

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1408

},

1409

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

1410

"updateTime": "A String", # Output only. The time when the proposal was last revised.

1411

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

1412

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1413

# operations (max-length: 1024 unicode code units).

1414

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1415

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

1416

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1417

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

1418

#

1419

# Note: This field may be set only when creating the resource. Modifying

1420

# this field while updating the resource will result in an error.

1421

# Authorized Buyers account ID.

1422

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1423

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</code>

1429

<pre>Update the given proposal to indicate that setup has been completed.

1430

This method is called by the buyer when the line items have been created

1431

on their end for a finalized proposal and all the required creatives

1432

have been uploaded using the creatives API. This call updates the

1433

`is_setup_completed` bit on the proposal and also notifies the seller.

1434

The server will advance the revision number of the most recent proposal.

1435

1436

Args:

1437

accountId: string, Account ID of the buyer. (required)

1438

proposalId: string, The ID of the proposal to mark as setup completed. (required)

1439

body: object, The request body.

1440

The object takes the form of:

1441

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

{ # Request message for indicating that the proposal's setup step is complete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1443

}

1444

1445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1452

1453

{ # Note: this resource requires whitelisting for access. Please contact your

1454

# account manager for access to Marketplace resources.

1455

#

1456

# Represents a proposal in the Marketplace. A proposal is the unit of

1457

# negotiation between a seller and a buyer and contains deals which

1458

# are served.

1459

#

1460

# Note: you can not update, create, or otherwise modify Private

1461

# Auction or Preferred Deals deals through the API.

1462

#

1463

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1464

"notes": [ # Output only. The notes associated with this proposal.

1465

{ # A proposal may be associated to several notes.

1466

"createTime": "A String", # Output only. The timestamp for when this note was created.

1467

"noteId": "A String", # Output only. The unique ID for the note.

1468

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

1469

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

1470

"note": "A String", # The actual note to attach.

1471

# (max-length: 1024 unicode code units)

1472

#

1473

# Note: This field may be set only when creating the resource. Modifying

1474

# this field while updating the resource will result in an error.

1475

},

1476

],

1477

"sellerContacts": [ # Output only. Contact information for the seller.

1478

{ # Contains information on how a buyer or seller can be reached.

1479

"name": "A String", # The name of the contact.

1480

"email": "A String", # Email address for the contact.

1481

},

1482

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1483

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1484

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

1485

{ # A deal represents a segment of inventory for displaying ads on.

1486

# A proposal can contain multiple deals. A deal contains the terms and

1487

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1488

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

1489

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1490

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1491

# target ad inventory. For example, they can choose to target ad requests only

1492

# if the user is in the US.

1493

# Multiple types of targeting are always applied as a logical AND, unless noted

1494

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1495

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

1496

"excludedPositionTypes": [ # A list of video positions to be excluded.

1497

# Position types can either be included or excluded (XOR).

1498

"A String",

1499

],

1500

"targetedPositionTypes": [ # A list of video positions to be included.

1501

# When the included list is present, the excluded list must be empty.

1502

# When the excluded list is present, the included list must be empty.

1503

"A String",

1504

],

1505

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1506

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

1507

# mobile applications.

1508

# Different placement targeting types will be logically OR'ed.

1509

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

1510

# For Private Auction and AdX Preferred Deals, URLs are either included or

1511

# excluded.

1512

# For Programmatic Guaranteed and Preferred Deals, this doesn't

1513

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1514

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1515

"A String",

1516

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1517

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

1522

# This doesn't apply to Auction Packages.

1523

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1524

# display the ads in.

1525

# publishers own.

1526

# Mobile application IDs are from App Store and Google Play Store.

1527

# Android App ID, for example, com.google.android.apps.maps, can be found in

1528

# Google Play Store URL.

1529

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

1530

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1531

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1532

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1533

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1534

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1535

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1540

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

1541

# included and excluded numeric IDs.

1542

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1543

"A String",

1544

],

1545

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1546

"A String",

1547

],

1548

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1549

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

1550

# request. It only applies to Private Auction, AdX Preferred Deals and

1551

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

1552

# and Preferred Deals in Ad Manager.

1553

"targetedInventorySizes": [ # A list of inventory sizes to be included.

1554

{ # Represents size of a single ad slot, or a creative.

1555

"width": "A String", # The width of the ad slot in pixels.

1556

# This field will be present only when size type is `PIXEL`.

1557

"sizeType": "A String", # The size type of the ad slot.

1558

"height": "A String", # The height of the ad slot in pixels.

1559

# This field will be present only when size type is `PIXEL`.

1560

},

1561

],

1562

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

1563

{ # Represents size of a single ad slot, or a creative.

1564

"width": "A String", # The width of the ad slot in pixels.

1565

# This field will be present only when size type is `PIXEL`.

1566

"sizeType": "A String", # The size type of the ad slot.

1567

"height": "A String", # The height of the ad slot in pixels.

1568

# This field will be present only when size type is `PIXEL`.

1569

},

1570

],

1571

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1572

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1573

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

1574

# included and excluded numeric IDs.

1575

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1576

"A String",

1577

],

1578

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

1583

# included and excluded numeric IDs.

1584

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1585

"A String",

1586

],

1587

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

1588

"A String",

1589

],

1590

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1591

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

1592

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

1593

# included and excluded numeric IDs.

1594

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1595

"A String",

1596

],

1597

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

1602

# included and excluded numeric IDs.

1603

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1604

"A String",

1605

],

1606

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1611

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1612

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1613

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1614

# deal.

1615

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

1616

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

1617

# in Ad Manager.

1618

# Preferred Deal in Ad Manager.

1619

# This doesn't apply to Private Auction and AdX Preferred Deals.

1620

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

1621

"creativeSpecifications": [

1622

{ # Represents information for a creative that is associated with a Programmatic

1623

# Guaranteed/Preferred Deal in Ad Manager.

1624

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

1625

"width": "A String", # The width of the ad slot in pixels.

1626

# This field will be present only when size type is `PIXEL`.

1627

"sizeType": "A String", # The size type of the ad slot.

1628

"height": "A String", # The height of the ad slot in pixels.

1629

# This field will be present only when size type is `PIXEL`.

1630

},

1631

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

1632

{ # Represents size of a single ad slot, or a creative.

1633

"width": "A String", # The width of the ad slot in pixels.

1634

# This field will be present only when size type is `PIXEL`.

1635

"sizeType": "A String", # The size type of the ad slot.

1636

"height": "A String", # The height of the ad slot in pixels.

1637

# This field will be present only when size type is `PIXEL`.

1638

},

1639

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1640

},

1641

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1642

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1643

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1644

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

1645

# If present on create, and the server `product_revision` has advanced sinced

1646

# the passed-in `create_product_revision`, an `ABORTED` error will be

1647

# returned.

1648

#

1649

# Note: This field may be set only when creating the resource. Modifying

1650

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1651

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1652

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

1653

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1654

# operations (max-length: 1024 unicode code units).

1655

},

1656

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

1657

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

1658

# The deal is considered paused if either hasBuyerPaused or

1659

# hasSellPaused is true.

1660

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

1661

"firstPausedBy": "A String", # The role of the person who first paused this deal.

1662

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

1663

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

1664

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

1665

},

1666

},

1667

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

1668

# finalized. This is the deal ID that shows up in serving/reporting etc.

1669

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

1670

# PUBLISHER means creative is provided by seller and ADVERTISER means

1671

# creative is provided by buyer.

1672

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

1673

# This will generally be stored in the granularity of one second since deal

1674

# serving starts at seconds boundary. Any time specified with more

1675

# granularity (e.g., in milliseconds) will be truncated towards the start of

1676

# time in seconds.

1677

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1678

"sellerContacts": [ # Output only. Seller contact information for the deal.

1679

{ # Contains information on how a buyer or seller can be reached.

1680

"name": "A String", # The name of the contact.

1681

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1682

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1683

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1684

"createProductId": "A String", # The product ID from which this deal was created.

1685

#

1686

# Note: This field may be set only when creating the resource. Modifying

1687

# this field while updating the resource will result in an error.

1688

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1689

"syndicationProduct": "A String", # The syndication product associated with the deal.

1690

#

1691

# Note: This field may be set only when creating the resource. Modifying

1692

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1693

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1694

"createTime": "A String", # Output only. The time of the deal creation.

1695

"description": "A String", # Description for the deal terms.

1696

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

1697

# to see but are non-negotiable. These are set by the publisher.

1698

"frequencyCaps": [ # Output only. Specifies any frequency caps.

1699

{ # Frequency cap.

1700

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1701

# which impressions per user are counted and capped.

1702

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

1703

# specified time period.

1704

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

1705

# amount of time over which impressions per user are counted and capped.

1706

},

1707

],

1708

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

1709

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

1710

},

1711

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

1712

# targeting entity is AND'd together.

1713

{ # Advertisers can target different attributes of an ad slot. For example,

1714

# they can choose to show ads only if the user is in the U.S. Such

1715

# targeting criteria can be specified as part of Shared Targeting.

1716

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

1717

# together.

1718

{ # A polymorphic targeting value used as part of Shared Targeting.

1719

"longValue": "A String", # The long value to include/exclude.

1720

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1721

# Filled in when the key is GOOG_DAYPART_TARGETING.

1722

# The definition of this targeting is derived from the structure

1723

# used by Ad Manager.

1724

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1725

"dayParts": [ # A list of day part targeting criterion.

1726

{ # Daypart targeting message that specifies if the ad can be shown

1727

# only during certain parts of a day/week.

1728

"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

1729

# granularity). The end time is exclusive. This field is not available

1730

# for filtering in PQL queries.

1731

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1732

# types are google.type.Date and `google.protobuf.Timestamp`.

1733

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1734

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1735

# allow the value 60 if it allows leap-seconds.

1736

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1737

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1738

# to allow the value "24:00:00" for scenarios like business closing time.

1739

},

1740

"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).

1741

# The start time is inclusive.

1742

# This field is not available for filtering in PQL queries.

1743

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1744

# types are google.type.Date and `google.protobuf.Timestamp`.

1745

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1746

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1747

# allow the value 60 if it allows leap-seconds.

1748

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1749

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1750

# to allow the value "24:00:00" for scenarios like business closing time.

1751

},

1752

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1757

# Filled in when key = GOOG_CREATIVE_SIZE

1758

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1759

# Companion sizes may be filled in only when creative_size_type = VIDEO

1760

{ # Message depicting the size of the creative. The units of width and

1761

# height depend on the type of the targeting.

1762

"height": 42, # The height of the creative.

1763

"width": 42, # The width of the creative

1764

},

1765

],

1766

"creativeSizeType": "A String", # The creative size type.

1767

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1768

# creative_size_type = CreativeSizeType.VIDEO.

1769

"allowedFormats": [ # What formats are allowed by the publisher.

1770

# If this repeated field is empty then all formats are allowed.

1771

# For example, if this field contains AllowedFormatType.AUDIO then the

1772

# publisher only allows an audio ad (without any video).

1773

"A String",

1774

],

1775

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1776

# of the creative

1777

# height depend on the type of the targeting.

1778

"height": 42, # The height of the creative.

1779

"width": 42, # The width of the creative

1780

},

1781

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1782

# only if creative_size_type = CreativeSizeType.NATIVE.

1783

},

1784

"stringValue": "A String", # The string value to include/exclude.

1785

},

1786

],

1787

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

1788

# together.

1789

{ # A polymorphic targeting value used as part of Shared Targeting.

1790

"longValue": "A String", # The long value to include/exclude.

1791

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1792

# Filled in when the key is GOOG_DAYPART_TARGETING.

1793

# The definition of this targeting is derived from the structure

1794

# used by Ad Manager.

1795

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1796

"dayParts": [ # A list of day part targeting criterion.

1797

{ # Daypart targeting message that specifies if the ad can be shown

1798

# only during certain parts of a day/week.

1799

"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

1800

# granularity). The end time is exclusive. This field is not available

1801

# for filtering in PQL queries.

1802

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1803

# types are google.type.Date and `google.protobuf.Timestamp`.

1804

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1805

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1806

# allow the value 60 if it allows leap-seconds.

1807

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1808

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1809

# to allow the value "24:00:00" for scenarios like business closing time.

1810

},

1811

"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).

1812

# The start time is inclusive.

1813

# This field is not available for filtering in PQL queries.

1814

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1815

# types are google.type.Date and `google.protobuf.Timestamp`.

1816

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1817

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1818

# allow the value 60 if it allows leap-seconds.

1819

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1820

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1821

# to allow the value "24:00:00" for scenarios like business closing time.

1822

},

1823

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1828

# Filled in when key = GOOG_CREATIVE_SIZE

1829

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1830

# Companion sizes may be filled in only when creative_size_type = VIDEO

1831

{ # Message depicting the size of the creative. The units of width and

1832

# height depend on the type of the targeting.

1833

"height": 42, # The height of the creative.

1834

"width": 42, # The width of the creative

1835

},

1836

],

1837

"creativeSizeType": "A String", # The creative size type.

1838

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1839

# creative_size_type = CreativeSizeType.VIDEO.

1840

"allowedFormats": [ # What formats are allowed by the publisher.

1841

# If this repeated field is empty then all formats are allowed.

1842

# For example, if this field contains AllowedFormatType.AUDIO then the

1843

# publisher only allows an audio ad (without any video).

1844

"A String",

1845

],

1846

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1847

# of the creative

1848

# height depend on the type of the targeting.

1849

"height": 42, # The height of the creative.

1850

"width": 42, # The width of the creative

1851

},

1852

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1853

# only if creative_size_type = CreativeSizeType.NATIVE.

1854

},

1855

"stringValue": "A String", # The string value to include/exclude.

1856

},

1857

],

1858

"key": "A String", # The key representing the shared targeting criterion.

1859

# Targeting criteria defined by Google ad servers will begin with GOOG_.

1860

# Third parties may define their own keys.

1861

# A list of permissible keys along with the acceptable values will be

1862

# provided as part of the external documentation.

1863

},

1864

],

1865

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

1866

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

1867

# and expected impressions from the publisher.

1868

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

1869

# Can be set by buyer or seller.

1870

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

1871

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

1872

# the API at this time, but can be returned in a get or list request.

1873

"fixedPrices": [ # Fixed price for the specified buyer.

1874

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1875

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1876

# a particular buyer or buyer/advertiser pair, we look for the most specific

1877

# matching rule - we first look for a rule matching the buyer and advertiser,

1878

# next a rule with the buyer but an empty advertiser list, and otherwise look

1879

# for a matching rule where no buyer is set.

1880

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1881

# If empty, all advertisers with this buyer pay this price.

1882

"A String",

1883

],

1884

"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

1885

# (if the

1886

# advertisers match, and there's no more specific rule matching the buyer).

1887

# Authorized Buyers account ID.

1888

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1889

},

1890

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1891

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1892

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1893

"units": "A String", # The whole units of the amount.

1894

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1895

"nanos": 42, # Number of nano (10^-9) units of the amount.

1896

# The value must be between -999,999,999 and +999,999,999 inclusive.

1897

# If `units` is positive, `nanos` must be positive or zero.

1898

# If `units` is zero, `nanos` can be positive, zero, or negative.

1899

# If `units` is negative, `nanos` must be negative or zero.

1900

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1901

"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.

1908

# Can be set by buyer or seller.

1909

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1910

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1911

"units": "A String", # The whole units of the amount.

1912

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1913

"nanos": 42, # Number of nano (10^-9) units of the amount.

1914

# The value must be between -999,999,999 and +999,999,999 inclusive.

1915

# If `units` is positive, `nanos` must be positive or zero.

1916

# If `units` is zero, `nanos` can be positive, zero, or negative.

1917

# If `units` is negative, `nanos` must be negative or zero.

1918

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1919

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1920

},

1921

},

1922

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

1923

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

1924

# of guaranteed looks that the buyer is guaranteeing to buy.

1925

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

1926

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

1927

"fixedPrices": [ # Fixed price for the specified buyer.

1928

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1929

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1930

# a particular buyer or buyer/advertiser pair, we look for the most specific

1931

# matching rule - we first look for a rule matching the buyer and advertiser,

1932

# next a rule with the buyer but an empty advertiser list, and otherwise look

1933

# for a matching rule where no buyer is set.

1934

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1935

# If empty, all advertisers with this buyer pay this price.

1936

"A String",

1937

],

1938

"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

1939

# (if the

1940

# advertisers match, and there's no more specific rule matching the buyer).

1941

# Authorized Buyers account ID.

1942

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1943

},

1944

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1945

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1946

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1947

"units": "A String", # The whole units of the amount.

1948

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1949

"nanos": 42, # Number of nano (10^-9) units of the amount.

1950

# The value must be between -999,999,999 and +999,999,999 inclusive.

1951

# If `units` is positive, `nanos` must be positive or zero.

1952

# If `units` is zero, `nanos` can be positive, zero, or negative.

1953

# If `units` is negative, `nanos` must be negative or zero.

1954

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1955

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

1962

# by the seller, but they can be returned in a get or list request.

1963

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

1964

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1965

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1966

# a particular buyer or buyer/advertiser pair, we look for the most specific

1967

# matching rule - we first look for a rule matching the buyer and advertiser,

1968

# next a rule with the buyer but an empty advertiser list, and otherwise look

1969

# for a matching rule where no buyer is set.

1970

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1971

# If empty, all advertisers with this buyer pay this price.

1972

"A String",

1973

],

1974

"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

1975

# (if the

1976

# advertisers match, and there's no more specific rule matching the buyer).

1977

# Authorized Buyers account ID.

1978

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1979

},

1980

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1981

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1982

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1983

"units": "A String", # The whole units of the amount.

1984

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1985

"nanos": 42, # Number of nano (10^-9) units of the amount.

1986

# The value must be between -999,999,999 and +999,999,999 inclusive.

1987

# If `units` is positive, `nanos` must be positive or zero.

1988

# If `units` is zero, `nanos` can be positive, zero, or negative.

1989

# If `units` is negative, `nanos` must be negative or zero.

1990

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1991

"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

1997

# in this private auction.

1998

},

1999

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2000

# time zone used to mark the boundaries of a day. It should be an

2001

# IANA TZ name, such as "America/Los_Angeles". For more information,

2002

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

2003

"description": "A String", # Publisher provided description for the terms.

2004

},

2005

"availableEndTime": "A String", # Proposed flight end time of the deal.

2006

# This will generally be stored in a granularity of a second.

2007

# A value is not required for Private Auction deals or Preferred Deals.

2008

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2009

},

2010

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2011

"proposalState": "A String", # Output only. The current state of the proposal.

2012

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2013

# Each update to the proposal or the deal causes the proposal revision number

2014

# to auto-increment. The buyer keeps track of the last revision number they

2015

# know of and pass it in when making an update. If the head revision number

2016

# on the server has since incremented, then an ABORTED error is returned

2017

# during the update operation to let the buyer know that a subsequent update

2018

# was made.

2019

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2020

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2021

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2022

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2023

#

2024

# Note: This field may be set only when creating the resource. Modifying

2025

# this field while updating the resource will result in an error.

2026

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2027

"subAccountId": "A String", # Optional sub-account ID for the seller.

2028

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2029

# The seller account ID is then available to buyer in the product.

2030

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2031

"buyerContacts": [ # Contact information for the buyer.

2032

{ # Contains information on how a buyer or seller can be reached.

2033

"name": "A String", # The name of the contact.

2034

"email": "A String", # Email address for the contact.

2035

},

2036

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2037

"displayName": "A String", # The name for the proposal.

2038

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2039

# left a comment.

2040

"proposalId": "A String", # Output only. The unique ID of the proposal.

2041

"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.

2042

# Authorized Buyers account ID.

2043

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2044

},

2045

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2046

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2047

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2048

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2049

# operations (max-length: 1024 unicode code units).

2050

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2051

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2052

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2053

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2054

#

2055

# Note: This field may be set only when creating the resource. Modifying

2056

# this field while updating the resource will result in an error.

2057

# Authorized Buyers account ID.

2058

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2059

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2064

<code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2065

<pre>Create the given proposal. Each created proposal and any deals it contains

2066

are assigned a unique ID by the server.

2067

2068

Args:

2069

accountId: string, Account ID of the buyer. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2070

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2071

The object takes the form of:

2072

2073

{ # Note: this resource requires whitelisting for access. Please contact your

2074

# account manager for access to Marketplace resources.

2075

#

2076

# Represents a proposal in the Marketplace. A proposal is the unit of

2077

# negotiation between a seller and a buyer and contains deals which

2078

# are served.

2079

#

2080

# Note: you can not update, create, or otherwise modify Private

2081

# Auction or Preferred Deals deals through the API.

2082

#

2083

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2084

"notes": [ # Output only. The notes associated with this proposal.

2085

{ # A proposal may be associated to several notes.

2086

"createTime": "A String", # Output only. The timestamp for when this note was created.

2087

"noteId": "A String", # Output only. The unique ID for the note.

2088

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2089

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2090

"note": "A String", # The actual note to attach.

2091

# (max-length: 1024 unicode code units)

2092

#

2093

# Note: This field may be set only when creating the resource. Modifying

2094

# this field while updating the resource will result in an error.

2095

},

2096

],

2097

"sellerContacts": [ # Output only. Contact information for the seller.

2098

{ # Contains information on how a buyer or seller can be reached.

2099

"name": "A String", # The name of the contact.

2100

"email": "A String", # Email address for the contact.

2101

},

2102

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2103

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2104

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2105

{ # A deal represents a segment of inventory for displaying ads on.

2106

# A proposal can contain multiple deals. A deal contains the terms and

2107

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2108

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2109

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2110

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2111

# target ad inventory. For example, they can choose to target ad requests only

2112

# if the user is in the US.

2113

# Multiple types of targeting are always applied as a logical AND, unless noted

2114

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2115

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2116

"excludedPositionTypes": [ # A list of video positions to be excluded.

2117

# Position types can either be included or excluded (XOR).

2118

"A String",

2119

],

2120

"targetedPositionTypes": [ # A list of video positions to be included.

2121

# When the included list is present, the excluded list must be empty.

2122

# When the excluded list is present, the included list must be empty.

2123

"A String",

2124

],

2125

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2126

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

2127

# mobile applications.

2128

# Different placement targeting types will be logically OR'ed.

2129

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2130

# For Private Auction and AdX Preferred Deals, URLs are either included or

2131

# excluded.

2132

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2133

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2134

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

"A String",

2136

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2137

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2142

# This doesn't apply to Auction Packages.

2143

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2144

# display the ads in.

2145

# publishers own.

2146

# Mobile application IDs are from App Store and Google Play Store.

2147

# Android App ID, for example, com.google.android.apps.maps, can be found in

2148

# Google Play Store URL.

2149

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2150

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2151

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2152

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2153

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2154

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2155

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2160

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2161

# included and excluded numeric IDs.

2162

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2163

"A String",

2164

],

2165

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2166

"A String",

2167

],

2168

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2169

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

2170

# request. It only applies to Private Auction, AdX Preferred Deals and

2171

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2172

# and Preferred Deals in Ad Manager.

2173

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2174

{ # Represents size of a single ad slot, or a creative.

2175

"width": "A String", # The width of the ad slot in pixels.

2176

# This field will be present only when size type is `PIXEL`.

2177

"sizeType": "A String", # The size type of the ad slot.

2178

"height": "A String", # The height of the ad slot in pixels.

2179

# This field will be present only when size type is `PIXEL`.

2180

},

2181

],

2182

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2183

{ # Represents size of a single ad slot, or a creative.

2184

"width": "A String", # The width of the ad slot in pixels.

2185

# This field will be present only when size type is `PIXEL`.

2186

"sizeType": "A String", # The size type of the ad slot.

2187

"height": "A String", # The height of the ad slot in pixels.

2188

# This field will be present only when size type is `PIXEL`.

2189

},

2190

],

2191

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2192

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2193

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2194

# included and excluded numeric IDs.

2195

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2196

"A String",

2197

],

2198

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

2203

# included and excluded numeric IDs.

2204

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2205

"A String",

2206

],

2207

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2208

"A String",

2209

],

2210

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2211

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2212

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2213

# included and excluded numeric IDs.

2214

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2215

"A String",

2216

],

2217

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

2222

# included and excluded numeric IDs.

2223

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2224

"A String",

2225

],

2226

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2231

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2232

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2233

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2234

# deal.

2235

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2236

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2237

# in Ad Manager.

2238

# Preferred Deal in Ad Manager.

2239

# This doesn't apply to Private Auction and AdX Preferred Deals.

2240

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2241

"creativeSpecifications": [

2242

{ # Represents information for a creative that is associated with a Programmatic

2243

# Guaranteed/Preferred Deal in Ad Manager.

2244

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2245

"width": "A String", # The width of the ad slot in pixels.

2246

# This field will be present only when size type is `PIXEL`.

2247

"sizeType": "A String", # The size type of the ad slot.

2248

"height": "A String", # The height of the ad slot in pixels.

2249

# This field will be present only when size type is `PIXEL`.

2250

},

2251

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2252

{ # Represents size of a single ad slot, or a creative.

2253

"width": "A String", # The width of the ad slot in pixels.

2254

# This field will be present only when size type is `PIXEL`.

2255

"sizeType": "A String", # The size type of the ad slot.

2256

"height": "A String", # The height of the ad slot in pixels.

2257

# This field will be present only when size type is `PIXEL`.

2258

},

2259

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2260

},

2261

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2262

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2263

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2264

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

2265

# If present on create, and the server `product_revision` has advanced sinced

2266

# the passed-in `create_product_revision`, an `ABORTED` error will be

2267

# returned.

2268

#

2269

# Note: This field may be set only when creating the resource. Modifying

2270

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2271

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2272

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2273

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2274

# operations (max-length: 1024 unicode code units).

2275

},

2276

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2277

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2278

# The deal is considered paused if either hasBuyerPaused or

2279

# hasSellPaused is true.

2280

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2281

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2282

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2283

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2284

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2285

},

2286

},

2287

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2288

# finalized. This is the deal ID that shows up in serving/reporting etc.

2289

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2290

# PUBLISHER means creative is provided by seller and ADVERTISER means

2291

# creative is provided by buyer.

2292

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

2293

# This will generally be stored in the granularity of one second since deal

2294

# serving starts at seconds boundary. Any time specified with more

2295

# granularity (e.g., in milliseconds) will be truncated towards the start of

2296

# time in seconds.

2297

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2298

"sellerContacts": [ # Output only. Seller contact information for the deal.

2299

{ # Contains information on how a buyer or seller can be reached.

2300

"name": "A String", # The name of the contact.

2301

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2302

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2303

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2304

"createProductId": "A String", # The product ID from which this deal was created.

2305

#

2306

# Note: This field may be set only when creating the resource. Modifying

2307

# this field while updating the resource will result in an error.

2308

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2309

"syndicationProduct": "A String", # The syndication product associated with the deal.

2310

#

2311

# Note: This field may be set only when creating the resource. Modifying

2312

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2313

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2314

"createTime": "A String", # Output only. The time of the deal creation.

2315

"description": "A String", # Description for the deal terms.

2316

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

2317

# to see but are non-negotiable. These are set by the publisher.

2318

"frequencyCaps": [ # Output only. Specifies any frequency caps.

2319

{ # Frequency cap.

2320

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2321

# which impressions per user are counted and capped.

2322

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

2323

# specified time period.

2324

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

2325

# amount of time over which impressions per user are counted and capped.

2326

},

2327

],

2328

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

2329

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

2330

},

2331

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2332

# targeting entity is AND'd together.

2333

{ # Advertisers can target different attributes of an ad slot. For example,

2334

# they can choose to show ads only if the user is in the U.S. Such

2335

# targeting criteria can be specified as part of Shared Targeting.

2336

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2337

# together.

2338

{ # A polymorphic targeting value used as part of Shared Targeting.

2339

"longValue": "A String", # The long value to include/exclude.

2340

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2341

# Filled in when the key is GOOG_DAYPART_TARGETING.

2342

# The definition of this targeting is derived from the structure

2343

# used by Ad Manager.

2344

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2345

"dayParts": [ # A list of day part targeting criterion.

2346

{ # Daypart targeting message that specifies if the ad can be shown

2347

# only during certain parts of a day/week.

2348

"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

2349

# granularity). The end time is exclusive. This field is not available

2350

# for filtering in PQL queries.

2351

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2352

# types are google.type.Date and `google.protobuf.Timestamp`.

2353

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2354

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2355

# allow the value 60 if it allows leap-seconds.

2356

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2357

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2358

# to allow the value "24:00:00" for scenarios like business closing time.

2359

},

2360

"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).

2361

# The start time is inclusive.

2362

# This field is not available for filtering in PQL queries.

2363

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2364

# types are google.type.Date and `google.protobuf.Timestamp`.

2365

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2366

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2367

# allow the value 60 if it allows leap-seconds.

2368

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2369

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2370

# to allow the value "24:00:00" for scenarios like business closing time.

2371

},

2372

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2377

# Filled in when key = GOOG_CREATIVE_SIZE

2378

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2379

# Companion sizes may be filled in only when creative_size_type = VIDEO

2380

{ # Message depicting the size of the creative. The units of width and

2381

# height depend on the type of the targeting.

2382

"height": 42, # The height of the creative.

2383

"width": 42, # The width of the creative

2384

},

2385

],

2386

"creativeSizeType": "A String", # The creative size type.

2387

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2388

# creative_size_type = CreativeSizeType.VIDEO.

2389

"allowedFormats": [ # What formats are allowed by the publisher.

2390

# If this repeated field is empty then all formats are allowed.

2391

# For example, if this field contains AllowedFormatType.AUDIO then the

2392

# publisher only allows an audio ad (without any video).

2393

"A String",

2394

],

2395

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2396

# of the creative

2397

# height depend on the type of the targeting.

2398

"height": 42, # The height of the creative.

2399

"width": 42, # The width of the creative

2400

},

2401

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2402

# only if creative_size_type = CreativeSizeType.NATIVE.

2403

},

2404

"stringValue": "A String", # The string value to include/exclude.

2405

},

2406

],

2407

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2408

# together.

2409

{ # A polymorphic targeting value used as part of Shared Targeting.

2410

"longValue": "A String", # The long value to include/exclude.

2411

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2412

# Filled in when the key is GOOG_DAYPART_TARGETING.

2413

# The definition of this targeting is derived from the structure

2414

# used by Ad Manager.

2415

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2416

"dayParts": [ # A list of day part targeting criterion.

2417

{ # Daypart targeting message that specifies if the ad can be shown

2418

# only during certain parts of a day/week.

2419

"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

2420

# granularity). The end time is exclusive. This field is not available

2421

# for filtering in PQL queries.

2422

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2423

# types are google.type.Date and `google.protobuf.Timestamp`.

2424

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2425

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2426

# allow the value 60 if it allows leap-seconds.

2427

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2428

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2429

# to allow the value "24:00:00" for scenarios like business closing time.

2430

},

2431

"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).

2432

# The start time is inclusive.

2433

# This field is not available for filtering in PQL queries.

2434

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2435

# types are google.type.Date and `google.protobuf.Timestamp`.

2436

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2437

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2438

# allow the value 60 if it allows leap-seconds.

2439

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2440

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2441

# to allow the value "24:00:00" for scenarios like business closing time.

2442

},

2443

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2448

# Filled in when key = GOOG_CREATIVE_SIZE

2449

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2450

# Companion sizes may be filled in only when creative_size_type = VIDEO

2451

{ # Message depicting the size of the creative. The units of width and

2452

# height depend on the type of the targeting.

2453

"height": 42, # The height of the creative.

2454

"width": 42, # The width of the creative

2455

},

2456

],

2457

"creativeSizeType": "A String", # The creative size type.

2458

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2459

# creative_size_type = CreativeSizeType.VIDEO.

2460

"allowedFormats": [ # What formats are allowed by the publisher.

2461

# If this repeated field is empty then all formats are allowed.

2462

# For example, if this field contains AllowedFormatType.AUDIO then the

2463

# publisher only allows an audio ad (without any video).

2464

"A String",

2465

],

2466

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2467

# of the creative

2468

# height depend on the type of the targeting.

2469

"height": 42, # The height of the creative.

2470

"width": 42, # The width of the creative

2471

},

2472

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2473

# only if creative_size_type = CreativeSizeType.NATIVE.

2474

},

2475

"stringValue": "A String", # The string value to include/exclude.

2476

},

2477

],

2478

"key": "A String", # The key representing the shared targeting criterion.

2479

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2480

# Third parties may define their own keys.

2481

# A list of permissible keys along with the acceptable values will be

2482

# provided as part of the external documentation.

2483

},

2484

],

2485

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2486

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2487

# and expected impressions from the publisher.

2488

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2489

# Can be set by buyer or seller.

2490

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

2491

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2492

# the API at this time, but can be returned in a get or list request.

2493

"fixedPrices": [ # Fixed price for the specified buyer.

2494

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2495

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2496

# a particular buyer or buyer/advertiser pair, we look for the most specific

2497

# matching rule - we first look for a rule matching the buyer and advertiser,

2498

# next a rule with the buyer but an empty advertiser list, and otherwise look

2499

# for a matching rule where no buyer is set.

2500

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2501

# If empty, all advertisers with this buyer pay this price.

2502

"A String",

2503

],

2504

"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

2505

# (if the

2506

# advertisers match, and there's no more specific rule matching the buyer).

2507

# Authorized Buyers account ID.

2508

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2509

},

2510

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2511

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2512

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2513

"units": "A String", # The whole units of the amount.

2514

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2515

"nanos": 42, # Number of nano (10^-9) units of the amount.

2516

# The value must be between -999,999,999 and +999,999,999 inclusive.

2517

# If `units` is positive, `nanos` must be positive or zero.

2518

# If `units` is zero, `nanos` can be positive, zero, or negative.

2519

# If `units` is negative, `nanos` must be negative or zero.

2520

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2521

"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.

2528

# Can be set by buyer or seller.

2529

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2530

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2531

"units": "A String", # The whole units of the amount.

2532

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2533

"nanos": 42, # Number of nano (10^-9) units of the amount.

2534

# The value must be between -999,999,999 and +999,999,999 inclusive.

2535

# If `units` is positive, `nanos` must be positive or zero.

2536

# If `units` is zero, `nanos` can be positive, zero, or negative.

2537

# If `units` is negative, `nanos` must be negative or zero.

2538

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2539

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2540

},

2541

},

2542

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2543

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2544

# of guaranteed looks that the buyer is guaranteeing to buy.

2545

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2546

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

2547

"fixedPrices": [ # Fixed price for the specified buyer.

2548

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2549

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2550

# a particular buyer or buyer/advertiser pair, we look for the most specific

2551

# matching rule - we first look for a rule matching the buyer and advertiser,

2552

# next a rule with the buyer but an empty advertiser list, and otherwise look

2553

# for a matching rule where no buyer is set.

2554

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2555

# If empty, all advertisers with this buyer pay this price.

2556

"A String",

2557

],

2558

"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

2559

# (if the

2560

# advertisers match, and there's no more specific rule matching the buyer).

2561

# Authorized Buyers account ID.

2562

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2563

},

2564

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2565

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2566

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2567

"units": "A String", # The whole units of the amount.

2568

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2569

"nanos": 42, # Number of nano (10^-9) units of the amount.

2570

# The value must be between -999,999,999 and +999,999,999 inclusive.

2571

# If `units` is positive, `nanos` must be positive or zero.

2572

# If `units` is zero, `nanos` can be positive, zero, or negative.

2573

# If `units` is negative, `nanos` must be negative or zero.

2574

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2575

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

2582

# by the seller, but they can be returned in a get or list request.

2583

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

2584

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2585

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2586

# a particular buyer or buyer/advertiser pair, we look for the most specific

2587

# matching rule - we first look for a rule matching the buyer and advertiser,

2588

# next a rule with the buyer but an empty advertiser list, and otherwise look

2589

# for a matching rule where no buyer is set.

2590

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2591

# If empty, all advertisers with this buyer pay this price.

2592

"A String",

2593

],

2594

"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

2595

# (if the

2596

# advertisers match, and there's no more specific rule matching the buyer).

2597

# Authorized Buyers account ID.

2598

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2599

},

2600

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2601

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2602

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2603

"units": "A String", # The whole units of the amount.

2604

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2605

"nanos": 42, # Number of nano (10^-9) units of the amount.

2606

# The value must be between -999,999,999 and +999,999,999 inclusive.

2607

# If `units` is positive, `nanos` must be positive or zero.

2608

# If `units` is zero, `nanos` can be positive, zero, or negative.

2609

# If `units` is negative, `nanos` must be negative or zero.

2610

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2611

"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

2617

# in this private auction.

2618

},

2619

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2620

# time zone used to mark the boundaries of a day. It should be an

2621

# IANA TZ name, such as "America/Los_Angeles". For more information,

2622

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

2623

"description": "A String", # Publisher provided description for the terms.

2624

},

2625

"availableEndTime": "A String", # Proposed flight end time of the deal.

2626

# This will generally be stored in a granularity of a second.

2627

# A value is not required for Private Auction deals or Preferred Deals.

2628

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2629

},

2630

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2631

"proposalState": "A String", # Output only. The current state of the proposal.

2632

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2633

# Each update to the proposal or the deal causes the proposal revision number

2634

# to auto-increment. The buyer keeps track of the last revision number they

2635

# know of and pass it in when making an update. If the head revision number

2636

# on the server has since incremented, then an ABORTED error is returned

2637

# during the update operation to let the buyer know that a subsequent update

2638

# was made.

2639

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

2640

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2641

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2642

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2643

#

2644

# Note: This field may be set only when creating the resource. Modifying

2645

# this field while updating the resource will result in an error.

2646

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2647

"subAccountId": "A String", # Optional sub-account ID for the seller.

2648

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2649

# The seller account ID is then available to buyer in the product.

2650

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2651

"buyerContacts": [ # Contact information for the buyer.

2652

{ # Contains information on how a buyer or seller can be reached.

2653

"name": "A String", # The name of the contact.

2654

"email": "A String", # Email address for the contact.

2655

},

2656

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2657

"displayName": "A String", # The name for the proposal.

2658

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2659

# left a comment.

2660

"proposalId": "A String", # Output only. The unique ID of the proposal.

2661

"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.

2662

# Authorized Buyers account ID.

2663

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2664

},

2665

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2666

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2667

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2668

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2669

# operations (max-length: 1024 unicode code units).

2670

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2671

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2672

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2673

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2674

#

2675

# Note: This field may be set only when creating the resource. Modifying

2676

# this field while updating the resource will result in an error.

2677

# Authorized Buyers account ID.

2678

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2679

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2680

}

2681

2682

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2689

2690

{ # Note: this resource requires whitelisting for access. Please contact your

2691

# account manager for access to Marketplace resources.

2692

#

2693

# Represents a proposal in the Marketplace. A proposal is the unit of

2694

# negotiation between a seller and a buyer and contains deals which

2695

# are served.

2696

#

2697

# Note: you can not update, create, or otherwise modify Private

2698

# Auction or Preferred Deals deals through the API.

2699

#

2700

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2701

"notes": [ # Output only. The notes associated with this proposal.

2702

{ # A proposal may be associated to several notes.

2703

"createTime": "A String", # Output only. The timestamp for when this note was created.

2704

"noteId": "A String", # Output only. The unique ID for the note.

2705

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2706

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2707

"note": "A String", # The actual note to attach.

2708

# (max-length: 1024 unicode code units)

2709

#

2710

# Note: This field may be set only when creating the resource. Modifying

2711

# this field while updating the resource will result in an error.

2712

},

2713

],

2714

"sellerContacts": [ # Output only. Contact information for the seller.

2715

{ # Contains information on how a buyer or seller can be reached.

2716

"name": "A String", # The name of the contact.

2717

"email": "A String", # Email address for the contact.

2718

},

2719

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2720

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2721

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2722

{ # A deal represents a segment of inventory for displaying ads on.

2723

# A proposal can contain multiple deals. A deal contains the terms and

2724

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2725

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2726

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2727

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2728

# target ad inventory. For example, they can choose to target ad requests only

2729

# if the user is in the US.

2730

# Multiple types of targeting are always applied as a logical AND, unless noted

2731

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2732

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2733

"excludedPositionTypes": [ # A list of video positions to be excluded.

2734

# Position types can either be included or excluded (XOR).

2735

"A String",

2736

],

2737

"targetedPositionTypes": [ # A list of video positions to be included.

2738

# When the included list is present, the excluded list must be empty.

2739

# When the excluded list is present, the included list must be empty.

2740

"A String",

2741

],

2742

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

2744

# mobile applications.

2745

# Different placement targeting types will be logically OR'ed.

2746

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2747

# For Private Auction and AdX Preferred Deals, URLs are either included or

2748

# excluded.

2749

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2750

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2751

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2752

"A String",

2753

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2754

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2759

# This doesn't apply to Auction Packages.

2760

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2761

# display the ads in.

2762

# publishers own.

2763

# Mobile application IDs are from App Store and Google Play Store.

2764

# Android App ID, for example, com.google.android.apps.maps, can be found in

2765

# Google Play Store URL.

2766

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2767

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2768

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2769

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2770

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2771

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2772

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2777

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2778

# included and excluded numeric IDs.

2779

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2780

"A String",

2781

],

2782

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2783

"A String",

2784

],

2785

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2786

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

2787

# request. It only applies to Private Auction, AdX Preferred Deals and

2788

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2789

# and Preferred Deals in Ad Manager.

2790

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2791

{ # Represents size of a single ad slot, or a creative.

2792

"width": "A String", # The width of the ad slot in pixels.

2793

# This field will be present only when size type is `PIXEL`.

2794

"sizeType": "A String", # The size type of the ad slot.

2795

"height": "A String", # The height of the ad slot in pixels.

2796

# This field will be present only when size type is `PIXEL`.

2797

},

2798

],

2799

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2800

{ # Represents size of a single ad slot, or a creative.

2801

"width": "A String", # The width of the ad slot in pixels.

2802

# This field will be present only when size type is `PIXEL`.

2803

"sizeType": "A String", # The size type of the ad slot.

2804

"height": "A String", # The height of the ad slot in pixels.

2805

# This field will be present only when size type is `PIXEL`.

2806

},

2807

],

2808

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2809

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2810

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2811

# included and excluded numeric IDs.

2812

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2813

"A String",

2814

],

2815

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

2820

# included and excluded numeric IDs.

2821

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2822

"A String",

2823

],

2824

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

2825

"A String",

2826

],

2827

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2828

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2829

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2830

# included and excluded numeric IDs.

2831

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2832

"A String",

2833

],

2834

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

2839

# included and excluded numeric IDs.

2840

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2841

"A String",

2842

],

2843

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2848

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2849

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2850

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2851

# deal.

2852

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2853

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2854

# in Ad Manager.

2855

# Preferred Deal in Ad Manager.

2856

# This doesn't apply to Private Auction and AdX Preferred Deals.

2857

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2858

"creativeSpecifications": [

2859

{ # Represents information for a creative that is associated with a Programmatic

2860

# Guaranteed/Preferred Deal in Ad Manager.

2861

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2862

"width": "A String", # The width of the ad slot in pixels.

2863

# This field will be present only when size type is `PIXEL`.

2864

"sizeType": "A String", # The size type of the ad slot.

2865

"height": "A String", # The height of the ad slot in pixels.

2866

# This field will be present only when size type is `PIXEL`.

2867

},

2868

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2869

{ # Represents size of a single ad slot, or a creative.

2870

"width": "A String", # The width of the ad slot in pixels.

2871

# This field will be present only when size type is `PIXEL`.

2872

"sizeType": "A String", # The size type of the ad slot.

2873

"height": "A String", # The height of the ad slot in pixels.

2874

# This field will be present only when size type is `PIXEL`.

2875

},

2876

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2877

},

2878

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2879

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2880

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2881

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

2882

# If present on create, and the server `product_revision` has advanced sinced

2883

# the passed-in `create_product_revision`, an `ABORTED` error will be

2884

# returned.

2885

#

2886

# Note: This field may be set only when creating the resource. Modifying

2887

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2888

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2889

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2890

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2891

# operations (max-length: 1024 unicode code units).

2892

},

2893

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2894

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2895

# The deal is considered paused if either hasBuyerPaused or

2896

# hasSellPaused is true.

2897

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2898

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2899

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

2900

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2901

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2902

},

2903

},

2904

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2905

# finalized. This is the deal ID that shows up in serving/reporting etc.

2906

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2907

# PUBLISHER means creative is provided by seller and ADVERTISER means

2908

# creative is provided by buyer.

2909

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

2910

# This will generally be stored in the granularity of one second since deal

2911

# serving starts at seconds boundary. Any time specified with more

2912

# granularity (e.g., in milliseconds) will be truncated towards the start of

2913

# time in seconds.

2914

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2915

"sellerContacts": [ # Output only. Seller contact information for the deal.

2916

{ # Contains information on how a buyer or seller can be reached.

2917

"name": "A String", # The name of the contact.

2918

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2919

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2920

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2921

"createProductId": "A String", # The product ID from which this deal was created.

2922

#

2923

# Note: This field may be set only when creating the resource. Modifying

2924

# this field while updating the resource will result in an error.

2925

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2926

"syndicationProduct": "A String", # The syndication product associated with the deal.

2927

#

2928

# Note: This field may be set only when creating the resource. Modifying

2929

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2930

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2931

"createTime": "A String", # Output only. The time of the deal creation.

2932

"description": "A String", # Description for the deal terms.

2933

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

2934

# to see but are non-negotiable. These are set by the publisher.

2935

"frequencyCaps": [ # Output only. Specifies any frequency caps.

2936

{ # Frequency cap.

2937

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2938

# which impressions per user are counted and capped.

2939

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

2940

# specified time period.

2941

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

2942

# amount of time over which impressions per user are counted and capped.

2943

},

2944

],

2945

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

2946

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

2947

},

2948

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2949

# targeting entity is AND'd together.

2950

{ # Advertisers can target different attributes of an ad slot. For example,

2951

# they can choose to show ads only if the user is in the U.S. Such

2952

# targeting criteria can be specified as part of Shared Targeting.

2953

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2954

# together.

2955

{ # A polymorphic targeting value used as part of Shared Targeting.

2956

"longValue": "A String", # The long value to include/exclude.

2957

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2958

# Filled in when the key is GOOG_DAYPART_TARGETING.

2959

# The definition of this targeting is derived from the structure

2960

# used by Ad Manager.

2961

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2962

"dayParts": [ # A list of day part targeting criterion.

2963

{ # Daypart targeting message that specifies if the ad can be shown

2964

# only during certain parts of a day/week.

2965

"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

2966

# granularity). The end time is exclusive. This field is not available

2967

# for filtering in PQL queries.

2968

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2969

# types are google.type.Date and `google.protobuf.Timestamp`.

2970

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2971

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2972

# allow the value 60 if it allows leap-seconds.

2973

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2974

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2975

# to allow the value "24:00:00" for scenarios like business closing time.

2976

},

2977

"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).

2978

# The start time is inclusive.

2979

# This field is not available for filtering in PQL queries.

2980

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2981

# types are google.type.Date and `google.protobuf.Timestamp`.

2982

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2983

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2984

# allow the value 60 if it allows leap-seconds.

2985

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2986

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2987

# to allow the value "24:00:00" for scenarios like business closing time.

2988

},

2989

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2994

# Filled in when key = GOOG_CREATIVE_SIZE

2995

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2996

# Companion sizes may be filled in only when creative_size_type = VIDEO

2997

{ # Message depicting the size of the creative. The units of width and

2998

# height depend on the type of the targeting.

2999

"height": 42, # The height of the creative.

3000

"width": 42, # The width of the creative

3001

},

3002

],

3003

"creativeSizeType": "A String", # The creative size type.

3004

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3005

# creative_size_type = CreativeSizeType.VIDEO.

3006

"allowedFormats": [ # What formats are allowed by the publisher.

3007

# If this repeated field is empty then all formats are allowed.

3008

# For example, if this field contains AllowedFormatType.AUDIO then the

3009

# publisher only allows an audio ad (without any video).

3010

"A String",

3011

],

3012

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3013

# of the creative

3014

# height depend on the type of the targeting.

3015

"height": 42, # The height of the creative.

3016

"width": 42, # The width of the creative

3017

},

3018

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3019

# only if creative_size_type = CreativeSizeType.NATIVE.

3020

},

3021

"stringValue": "A String", # The string value to include/exclude.

3022

},

3023

],

3024

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3025

# together.

3026

{ # A polymorphic targeting value used as part of Shared Targeting.

3027

"longValue": "A String", # The long value to include/exclude.

3028

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3029

# Filled in when the key is GOOG_DAYPART_TARGETING.

3030

# The definition of this targeting is derived from the structure

3031

# used by Ad Manager.

3032

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3033

"dayParts": [ # A list of day part targeting criterion.

3034

{ # Daypart targeting message that specifies if the ad can be shown

3035

# only during certain parts of a day/week.

3036

"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

3037

# granularity). The end time is exclusive. This field is not available

3038

# for filtering in PQL queries.

3039

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3040

# types are google.type.Date and `google.protobuf.Timestamp`.

3041

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3042

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3043

# allow the value 60 if it allows leap-seconds.

3044

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3045

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3046

# to allow the value "24:00:00" for scenarios like business closing time.

3047

},

3048

"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).

3049

# The start time is inclusive.

3050

# This field is not available for filtering in PQL queries.

3051

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3052

# types are google.type.Date and `google.protobuf.Timestamp`.

3053

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3054

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3055

# allow the value 60 if it allows leap-seconds.

3056

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3057

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3058

# to allow the value "24:00:00" for scenarios like business closing time.

3059

},

3060

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3065

# Filled in when key = GOOG_CREATIVE_SIZE

3066

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3067

# Companion sizes may be filled in only when creative_size_type = VIDEO

3068

{ # Message depicting the size of the creative. The units of width and

3069

# height depend on the type of the targeting.

3070

"height": 42, # The height of the creative.

3071

"width": 42, # The width of the creative

3072

},

3073

],

3074

"creativeSizeType": "A String", # The creative size type.

3075

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3076

# creative_size_type = CreativeSizeType.VIDEO.

3077

"allowedFormats": [ # What formats are allowed by the publisher.

3078

# If this repeated field is empty then all formats are allowed.

3079

# For example, if this field contains AllowedFormatType.AUDIO then the

3080

# publisher only allows an audio ad (without any video).

3081

"A String",

3082

],

3083

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3084

# of the creative

3085

# height depend on the type of the targeting.

3086

"height": 42, # The height of the creative.

3087

"width": 42, # The width of the creative

3088

},

3089

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3090

# only if creative_size_type = CreativeSizeType.NATIVE.

3091

},

3092

"stringValue": "A String", # The string value to include/exclude.

3093

},

3094

],

3095

"key": "A String", # The key representing the shared targeting criterion.

3096

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3097

# Third parties may define their own keys.

3098

# A list of permissible keys along with the acceptable values will be

3099

# provided as part of the external documentation.

3100

},

3101

],

3102

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

3103

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

3104

# and expected impressions from the publisher.

3105

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

3106

# Can be set by buyer or seller.

3107

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3108

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3109

# the API at this time, but can be returned in a get or list request.

3110

"fixedPrices": [ # Fixed price for the specified buyer.

3111

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3112

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3113

# a particular buyer or buyer/advertiser pair, we look for the most specific

3114

# matching rule - we first look for a rule matching the buyer and advertiser,

3115

# next a rule with the buyer but an empty advertiser list, and otherwise look

3116

# for a matching rule where no buyer is set.

3117

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3118

# If empty, all advertisers with this buyer pay this price.

3119

"A String",

3120

],

3121

"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

3122

# (if the

3123

# advertisers match, and there's no more specific rule matching the buyer).

3124

# Authorized Buyers account ID.

3125

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3126

},

3127

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3128

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3129

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3130

"units": "A String", # The whole units of the amount.

3131

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3132

"nanos": 42, # Number of nano (10^-9) units of the amount.

3133

# The value must be between -999,999,999 and +999,999,999 inclusive.

3134

# If `units` is positive, `nanos` must be positive or zero.

3135

# If `units` is zero, `nanos` can be positive, zero, or negative.

3136

# If `units` is negative, `nanos` must be negative or zero.

3137

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3138

"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.

3145

# Can be set by buyer or seller.

3146

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3147

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3148

"units": "A String", # The whole units of the amount.

3149

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3150

"nanos": 42, # Number of nano (10^-9) units of the amount.

3151

# The value must be between -999,999,999 and +999,999,999 inclusive.

3152

# If `units` is positive, `nanos` must be positive or zero.

3153

# If `units` is zero, `nanos` can be positive, zero, or negative.

3154

# If `units` is negative, `nanos` must be negative or zero.

3155

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3156

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3157

},

3158

},

3159

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3160

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3161

# of guaranteed looks that the buyer is guaranteeing to buy.

3162

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3163

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

3164

"fixedPrices": [ # Fixed price for the specified buyer.

3165

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3166

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3167

# a particular buyer or buyer/advertiser pair, we look for the most specific

3168

# matching rule - we first look for a rule matching the buyer and advertiser,

3169

# next a rule with the buyer but an empty advertiser list, and otherwise look

3170

# for a matching rule where no buyer is set.

3171

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3172

# If empty, all advertisers with this buyer pay this price.

3173

"A String",

3174

],

3175

"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

3176

# (if the

3177

# advertisers match, and there's no more specific rule matching the buyer).

3178

# Authorized Buyers account ID.

3179

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3180

},

3181

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3182

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3183

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3184

"units": "A String", # The whole units of the amount.

3185

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3186

"nanos": 42, # Number of nano (10^-9) units of the amount.

3187

# The value must be between -999,999,999 and +999,999,999 inclusive.

3188

# If `units` is positive, `nanos` must be positive or zero.

3189

# If `units` is zero, `nanos` can be positive, zero, or negative.

3190

# If `units` is negative, `nanos` must be negative or zero.

3191

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3192

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3199

# by the seller, but they can be returned in a get or list request.

3200

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3201

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3202

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3203

# a particular buyer or buyer/advertiser pair, we look for the most specific

3204

# matching rule - we first look for a rule matching the buyer and advertiser,

3205

# next a rule with the buyer but an empty advertiser list, and otherwise look

3206

# for a matching rule where no buyer is set.

3207

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3208

# If empty, all advertisers with this buyer pay this price.

3209

"A String",

3210

],

3211

"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

3212

# (if the

3213

# advertisers match, and there's no more specific rule matching the buyer).

3214

# Authorized Buyers account ID.

3215

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3216

},

3217

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3218

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3219

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3220

"units": "A String", # The whole units of the amount.

3221

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3222

"nanos": 42, # Number of nano (10^-9) units of the amount.

3223

# The value must be between -999,999,999 and +999,999,999 inclusive.

3224

# If `units` is positive, `nanos` must be positive or zero.

3225

# If `units` is zero, `nanos` can be positive, zero, or negative.

3226

# If `units` is negative, `nanos` must be negative or zero.

3227

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3228

"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

3234

# in this private auction.

3235

},

3236

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3237

# time zone used to mark the boundaries of a day. It should be an

3238

# IANA TZ name, such as "America/Los_Angeles". For more information,

3239

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

3240

"description": "A String", # Publisher provided description for the terms.

3241

},

3242

"availableEndTime": "A String", # Proposed flight end time of the deal.

3243

# This will generally be stored in a granularity of a second.

3244

# A value is not required for Private Auction deals or Preferred Deals.

3245

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3246

},

3247

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3248

"proposalState": "A String", # Output only. The current state of the proposal.

3249

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3250

# Each update to the proposal or the deal causes the proposal revision number

3251

# to auto-increment. The buyer keeps track of the last revision number they

3252

# know of and pass it in when making an update. If the head revision number

3253

# on the server has since incremented, then an ABORTED error is returned

3254

# during the update operation to let the buyer know that a subsequent update

3255

# was made.

3256

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

3257

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3258

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3259

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3260

#

3261

# Note: This field may be set only when creating the resource. Modifying

3262

# this field while updating the resource will result in an error.

3263

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3264

"subAccountId": "A String", # Optional sub-account ID for the seller.

3265

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3266

# The seller account ID is then available to buyer in the product.

3267

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3268

"buyerContacts": [ # Contact information for the buyer.

3269

{ # Contains information on how a buyer or seller can be reached.

3270

"name": "A String", # The name of the contact.

3271

"email": "A String", # Email address for the contact.

3272

},

3273

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3274

"displayName": "A String", # The name for the proposal.

3275

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3276

# left a comment.

3277

"proposalId": "A String", # Output only. The unique ID of the proposal.

3278

"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.

3279

# Authorized Buyers account ID.

3280

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3281

},

3282

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3283

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3284

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3285

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3286

# operations (max-length: 1024 unicode code units).

3287

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3288

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3289

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3290

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3291

#

3292

# Note: This field may be set only when creating the resource. Modifying

3293

# this field while updating the resource will result in an error.

3294

# Authorized Buyers account ID.

3295

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3296

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(accountId, proposalId, x__xgafv=None)</code>

3302

<pre>Gets a proposal given its ID. The proposal is returned at its head

revision.

Args:

accountId: string, Account ID of the buyer. (required)

3307

proposalId: string, The unique ID of the proposal (required)

3308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3315

3316

{ # Note: this resource requires whitelisting for access. Please contact your

3317

# account manager for access to Marketplace resources.

3318

#

3319

# Represents a proposal in the Marketplace. A proposal is the unit of

3320

# negotiation between a seller and a buyer and contains deals which

3321

# are served.

3322

#

3323

# Note: you can not update, create, or otherwise modify Private

3324

# Auction or Preferred Deals deals through the API.

3325

#

3326

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3327

"notes": [ # Output only. The notes associated with this proposal.

3328

{ # A proposal may be associated to several notes.

3329

"createTime": "A String", # Output only. The timestamp for when this note was created.

3330

"noteId": "A String", # Output only. The unique ID for the note.

3331

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3332

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3333

"note": "A String", # The actual note to attach.

3334

# (max-length: 1024 unicode code units)

3335

#

3336

# Note: This field may be set only when creating the resource. Modifying

3337

# this field while updating the resource will result in an error.

3338

},

3339

],

3340

"sellerContacts": [ # Output only. Contact information for the seller.

3341

{ # Contains information on how a buyer or seller can be reached.

3342

"name": "A String", # The name of the contact.

3343

"email": "A String", # Email address for the contact.

3344

},

3345

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3346

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3347

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3348

{ # A deal represents a segment of inventory for displaying ads on.

3349

# A proposal can contain multiple deals. A deal contains the terms and

3350

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3351

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3352

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3353

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3354

# target ad inventory. For example, they can choose to target ad requests only

3355

# if the user is in the US.

3356

# Multiple types of targeting are always applied as a logical AND, unless noted

3357

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3358

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3359

"excludedPositionTypes": [ # A list of video positions to be excluded.

3360

# Position types can either be included or excluded (XOR).

3361

"A String",

3362

],

3363

"targetedPositionTypes": [ # A list of video positions to be included.

3364

# When the included list is present, the excluded list must be empty.

3365

# When the excluded list is present, the included list must be empty.

3366

"A String",

3367

],

3368

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3369

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

3370

# mobile applications.

3371

# Different placement targeting types will be logically OR'ed.

3372

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3373

# For Private Auction and AdX Preferred Deals, URLs are either included or

3374

# excluded.

3375

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3376

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3377

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3378

"A String",

3379

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3380

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3385

# This doesn't apply to Auction Packages.

3386

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3387

# display the ads in.

3388

# publishers own.

3389

# Mobile application IDs are from App Store and Google Play Store.

3390

# Android App ID, for example, com.google.android.apps.maps, can be found in

3391

# Google Play Store URL.

3392

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3393

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3394

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3395

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3396

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3397

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3398

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3403

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3404

# included and excluded numeric IDs.

3405

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3406

"A String",

3407

],

3408

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3409

"A String",

3410

],

3411

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3412

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

3413

# request. It only applies to Private Auction, AdX Preferred Deals and

3414

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3415

# and Preferred Deals in Ad Manager.

3416

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3417

{ # Represents size of a single ad slot, or a creative.

3418

"width": "A String", # The width of the ad slot in pixels.

3419

# This field will be present only when size type is `PIXEL`.

3420

"sizeType": "A String", # The size type of the ad slot.

3421

"height": "A String", # The height of the ad slot in pixels.

3422

# This field will be present only when size type is `PIXEL`.

3423

},

3424

],

3425

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3426

{ # Represents size of a single ad slot, or a creative.

3427

"width": "A String", # The width of the ad slot in pixels.

3428

# This field will be present only when size type is `PIXEL`.

3429

"sizeType": "A String", # The size type of the ad slot.

3430

"height": "A String", # The height of the ad slot in pixels.

3431

# This field will be present only when size type is `PIXEL`.

3432

},

3433

],

3434

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3435

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3436

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3437

# included and excluded numeric IDs.

3438

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3439

"A String",

3440

],

3441

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

3446

# included and excluded numeric IDs.

3447

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3448

"A String",

3449

],

3450

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

3451

"A String",

3452

],

3453

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3454

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3455

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3456

# included and excluded numeric IDs.

3457

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3458

"A String",

3459

],

3460

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

3465

# included and excluded numeric IDs.

3466

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3467

"A String",

3468

],

3469

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3474

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3475

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3476

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3477

# deal.

3478

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

3479

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

3480

# in Ad Manager.

3481

# Preferred Deal in Ad Manager.

3482

# This doesn't apply to Private Auction and AdX Preferred Deals.

3483

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

3484

"creativeSpecifications": [

3485

{ # Represents information for a creative that is associated with a Programmatic

3486

# Guaranteed/Preferred Deal in Ad Manager.

3487

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

3488

"width": "A String", # The width of the ad slot in pixels.

3489

# This field will be present only when size type is `PIXEL`.

3490

"sizeType": "A String", # The size type of the ad slot.

3491

"height": "A String", # The height of the ad slot in pixels.

3492

# This field will be present only when size type is `PIXEL`.

3493

},

3494

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

3495

{ # Represents size of a single ad slot, or a creative.

3496

"width": "A String", # The width of the ad slot in pixels.

3497

# This field will be present only when size type is `PIXEL`.

3498

"sizeType": "A String", # The size type of the ad slot.

3499

"height": "A String", # The height of the ad slot in pixels.

3500

# This field will be present only when size type is `PIXEL`.

3501

},

3502

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3503

},

3504

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3505

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3506

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3507

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

3508

# If present on create, and the server `product_revision` has advanced sinced

3509

# the passed-in `create_product_revision`, an `ABORTED` error will be

3510

# returned.

3511

#

3512

# Note: This field may be set only when creating the resource. Modifying

3513

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3514

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3515

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3516

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3517

# operations (max-length: 1024 unicode code units).

3518

},

3519

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3520

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

3521

# The deal is considered paused if either hasBuyerPaused or

3522

# hasSellPaused is true.

3523

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3524

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3525

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

3526

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

3527

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3528

},

3529

},

3530

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3531

# finalized. This is the deal ID that shows up in serving/reporting etc.

3532

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3533

# PUBLISHER means creative is provided by seller and ADVERTISER means

3534

# creative is provided by buyer.

3535

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

3536

# This will generally be stored in the granularity of one second since deal

3537

# serving starts at seconds boundary. Any time specified with more

3538

# granularity (e.g., in milliseconds) will be truncated towards the start of

3539

# time in seconds.

3540

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3541

"sellerContacts": [ # Output only. Seller contact information for the deal.

3542

{ # Contains information on how a buyer or seller can be reached.

3543

"name": "A String", # The name of the contact.

3544

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3545

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3546

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3547

"createProductId": "A String", # The product ID from which this deal was created.

3548

#

3549

# Note: This field may be set only when creating the resource. Modifying

3550

# this field while updating the resource will result in an error.

3551

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3552

"syndicationProduct": "A String", # The syndication product associated with the deal.

3553

#

3554

# Note: This field may be set only when creating the resource. Modifying

3555

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3556

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3557

"createTime": "A String", # Output only. The time of the deal creation.

3558

"description": "A String", # Description for the deal terms.

3559

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

3560

# to see but are non-negotiable. These are set by the publisher.

3561

"frequencyCaps": [ # Output only. Specifies any frequency caps.

3562

{ # Frequency cap.

3563

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3564

# which impressions per user are counted and capped.

3565

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

3566

# specified time period.

3567

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

3568

# amount of time over which impressions per user are counted and capped.

3569

},

3570

],

3571

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

3572

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

3573

},

3574

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3575

# targeting entity is AND'd together.

3576

{ # Advertisers can target different attributes of an ad slot. For example,

3577

# they can choose to show ads only if the user is in the U.S. Such

3578

# targeting criteria can be specified as part of Shared Targeting.

3579

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

3580

# together.

3581

{ # A polymorphic targeting value used as part of Shared Targeting.

3582

"longValue": "A String", # The long value to include/exclude.

3583

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3584

# Filled in when the key is GOOG_DAYPART_TARGETING.

3585

# The definition of this targeting is derived from the structure

3586

# used by Ad Manager.

3587

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3588

"dayParts": [ # A list of day part targeting criterion.

3589

{ # Daypart targeting message that specifies if the ad can be shown

3590

# only during certain parts of a day/week.

3591

"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

3592

# granularity). The end time is exclusive. This field is not available

3593

# for filtering in PQL queries.

3594

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3595

# types are google.type.Date and `google.protobuf.Timestamp`.

3596

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3597

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3598

# allow the value 60 if it allows leap-seconds.

3599

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3600

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3601

# to allow the value "24:00:00" for scenarios like business closing time.

3602

},

3603

"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).

3604

# The start time is inclusive.

3605

# This field is not available for filtering in PQL queries.

3606

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3607

# types are google.type.Date and `google.protobuf.Timestamp`.

3608

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3609

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3610

# allow the value 60 if it allows leap-seconds.

3611

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3612

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3613

# to allow the value "24:00:00" for scenarios like business closing time.

3614

},

3615

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3620

# Filled in when key = GOOG_CREATIVE_SIZE

3621

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3622

# Companion sizes may be filled in only when creative_size_type = VIDEO

3623

{ # Message depicting the size of the creative. The units of width and

3624

# height depend on the type of the targeting.

3625

"height": 42, # The height of the creative.

3626

"width": 42, # The width of the creative

3627

},

3628

],

3629

"creativeSizeType": "A String", # The creative size type.

3630

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3631

# creative_size_type = CreativeSizeType.VIDEO.

3632

"allowedFormats": [ # What formats are allowed by the publisher.

3633

# If this repeated field is empty then all formats are allowed.

3634

# For example, if this field contains AllowedFormatType.AUDIO then the

3635

# publisher only allows an audio ad (without any video).

3636

"A String",

3637

],

3638

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3639

# of the creative

3640

# height depend on the type of the targeting.

3641

"height": 42, # The height of the creative.

3642

"width": 42, # The width of the creative

3643

},

3644

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3645

# only if creative_size_type = CreativeSizeType.NATIVE.

3646

},

3647

"stringValue": "A String", # The string value to include/exclude.

3648

},

3649

],

3650

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3651

# together.

3652

{ # A polymorphic targeting value used as part of Shared Targeting.

3653

"longValue": "A String", # The long value to include/exclude.

3654

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3655

# Filled in when the key is GOOG_DAYPART_TARGETING.

3656

# The definition of this targeting is derived from the structure

3657

# used by Ad Manager.

3658

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3659

"dayParts": [ # A list of day part targeting criterion.

3660

{ # Daypart targeting message that specifies if the ad can be shown

3661

# only during certain parts of a day/week.

3662

"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

3663

# granularity). The end time is exclusive. This field is not available

3664

# for filtering in PQL queries.

3665

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3666

# types are google.type.Date and `google.protobuf.Timestamp`.

3667

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3668

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3669

# allow the value 60 if it allows leap-seconds.

3670

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3671

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3672

# to allow the value "24:00:00" for scenarios like business closing time.

3673

},

3674

"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).

3675

# The start time is inclusive.

3676

# This field is not available for filtering in PQL queries.

3677

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3678

# types are google.type.Date and `google.protobuf.Timestamp`.

3679

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3680

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3681

# allow the value 60 if it allows leap-seconds.

3682

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3683

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3684

# to allow the value "24:00:00" for scenarios like business closing time.

3685

},

3686

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3691

# Filled in when key = GOOG_CREATIVE_SIZE

3692

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3693

# Companion sizes may be filled in only when creative_size_type = VIDEO

3694

{ # Message depicting the size of the creative. The units of width and

3695

# height depend on the type of the targeting.

3696

"height": 42, # The height of the creative.

3697

"width": 42, # The width of the creative

3698

},

3699

],

3700

"creativeSizeType": "A String", # The creative size type.

3701

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3702

# creative_size_type = CreativeSizeType.VIDEO.

3703

"allowedFormats": [ # What formats are allowed by the publisher.

3704

# If this repeated field is empty then all formats are allowed.

3705

# For example, if this field contains AllowedFormatType.AUDIO then the

3706

# publisher only allows an audio ad (without any video).

3707

"A String",

3708

],

3709

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3710

# of the creative

3711

# height depend on the type of the targeting.

3712

"height": 42, # The height of the creative.

3713

"width": 42, # The width of the creative

3714

},

3715

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3716

# only if creative_size_type = CreativeSizeType.NATIVE.

3717

},

3718

"stringValue": "A String", # The string value to include/exclude.

3719

},

3720

],

3721

"key": "A String", # The key representing the shared targeting criterion.

3722

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3723

# Third parties may define their own keys.

3724

# A list of permissible keys along with the acceptable values will be

3725

# provided as part of the external documentation.

3726

},

3727

],

3728

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

3729

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

3730

# and expected impressions from the publisher.

3731

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

3732

# Can be set by buyer or seller.

3733

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

3734

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3735

# the API at this time, but can be returned in a get or list request.

3736

"fixedPrices": [ # Fixed price for the specified buyer.

3737

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3738

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3739

# a particular buyer or buyer/advertiser pair, we look for the most specific

3740

# matching rule - we first look for a rule matching the buyer and advertiser,

3741

# next a rule with the buyer but an empty advertiser list, and otherwise look

3742

# for a matching rule where no buyer is set.

3743

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3744

# If empty, all advertisers with this buyer pay this price.

3745

"A String",

3746

],

3747

"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

3748

# (if the

3749

# advertisers match, and there's no more specific rule matching the buyer).

3750

# Authorized Buyers account ID.

3751

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3752

},

3753

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3754

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3755

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3756

"units": "A String", # The whole units of the amount.

3757

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3758

"nanos": 42, # Number of nano (10^-9) units of the amount.

3759

# The value must be between -999,999,999 and +999,999,999 inclusive.

3760

# If `units` is positive, `nanos` must be positive or zero.

3761

# If `units` is zero, `nanos` can be positive, zero, or negative.

3762

# If `units` is negative, `nanos` must be negative or zero.

3763

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3764

"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.

3771

# Can be set by buyer or seller.

3772

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3773

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3774

"units": "A String", # The whole units of the amount.

3775

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3776

"nanos": 42, # Number of nano (10^-9) units of the amount.

3777

# The value must be between -999,999,999 and +999,999,999 inclusive.

3778

# If `units` is positive, `nanos` must be positive or zero.

3779

# If `units` is zero, `nanos` can be positive, zero, or negative.

3780

# If `units` is negative, `nanos` must be negative or zero.

3781

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3782

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3783

},

3784

},

3785

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3786

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3787

# of guaranteed looks that the buyer is guaranteeing to buy.

3788

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3789

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

3790

"fixedPrices": [ # Fixed price for the specified buyer.

3791

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3792

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3793

# a particular buyer or buyer/advertiser pair, we look for the most specific

3794

# matching rule - we first look for a rule matching the buyer and advertiser,

3795

# next a rule with the buyer but an empty advertiser list, and otherwise look

3796

# for a matching rule where no buyer is set.

3797

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3798

# If empty, all advertisers with this buyer pay this price.

3799

"A String",

3800

],

3801

"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

3802

# (if the

3803

# advertisers match, and there's no more specific rule matching the buyer).

3804

# Authorized Buyers account ID.

3805

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3806

},

3807

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3808

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3809

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3810

"units": "A String", # The whole units of the amount.

3811

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3812

"nanos": 42, # Number of nano (10^-9) units of the amount.

3813

# The value must be between -999,999,999 and +999,999,999 inclusive.

3814

# If `units` is positive, `nanos` must be positive or zero.

3815

# If `units` is zero, `nanos` can be positive, zero, or negative.

3816

# If `units` is negative, `nanos` must be negative or zero.

3817

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3818

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3825

# by the seller, but they can be returned in a get or list request.

3826

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3827

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3828

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3829

# a particular buyer or buyer/advertiser pair, we look for the most specific

3830

# matching rule - we first look for a rule matching the buyer and advertiser,

3831

# next a rule with the buyer but an empty advertiser list, and otherwise look

3832

# for a matching rule where no buyer is set.

3833

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3834

# If empty, all advertisers with this buyer pay this price.

3835

"A String",

3836

],

3837

"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

3838

# (if the

3839

# advertisers match, and there's no more specific rule matching the buyer).

3840

# Authorized Buyers account ID.

3841

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3842

},

3843

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3844

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3845

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3846

"units": "A String", # The whole units of the amount.

3847

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3848

"nanos": 42, # Number of nano (10^-9) units of the amount.

3849

# The value must be between -999,999,999 and +999,999,999 inclusive.

3850

# If `units` is positive, `nanos` must be positive or zero.

3851

# If `units` is zero, `nanos` can be positive, zero, or negative.

3852

# If `units` is negative, `nanos` must be negative or zero.

3853

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3854

"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

3860

# in this private auction.

3861

},

3862

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3863

# time zone used to mark the boundaries of a day. It should be an

3864

# IANA TZ name, such as "America/Los_Angeles". For more information,

3865

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

3866

"description": "A String", # Publisher provided description for the terms.

3867

},

3868

"availableEndTime": "A String", # Proposed flight end time of the deal.

3869

# This will generally be stored in a granularity of a second.

3870

# A value is not required for Private Auction deals or Preferred Deals.

3871

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3872

},

3873

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3874

"proposalState": "A String", # Output only. The current state of the proposal.

3875

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3876

# Each update to the proposal or the deal causes the proposal revision number

3877

# to auto-increment. The buyer keeps track of the last revision number they

3878

# know of and pass it in when making an update. If the head revision number

3879

# on the server has since incremented, then an ABORTED error is returned

3880

# during the update operation to let the buyer know that a subsequent update

3881

# was made.

3882

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

3883

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3884

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3885

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3886

#

3887

# Note: This field may be set only when creating the resource. Modifying

3888

# this field while updating the resource will result in an error.

3889

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3890

"subAccountId": "A String", # Optional sub-account ID for the seller.

3891

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3892

# The seller account ID is then available to buyer in the product.

3893

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3894

"buyerContacts": [ # Contact information for the buyer.

3895

{ # Contains information on how a buyer or seller can be reached.

3896

"name": "A String", # The name of the contact.

3897

"email": "A String", # Email address for the contact.

3898

},

3899

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3900

"displayName": "A String", # The name for the proposal.

3901

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3902

# left a comment.

3903

"proposalId": "A String", # Output only. The unique ID of the proposal.

3904

"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.

3905

# Authorized Buyers account ID.

3906

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3907

},

3908

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3909

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3910

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3911

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3912

# operations (max-length: 1024 unicode code units).

3913

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3914

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3915

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3916

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3917

#

3918

# Note: This field may be set only when creating the resource. Modifying

3919

# this field while updating the resource will result in an error.

3920

# Authorized Buyers account ID.

3921

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3922

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3927

<code class="details" id="list">list(accountId, filter=None, pageSize=None, filterSyntax=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3928

<pre>List proposals. A filter expression (PQL query) may be specified to

3929

filter the results. To retrieve all finalized proposals, regardless if a

3930

proposal is being renegotiated, see the FinalizedProposals resource.

3931

Note that Bidder/ChildSeat relationships differ from the usual behavior.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3932

A Bidder account can only see its child seats' proposals by specifying

3933

the ChildSeat's accountId in the request path.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3934

3935

Args:

3936

accountId: string, Account ID of the buyer. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3937

filter: string, An optional PQL filter query used to query for proposals.

3938

3939

Nested repeated fields, such as proposal.deals.targetingCriterion,

3940

cannot be filtered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

pageSize: integer, Requested page size. The server may return fewer results than requested.

3942

If unspecified, the server will pick an appropriate default.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3943

filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL

3944

but in the future it will be LIST_FILTER.

3945

pageToken: string, The page token as returned from ListProposalsResponse.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3946

x__xgafv: string, V1 error format.

3947

Allowed values

3948

1 - v1 error format

3949

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3950

3951

Returns:

3952

An object of the form:

3953

3954

{ # Response message for listing proposals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3955

"proposals": [ # The list of proposals.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3956

{ # Note: this resource requires whitelisting for access. Please contact your

3957

# account manager for access to Marketplace resources.

3958

#

3959

# Represents a proposal in the Marketplace. A proposal is the unit of

3960

# negotiation between a seller and a buyer and contains deals which

3961

# are served.

3962

#

3963

# Note: you can not update, create, or otherwise modify Private

3964

# Auction or Preferred Deals deals through the API.

3965

#

3966

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3967

"notes": [ # Output only. The notes associated with this proposal.

3968

{ # A proposal may be associated to several notes.

3969

"createTime": "A String", # Output only. The timestamp for when this note was created.

3970

"noteId": "A String", # Output only. The unique ID for the note.

3971

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3972

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3973

"note": "A String", # The actual note to attach.

3974

# (max-length: 1024 unicode code units)

3975

#

3976

# Note: This field may be set only when creating the resource. Modifying

3977

# this field while updating the resource will result in an error.

3978

},

3979

],

3980

"sellerContacts": [ # Output only. Contact information for the seller.

3981

{ # Contains information on how a buyer or seller can be reached.

3982

"name": "A String", # The name of the contact.

3983

"email": "A String", # Email address for the contact.

3984

},

3985

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3986

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3987

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3988

{ # A deal represents a segment of inventory for displaying ads on.

3989

# A proposal can contain multiple deals. A deal contains the terms and

3990

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3991

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3992

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3993

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3994

# target ad inventory. For example, they can choose to target ad requests only

3995

# if the user is in the US.

3996

# Multiple types of targeting are always applied as a logical AND, unless noted

3997

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3998

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3999

"excludedPositionTypes": [ # A list of video positions to be excluded.

4000

# Position types can either be included or excluded (XOR).

4001

"A String",

4002

],

4003

"targetedPositionTypes": [ # A list of video positions to be included.

4004

# When the included list is present, the excluded list must be empty.

4005

# When the excluded list is present, the included list must be empty.

4006

"A String",

4007

],

4008

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

4010

# mobile applications.

4011

# Different placement targeting types will be logically OR'ed.

4012

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4013

# For Private Auction and AdX Preferred Deals, URLs are either included or

4014

# excluded.

4015

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4016

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4017

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4018

"A String",

4019

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4020

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4025

# This doesn't apply to Auction Packages.

4026

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4027

# display the ads in.

4028

# publishers own.

4029

# Mobile application IDs are from App Store and Google Play Store.

4030

# Android App ID, for example, com.google.android.apps.maps, can be found in

4031

# Google Play Store URL.

4032

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4033

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4034

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4035

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4036

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4037

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4038

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4043

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4044

# included and excluded numeric IDs.

4045

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4046

"A String",

4047

],

4048

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4049

"A String",

4050

],

4051

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4052

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

4053

# request. It only applies to Private Auction, AdX Preferred Deals and

4054

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4055

# and Preferred Deals in Ad Manager.

4056

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4057

{ # Represents size of a single ad slot, or a creative.

4058

"width": "A String", # The width of the ad slot in pixels.

4059

# This field will be present only when size type is `PIXEL`.

4060

"sizeType": "A String", # The size type of the ad slot.

4061

"height": "A String", # The height of the ad slot in pixels.

4062

# This field will be present only when size type is `PIXEL`.

4063

},

4064

],

4065

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4066

{ # Represents size of a single ad slot, or a creative.

4067

"width": "A String", # The width of the ad slot in pixels.

4068

# This field will be present only when size type is `PIXEL`.

4069

"sizeType": "A String", # The size type of the ad slot.

4070

"height": "A String", # The height of the ad slot in pixels.

4071

# This field will be present only when size type is `PIXEL`.

4072

},

4073

],

4074

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4075

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4076

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4077

# included and excluded numeric IDs.

4078

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4079

"A String",

4080

],

4081

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

4086

# included and excluded numeric IDs.

4087

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4088

"A String",

4089

],

4090

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4091

"A String",

4092

],

4093

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4094

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4095

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4096

# included and excluded numeric IDs.

4097

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4098

"A String",

4099

],

4100

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

4105

# included and excluded numeric IDs.

4106

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4107

"A String",

4108

],

4109

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4114

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4115

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4116

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4117

# deal.

4118

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4119

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4120

# in Ad Manager.

4121

# Preferred Deal in Ad Manager.

4122

# This doesn't apply to Private Auction and AdX Preferred Deals.

4123

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4124

"creativeSpecifications": [

4125

{ # Represents information for a creative that is associated with a Programmatic

4126

# Guaranteed/Preferred Deal in Ad Manager.

4127

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4128

"width": "A String", # The width of the ad slot in pixels.

4129

# This field will be present only when size type is `PIXEL`.

4130

"sizeType": "A String", # The size type of the ad slot.

4131

"height": "A String", # The height of the ad slot in pixels.

4132

# This field will be present only when size type is `PIXEL`.

4133

},

4134

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4135

{ # Represents size of a single ad slot, or a creative.

4136

"width": "A String", # The width of the ad slot in pixels.

4137

# This field will be present only when size type is `PIXEL`.

4138

"sizeType": "A String", # The size type of the ad slot.

4139

"height": "A String", # The height of the ad slot in pixels.

4140

# This field will be present only when size type is `PIXEL`.

4141

},

4142

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4143

},

4144

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4145

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4146

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4147

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

4148

# If present on create, and the server `product_revision` has advanced sinced

4149

# the passed-in `create_product_revision`, an `ABORTED` error will be

4150

# returned.

4151

#

4152

# Note: This field may be set only when creating the resource. Modifying

4153

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4154

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4155

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4156

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4157

# operations (max-length: 1024 unicode code units).

4158

},

4159

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4160

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

4161

# The deal is considered paused if either hasBuyerPaused or

4162

# hasSellPaused is true.

4163

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4164

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4165

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

4166

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

4167

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4168

},

4169

},

4170

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4171

# finalized. This is the deal ID that shows up in serving/reporting etc.

4172

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4173

# PUBLISHER means creative is provided by seller and ADVERTISER means

4174

# creative is provided by buyer.

4175

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

4176

# This will generally be stored in the granularity of one second since deal

4177

# serving starts at seconds boundary. Any time specified with more

4178

# granularity (e.g., in milliseconds) will be truncated towards the start of

4179

# time in seconds.

4180

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4181

"sellerContacts": [ # Output only. Seller contact information for the deal.

4182

{ # Contains information on how a buyer or seller can be reached.

4183

"name": "A String", # The name of the contact.

4184

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4185

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4186

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4187

"createProductId": "A String", # The product ID from which this deal was created.

4188

#

4189

# Note: This field may be set only when creating the resource. Modifying

4190

# this field while updating the resource will result in an error.

4191

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4192

"syndicationProduct": "A String", # The syndication product associated with the deal.

4193

#

4194

# Note: This field may be set only when creating the resource. Modifying

4195

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4196

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4197

"createTime": "A String", # Output only. The time of the deal creation.

4198

"description": "A String", # Description for the deal terms.

4199

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

4200

# to see but are non-negotiable. These are set by the publisher.

4201

"frequencyCaps": [ # Output only. Specifies any frequency caps.

4202

{ # Frequency cap.

4203

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4204

# which impressions per user are counted and capped.

4205

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

4206

# specified time period.

4207

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

4208

# amount of time over which impressions per user are counted and capped.

4209

},

4210

],

4211

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

4212

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

4213

},

4214

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4215

# targeting entity is AND'd together.

4216

{ # Advertisers can target different attributes of an ad slot. For example,

4217

# they can choose to show ads only if the user is in the U.S. Such

4218

# targeting criteria can be specified as part of Shared Targeting.

4219

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4220

# together.

4221

{ # A polymorphic targeting value used as part of Shared Targeting.

4222

"longValue": "A String", # The long value to include/exclude.

4223

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4224

# Filled in when the key is GOOG_DAYPART_TARGETING.

4225

# The definition of this targeting is derived from the structure

4226

# used by Ad Manager.

4227

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4228

"dayParts": [ # A list of day part targeting criterion.

4229

{ # Daypart targeting message that specifies if the ad can be shown

4230

# only during certain parts of a day/week.

4231

"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

4232

# granularity). The end time is exclusive. This field is not available

4233

# for filtering in PQL queries.

4234

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4235

# types are google.type.Date and `google.protobuf.Timestamp`.

4236

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4237

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4238

# allow the value 60 if it allows leap-seconds.

4239

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4240

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4241

# to allow the value "24:00:00" for scenarios like business closing time.

4242

},

4243

"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).

4244

# The start time is inclusive.

4245

# This field is not available for filtering in PQL queries.

4246

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4247

# types are google.type.Date and `google.protobuf.Timestamp`.

4248

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4249

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4250

# allow the value 60 if it allows leap-seconds.

4251

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4252

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4253

# to allow the value "24:00:00" for scenarios like business closing time.

4254

},

4255

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4260

# Filled in when key = GOOG_CREATIVE_SIZE

4261

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4262

# Companion sizes may be filled in only when creative_size_type = VIDEO

4263

{ # Message depicting the size of the creative. The units of width and

4264

# height depend on the type of the targeting.

4265

"height": 42, # The height of the creative.

4266

"width": 42, # The width of the creative

4267

},

4268

],

4269

"creativeSizeType": "A String", # The creative size type.

4270

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4271

# creative_size_type = CreativeSizeType.VIDEO.

4272

"allowedFormats": [ # What formats are allowed by the publisher.

4273

# If this repeated field is empty then all formats are allowed.

4274

# For example, if this field contains AllowedFormatType.AUDIO then the

4275

# publisher only allows an audio ad (without any video).

4276

"A String",

4277

],

4278

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4279

# of the creative

4280

# height depend on the type of the targeting.

4281

"height": 42, # The height of the creative.

4282

"width": 42, # The width of the creative

4283

},

4284

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4285

# only if creative_size_type = CreativeSizeType.NATIVE.

4286

},

4287

"stringValue": "A String", # The string value to include/exclude.

4288

},

4289

],

4290

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4291

# together.

4292

{ # A polymorphic targeting value used as part of Shared Targeting.

4293

"longValue": "A String", # The long value to include/exclude.

4294

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4295

# Filled in when the key is GOOG_DAYPART_TARGETING.

4296

# The definition of this targeting is derived from the structure

4297

# used by Ad Manager.

4298

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4299

"dayParts": [ # A list of day part targeting criterion.

4300

{ # Daypart targeting message that specifies if the ad can be shown

4301

# only during certain parts of a day/week.

4302

"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

4303

# granularity). The end time is exclusive. This field is not available

4304

# for filtering in PQL queries.

4305

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4306

# types are google.type.Date and `google.protobuf.Timestamp`.

4307

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4308

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4309

# allow the value 60 if it allows leap-seconds.

4310

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4311

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4312

# to allow the value "24:00:00" for scenarios like business closing time.

4313

},

4314

"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).

4315

# The start time is inclusive.

4316

# This field is not available for filtering in PQL queries.

4317

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4318

# types are google.type.Date and `google.protobuf.Timestamp`.

4319

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4320

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4321

# allow the value 60 if it allows leap-seconds.

4322

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4323

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4324

# to allow the value "24:00:00" for scenarios like business closing time.

4325

},

4326

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4331

# Filled in when key = GOOG_CREATIVE_SIZE

4332

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4333

# Companion sizes may be filled in only when creative_size_type = VIDEO

4334

{ # Message depicting the size of the creative. The units of width and

4335

# height depend on the type of the targeting.

4336

"height": 42, # The height of the creative.

4337

"width": 42, # The width of the creative

4338

},

4339

],

4340

"creativeSizeType": "A String", # The creative size type.

4341

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4342

# creative_size_type = CreativeSizeType.VIDEO.

4343

"allowedFormats": [ # What formats are allowed by the publisher.

4344

# If this repeated field is empty then all formats are allowed.

4345

# For example, if this field contains AllowedFormatType.AUDIO then the

4346

# publisher only allows an audio ad (without any video).

4347

"A String",

4348

],

4349

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4350

# of the creative

4351

# height depend on the type of the targeting.

4352

"height": 42, # The height of the creative.

4353

"width": 42, # The width of the creative

4354

},

4355

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4356

# only if creative_size_type = CreativeSizeType.NATIVE.

4357

},

4358

"stringValue": "A String", # The string value to include/exclude.

4359

},

4360

],

4361

"key": "A String", # The key representing the shared targeting criterion.

4362

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4363

# Third parties may define their own keys.

4364

# A list of permissible keys along with the acceptable values will be

4365

# provided as part of the external documentation.

4366

},

4367

],

4368

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4369

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4370

# and expected impressions from the publisher.

4371

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4372

# Can be set by buyer or seller.

4373

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

4374

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4375

# the API at this time, but can be returned in a get or list request.

4376

"fixedPrices": [ # Fixed price for the specified buyer.

4377

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4378

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4379

# a particular buyer or buyer/advertiser pair, we look for the most specific

4380

# matching rule - we first look for a rule matching the buyer and advertiser,

4381

# next a rule with the buyer but an empty advertiser list, and otherwise look

4382

# for a matching rule where no buyer is set.

4383

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4384

# If empty, all advertisers with this buyer pay this price.

4385

"A String",

4386

],

4387

"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

4388

# (if the

4389

# advertisers match, and there's no more specific rule matching the buyer).

4390

# Authorized Buyers account ID.

4391

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4392

},

4393

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4394

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4395

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4396

"units": "A String", # The whole units of the amount.

4397

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4398

"nanos": 42, # Number of nano (10^-9) units of the amount.

4399

# The value must be between -999,999,999 and +999,999,999 inclusive.

4400

# If `units` is positive, `nanos` must be positive or zero.

4401

# If `units` is zero, `nanos` can be positive, zero, or negative.

4402

# If `units` is negative, `nanos` must be negative or zero.

4403

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4404

"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.

4411

# Can be set by buyer or seller.

4412

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4413

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4414

"units": "A String", # The whole units of the amount.

4415

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4416

"nanos": 42, # Number of nano (10^-9) units of the amount.

4417

# The value must be between -999,999,999 and +999,999,999 inclusive.

4418

# If `units` is positive, `nanos` must be positive or zero.

4419

# If `units` is zero, `nanos` can be positive, zero, or negative.

4420

# If `units` is negative, `nanos` must be negative or zero.

4421

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4422

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4423

},

4424

},

4425

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4426

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4427

# of guaranteed looks that the buyer is guaranteeing to buy.

4428

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4429

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

4430

"fixedPrices": [ # Fixed price for the specified buyer.

4431

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4432

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4433

# a particular buyer or buyer/advertiser pair, we look for the most specific

4434

# matching rule - we first look for a rule matching the buyer and advertiser,

4435

# next a rule with the buyer but an empty advertiser list, and otherwise look

4436

# for a matching rule where no buyer is set.

4437

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4438

# If empty, all advertisers with this buyer pay this price.

4439

"A String",

4440

],

4441

"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

4442

# (if the

4443

# advertisers match, and there's no more specific rule matching the buyer).

4444

# Authorized Buyers account ID.

4445

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4446

},

4447

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4448

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4449

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4450

"units": "A String", # The whole units of the amount.

4451

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4452

"nanos": 42, # Number of nano (10^-9) units of the amount.

4453

# The value must be between -999,999,999 and +999,999,999 inclusive.

4454

# If `units` is positive, `nanos` must be positive or zero.

4455

# If `units` is zero, `nanos` can be positive, zero, or negative.

4456

# If `units` is negative, `nanos` must be negative or zero.

4457

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4458

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4465

# by the seller, but they can be returned in a get or list request.

4466

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4467

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4468

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4469

# a particular buyer or buyer/advertiser pair, we look for the most specific

4470

# matching rule - we first look for a rule matching the buyer and advertiser,

4471

# next a rule with the buyer but an empty advertiser list, and otherwise look

4472

# for a matching rule where no buyer is set.

4473

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4474

# If empty, all advertisers with this buyer pay this price.

4475

"A String",

4476

],

4477

"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

4478

# (if the

4479

# advertisers match, and there's no more specific rule matching the buyer).

4480

# Authorized Buyers account ID.

4481

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4482

},

4483

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4484

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4485

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4486

"units": "A String", # The whole units of the amount.

4487

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4488

"nanos": 42, # Number of nano (10^-9) units of the amount.

4489

# The value must be between -999,999,999 and +999,999,999 inclusive.

4490

# If `units` is positive, `nanos` must be positive or zero.

4491

# If `units` is zero, `nanos` can be positive, zero, or negative.

4492

# If `units` is negative, `nanos` must be negative or zero.

4493

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4494

"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

4500

# in this private auction.

4501

},

4502

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4503

# time zone used to mark the boundaries of a day. It should be an

4504

# IANA TZ name, such as "America/Los_Angeles". For more information,

4505

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

4506

"description": "A String", # Publisher provided description for the terms.

4507

},

4508

"availableEndTime": "A String", # Proposed flight end time of the deal.

4509

# This will generally be stored in a granularity of a second.

4510

# A value is not required for Private Auction deals or Preferred Deals.

4511

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4512

},

4513

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4514

"proposalState": "A String", # Output only. The current state of the proposal.

4515

"proposalRevision": "A String", # Output only. The revision number for the proposal.

4516

# Each update to the proposal or the deal causes the proposal revision number

4517

# to auto-increment. The buyer keeps track of the last revision number they

4518

# know of and pass it in when making an update. If the head revision number

4519

# on the server has since incremented, then an ABORTED error is returned

4520

# during the update operation to let the buyer know that a subsequent update

4521

# was made.

4522

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

4523

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4524

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4525

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4526

#

4527

# Note: This field may be set only when creating the resource. Modifying

4528

# this field while updating the resource will result in an error.

4529

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4530

"subAccountId": "A String", # Optional sub-account ID for the seller.

4531

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4532

# The seller account ID is then available to buyer in the product.

4533

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4534

"buyerContacts": [ # Contact information for the buyer.

4535

{ # Contains information on how a buyer or seller can be reached.

4536

"name": "A String", # The name of the contact.

4537

"email": "A String", # Email address for the contact.

4538

},

4539

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4540

"displayName": "A String", # The name for the proposal.

4541

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

4542

# left a comment.

4543

"proposalId": "A String", # Output only. The unique ID of the proposal.

4544

"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.

4545

# Authorized Buyers account ID.

4546

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4547

},

4548

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

4549

"updateTime": "A String", # Output only. The time when the proposal was last revised.

4550

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

4551

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4552

# operations (max-length: 1024 unicode code units).

4553

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4554

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

4555

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4556

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

4557

#

4558

# Note: This field may be set only when creating the resource. Modifying

4559

# this field while updating the resource will result in an error.

4560

# Authorized Buyers account ID.

4561

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4562

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4563

},

4564

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4565

"nextPageToken": "A String", # Continuation token for fetching the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4571

<pre>Retrieves the next page of results.

4572

4573

Args:

4574

previous_request: The request for the previous page. (required)

4575

previous_response: The response from the request for the previous page. (required)

4576

4577

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4578

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4579

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4584

<code class="details" id="pause">pause(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4585

<pre>Update the given proposal to pause serving.

4586

This method will set the

4587

`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all

4588

deals in the proposal.

4589

4590

It is a no-op to pause an already-paused proposal.

4591

It is an error to call PauseProposal for a proposal that is not

4592

finalized or renegotiating.

4593

4594

Args:

4595

accountId: string, Account ID of the buyer. (required)

4596

proposalId: string, The ID of the proposal to pause. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4597

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4598

The object takes the form of:

4599

4600

{ # Request message to pause serving for an already-finalized proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4601

"reason": "A String", # The reason why the proposal is being paused.

4602

# This human readable message will be displayed in the seller's UI.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4603

# (Max length: 1000 unicode code units.)

4604

}

4605

4606

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4613

4614

{ # Note: this resource requires whitelisting for access. Please contact your

4615

# account manager for access to Marketplace resources.

4616

#

4617

# Represents a proposal in the Marketplace. A proposal is the unit of

4618

# negotiation between a seller and a buyer and contains deals which

4619

# are served.

4620

#

4621

# Note: you can not update, create, or otherwise modify Private

4622

# Auction or Preferred Deals deals through the API.

4623

#

4624

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4625

"notes": [ # Output only. The notes associated with this proposal.

4626

{ # A proposal may be associated to several notes.

4627

"createTime": "A String", # Output only. The timestamp for when this note was created.

4628

"noteId": "A String", # Output only. The unique ID for the note.

4629

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

4630

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

4631

"note": "A String", # The actual note to attach.

4632

# (max-length: 1024 unicode code units)

4633

#

4634

# Note: This field may be set only when creating the resource. Modifying

4635

# this field while updating the resource will result in an error.

4636

},

4637

],

4638

"sellerContacts": [ # Output only. Contact information for the seller.

4639

{ # Contains information on how a buyer or seller can be reached.

4640

"name": "A String", # The name of the contact.

4641

"email": "A String", # Email address for the contact.

4642

},

4643

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4644

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4645

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4646

{ # A deal represents a segment of inventory for displaying ads on.

4647

# A proposal can contain multiple deals. A deal contains the terms and

4648

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4649

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4650

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4651

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4652

# target ad inventory. For example, they can choose to target ad requests only

4653

# if the user is in the US.

4654

# Multiple types of targeting are always applied as a logical AND, unless noted

4655

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4656

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

4657

"excludedPositionTypes": [ # A list of video positions to be excluded.

4658

# Position types can either be included or excluded (XOR).

4659

"A String",

4660

],

4661

"targetedPositionTypes": [ # A list of video positions to be included.

4662

# When the included list is present, the excluded list must be empty.

4663

# When the excluded list is present, the included list must be empty.

4664

"A String",

4665

],

4666

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4667

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

4668

# mobile applications.

4669

# Different placement targeting types will be logically OR'ed.

4670

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4671

# For Private Auction and AdX Preferred Deals, URLs are either included or

4672

# excluded.

4673

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4674

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4675

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4676

"A String",

4677

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4678

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4683

# This doesn't apply to Auction Packages.

4684

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4685

# display the ads in.

4686

# publishers own.

4687

# Mobile application IDs are from App Store and Google Play Store.

4688

# Android App ID, for example, com.google.android.apps.maps, can be found in

4689

# Google Play Store URL.

4690

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4691

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4692

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4693

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4694

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4695

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4696

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4701

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4702

# included and excluded numeric IDs.

4703

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4704

"A String",

4705

],

4706

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4707

"A String",

4708

],

4709

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4710

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

4711

# request. It only applies to Private Auction, AdX Preferred Deals and

4712

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4713

# and Preferred Deals in Ad Manager.

4714

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4715

{ # Represents size of a single ad slot, or a creative.

4716

"width": "A String", # The width of the ad slot in pixels.

4717

# This field will be present only when size type is `PIXEL`.

4718

"sizeType": "A String", # The size type of the ad slot.

4719

"height": "A String", # The height of the ad slot in pixels.

4720

# This field will be present only when size type is `PIXEL`.

4721

},

4722

],

4723

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4724

{ # Represents size of a single ad slot, or a creative.

4725

"width": "A String", # The width of the ad slot in pixels.

4726

# This field will be present only when size type is `PIXEL`.

4727

"sizeType": "A String", # The size type of the ad slot.

4728

"height": "A String", # The height of the ad slot in pixels.

4729

# This field will be present only when size type is `PIXEL`.

4730

},

4731

],

4732

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4733

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4734

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4735

# included and excluded numeric IDs.

4736

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4737

"A String",

4738

],

4739

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

4744

# included and excluded numeric IDs.

4745

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4746

"A String",

4747

],

4748

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

4749

"A String",

4750

],

4751

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4752

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4753

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4754

# included and excluded numeric IDs.

4755

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4756

"A String",

4757

],

4758

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

4763

# included and excluded numeric IDs.

4764

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4765

"A String",

4766

],

4767

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4772

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4773

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4774

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4775

# deal.

4776

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4777

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4778

# in Ad Manager.

4779

# Preferred Deal in Ad Manager.

4780

# This doesn't apply to Private Auction and AdX Preferred Deals.

4781

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4782

"creativeSpecifications": [

4783

{ # Represents information for a creative that is associated with a Programmatic

4784

# Guaranteed/Preferred Deal in Ad Manager.

4785

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4786

"width": "A String", # The width of the ad slot in pixels.

4787

# This field will be present only when size type is `PIXEL`.

4788

"sizeType": "A String", # The size type of the ad slot.

4789

"height": "A String", # The height of the ad slot in pixels.

4790

# This field will be present only when size type is `PIXEL`.

4791

},

4792

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4793

{ # Represents size of a single ad slot, or a creative.

4794

"width": "A String", # The width of the ad slot in pixels.

4795

# This field will be present only when size type is `PIXEL`.

4796

"sizeType": "A String", # The size type of the ad slot.

4797

"height": "A String", # The height of the ad slot in pixels.

4798

# This field will be present only when size type is `PIXEL`.

4799

},

4800

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4801

},

4802

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4803

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4804

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4805

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

4806

# If present on create, and the server `product_revision` has advanced sinced

4807

# the passed-in `create_product_revision`, an `ABORTED` error will be

4808

# returned.

4809

#

4810

# Note: This field may be set only when creating the resource. Modifying

4811

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4812

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4813

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4814

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4815

# operations (max-length: 1024 unicode code units).

4816

},

4817

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4818

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

4819

# The deal is considered paused if either hasBuyerPaused or

4820

# hasSellPaused is true.

4821

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4822

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4823

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

4824

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

4825

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4826

},

4827

},

4828

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4829

# finalized. This is the deal ID that shows up in serving/reporting etc.

4830

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4831

# PUBLISHER means creative is provided by seller and ADVERTISER means

4832

# creative is provided by buyer.

4833

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

4834

# This will generally be stored in the granularity of one second since deal

4835

# serving starts at seconds boundary. Any time specified with more

4836

# granularity (e.g., in milliseconds) will be truncated towards the start of

4837

# time in seconds.

4838

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4839

"sellerContacts": [ # Output only. Seller contact information for the deal.

4840

{ # Contains information on how a buyer or seller can be reached.

4841

"name": "A String", # The name of the contact.

4842

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4843

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4844

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4845

"createProductId": "A String", # The product ID from which this deal was created.

4846

#

4847

# Note: This field may be set only when creating the resource. Modifying

4848

# this field while updating the resource will result in an error.

4849

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4850

"syndicationProduct": "A String", # The syndication product associated with the deal.

4851

#

4852

# Note: This field may be set only when creating the resource. Modifying

4853

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4854

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4855

"createTime": "A String", # Output only. The time of the deal creation.

4856

"description": "A String", # Description for the deal terms.

4857

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

4858

# to see but are non-negotiable. These are set by the publisher.

4859

"frequencyCaps": [ # Output only. Specifies any frequency caps.

4860

{ # Frequency cap.

4861

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4862

# which impressions per user are counted and capped.

4863

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

4864

# specified time period.

4865

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

4866

# amount of time over which impressions per user are counted and capped.

4867

},

4868

],

4869

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

4870

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

4871

},

4872

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4873

# targeting entity is AND'd together.

4874

{ # Advertisers can target different attributes of an ad slot. For example,

4875

# they can choose to show ads only if the user is in the U.S. Such

4876

# targeting criteria can be specified as part of Shared Targeting.

4877

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4878

# together.

4879

{ # A polymorphic targeting value used as part of Shared Targeting.

4880

"longValue": "A String", # The long value to include/exclude.

4881

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4882

# Filled in when the key is GOOG_DAYPART_TARGETING.

4883

# The definition of this targeting is derived from the structure

4884

# used by Ad Manager.

4885

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4886

"dayParts": [ # A list of day part targeting criterion.

4887

{ # Daypart targeting message that specifies if the ad can be shown

4888

# only during certain parts of a day/week.

4889

"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

4890

# granularity). The end time is exclusive. This field is not available

4891

# for filtering in PQL queries.

4892

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4893

# types are google.type.Date and `google.protobuf.Timestamp`.

4894

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4895

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4896

# allow the value 60 if it allows leap-seconds.

4897

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4898

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4899

# to allow the value "24:00:00" for scenarios like business closing time.

4900

},

4901

"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).

4902

# The start time is inclusive.

4903

# This field is not available for filtering in PQL queries.

4904

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4905

# types are google.type.Date and `google.protobuf.Timestamp`.

4906

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4907

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4908

# allow the value 60 if it allows leap-seconds.

4909

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4910

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4911

# to allow the value "24:00:00" for scenarios like business closing time.

4912

},

4913

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4918

# Filled in when key = GOOG_CREATIVE_SIZE

4919

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4920

# Companion sizes may be filled in only when creative_size_type = VIDEO

4921

{ # Message depicting the size of the creative. The units of width and

4922

# height depend on the type of the targeting.

4923

"height": 42, # The height of the creative.

4924

"width": 42, # The width of the creative

4925

},

4926

],

4927

"creativeSizeType": "A String", # The creative size type.

4928

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4929

# creative_size_type = CreativeSizeType.VIDEO.

4930

"allowedFormats": [ # What formats are allowed by the publisher.

4931

# If this repeated field is empty then all formats are allowed.

4932

# For example, if this field contains AllowedFormatType.AUDIO then the

4933

# publisher only allows an audio ad (without any video).

4934

"A String",

4935

],

4936

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4937

# of the creative

4938

# height depend on the type of the targeting.

4939

"height": 42, # The height of the creative.

4940

"width": 42, # The width of the creative

4941

},

4942

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4943

# only if creative_size_type = CreativeSizeType.NATIVE.

4944

},

4945

"stringValue": "A String", # The string value to include/exclude.

4946

},

4947

],

4948

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4949

# together.

4950

{ # A polymorphic targeting value used as part of Shared Targeting.

4951

"longValue": "A String", # The long value to include/exclude.

4952

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4953

# Filled in when the key is GOOG_DAYPART_TARGETING.

4954

# The definition of this targeting is derived from the structure

4955

# used by Ad Manager.

4956

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4957

"dayParts": [ # A list of day part targeting criterion.

4958

{ # Daypart targeting message that specifies if the ad can be shown

4959

# only during certain parts of a day/week.

4960

"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

4961

# granularity). The end time is exclusive. This field is not available

4962

# for filtering in PQL queries.

4963

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4964

# types are google.type.Date and `google.protobuf.Timestamp`.

4965

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4966

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4967

# allow the value 60 if it allows leap-seconds.

4968

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4969

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4970

# to allow the value "24:00:00" for scenarios like business closing time.

4971

},

4972

"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).

4973

# The start time is inclusive.

4974

# This field is not available for filtering in PQL queries.

4975

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4976

# types are google.type.Date and `google.protobuf.Timestamp`.

4977

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4978

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4979

# allow the value 60 if it allows leap-seconds.

4980

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4981

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4982

# to allow the value "24:00:00" for scenarios like business closing time.

4983

},

4984

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4989

# Filled in when key = GOOG_CREATIVE_SIZE

4990

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4991

# Companion sizes may be filled in only when creative_size_type = VIDEO

4992

{ # Message depicting the size of the creative. The units of width and

4993

# height depend on the type of the targeting.

4994

"height": 42, # The height of the creative.

4995

"width": 42, # The width of the creative

4996

},

4997

],

4998

"creativeSizeType": "A String", # The creative size type.

4999

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5000

# creative_size_type = CreativeSizeType.VIDEO.

5001

"allowedFormats": [ # What formats are allowed by the publisher.

5002

# If this repeated field is empty then all formats are allowed.

5003

# For example, if this field contains AllowedFormatType.AUDIO then the

5004

# publisher only allows an audio ad (without any video).

5005

"A String",

5006

],

5007

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5008

# of the creative

5009

# height depend on the type of the targeting.

5010

"height": 42, # The height of the creative.

5011

"width": 42, # The width of the creative

5012

},

5013

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5014

# only if creative_size_type = CreativeSizeType.NATIVE.

5015

},

5016

"stringValue": "A String", # The string value to include/exclude.

5017

},

5018

],

5019

"key": "A String", # The key representing the shared targeting criterion.

5020

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5021

# Third parties may define their own keys.

5022

# A list of permissible keys along with the acceptable values will be

5023

# provided as part of the external documentation.

5024

},

5025

],

5026

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

5027

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

5028

# and expected impressions from the publisher.

5029

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

5030

# Can be set by buyer or seller.

5031

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

5032

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

5033

# the API at this time, but can be returned in a get or list request.

5034

"fixedPrices": [ # Fixed price for the specified buyer.

5035

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5036

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5037

# a particular buyer or buyer/advertiser pair, we look for the most specific

5038

# matching rule - we first look for a rule matching the buyer and advertiser,

5039

# next a rule with the buyer but an empty advertiser list, and otherwise look

5040

# for a matching rule where no buyer is set.

5041

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5042

# If empty, all advertisers with this buyer pay this price.

5043

"A String",

5044

],

5045

"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

5046

# (if the

5047

# advertisers match, and there's no more specific rule matching the buyer).

5048

# Authorized Buyers account ID.

5049

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5050

},

5051

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5052

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5053

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5054

"units": "A String", # The whole units of the amount.

5055

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5056

"nanos": 42, # Number of nano (10^-9) units of the amount.

5057

# The value must be between -999,999,999 and +999,999,999 inclusive.

5058

# If `units` is positive, `nanos` must be positive or zero.

5059

# If `units` is zero, `nanos` can be positive, zero, or negative.

5060

# If `units` is negative, `nanos` must be negative or zero.

5061

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5062

"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.

5069

# Can be set by buyer or seller.

5070

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5071

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5072

"units": "A String", # The whole units of the amount.

5073

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5074

"nanos": 42, # Number of nano (10^-9) units of the amount.

5075

# The value must be between -999,999,999 and +999,999,999 inclusive.

5076

# If `units` is positive, `nanos` must be positive or zero.

5077

# If `units` is zero, `nanos` can be positive, zero, or negative.

5078

# If `units` is negative, `nanos` must be negative or zero.

5079

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5080

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5081

},

5082

},

5083

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

5084

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

5085

# of guaranteed looks that the buyer is guaranteeing to buy.

5086

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

5087

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

5088

"fixedPrices": [ # Fixed price for the specified buyer.

5089

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5090

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5091

# a particular buyer or buyer/advertiser pair, we look for the most specific

5092

# matching rule - we first look for a rule matching the buyer and advertiser,

5093

# next a rule with the buyer but an empty advertiser list, and otherwise look

5094

# for a matching rule where no buyer is set.

5095

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5096

# If empty, all advertisers with this buyer pay this price.

5097

"A String",

5098

],

5099

"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

5100

# (if the

5101

# advertisers match, and there's no more specific rule matching the buyer).

5102

# Authorized Buyers account ID.

5103

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5104

},

5105

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5106

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5107

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5108

"units": "A String", # The whole units of the amount.

5109

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5110

"nanos": 42, # Number of nano (10^-9) units of the amount.

5111

# The value must be between -999,999,999 and +999,999,999 inclusive.

5112

# If `units` is positive, `nanos` must be positive or zero.

5113

# If `units` is zero, `nanos` can be positive, zero, or negative.

5114

# If `units` is negative, `nanos` must be negative or zero.

5115

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5116

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

5123

# by the seller, but they can be returned in a get or list request.

5124

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

5125

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5126

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5127

# a particular buyer or buyer/advertiser pair, we look for the most specific

5128

# matching rule - we first look for a rule matching the buyer and advertiser,

5129

# next a rule with the buyer but an empty advertiser list, and otherwise look

5130

# for a matching rule where no buyer is set.

5131

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5132

# If empty, all advertisers with this buyer pay this price.

5133

"A String",

5134

],

5135

"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

5136

# (if the

5137

# advertisers match, and there's no more specific rule matching the buyer).

5138

# Authorized Buyers account ID.

5139

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5140

},

5141

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5142

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5143

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5144

"units": "A String", # The whole units of the amount.

5145

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5146

"nanos": 42, # Number of nano (10^-9) units of the amount.

5147

# The value must be between -999,999,999 and +999,999,999 inclusive.

5148

# If `units` is positive, `nanos` must be positive or zero.

5149

# If `units` is zero, `nanos` can be positive, zero, or negative.

5150

# If `units` is negative, `nanos` must be negative or zero.

5151

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5152

"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

5158

# in this private auction.

5159

},

5160

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

5161

# time zone used to mark the boundaries of a day. It should be an

5162

# IANA TZ name, such as "America/Los_Angeles". For more information,

5163

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

5164

"description": "A String", # Publisher provided description for the terms.

5165

},

5166

"availableEndTime": "A String", # Proposed flight end time of the deal.

5167

# This will generally be stored in a granularity of a second.

5168

# A value is not required for Private Auction deals or Preferred Deals.

5169

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5170

},

5171

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5172

"proposalState": "A String", # Output only. The current state of the proposal.

5173

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5174

# Each update to the proposal or the deal causes the proposal revision number

5175

# to auto-increment. The buyer keeps track of the last revision number they

5176

# know of and pass it in when making an update. If the head revision number

5177

# on the server has since incremented, then an ABORTED error is returned

5178

# during the update operation to let the buyer know that a subsequent update

5179

# was made.

5180

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5181

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5182

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5183

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5184

#

5185

# Note: This field may be set only when creating the resource. Modifying

5186

# this field while updating the resource will result in an error.

5187

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5188

"subAccountId": "A String", # Optional sub-account ID for the seller.

5189

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5190

# The seller account ID is then available to buyer in the product.

5191

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5192

"buyerContacts": [ # Contact information for the buyer.

5193

{ # Contains information on how a buyer or seller can be reached.

5194

"name": "A String", # The name of the contact.

5195

"email": "A String", # Email address for the contact.

5196

},

5197

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5198

"displayName": "A String", # The name for the proposal.

5199

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5200

# left a comment.

5201

"proposalId": "A String", # Output only. The unique ID of the proposal.

5202

"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.

5203

# Authorized Buyers account ID.

5204

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5205

},

5206

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5207

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5208

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5209

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5210

# operations (max-length: 1024 unicode code units).

5211

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5212

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5213

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5214

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5215

#

5216

# Note: This field may be set only when creating the resource. Modifying

5217

# this field while updating the resource will result in an error.

5218

# Authorized Buyers account ID.

5219

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5220

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="resume">resume(accountId, proposalId, body=None, x__xgafv=None)</code>

5226

<pre>Update the given proposal to resume serving.

5227

This method will set the

5228

`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all

5229

deals in the proposal.

5230

5231

Note that if the `has_seller_paused` bit is also set, serving will not

5232

resume until the seller also resumes.

5233

5234

It is a no-op to resume an already-running proposal.

5235

It is an error to call ResumeProposal for a proposal that is not

5236

finalized or renegotiating.

5237

5238

Args:

5239

accountId: string, Account ID of the buyer. (required)

5240

proposalId: string, The ID of the proposal to resume. (required)

5241

body: object, The request body.

5242

The object takes the form of:

5243

5244

{ # Request message to resume (unpause) serving for an already-finalized

# proposal.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5255

5256

{ # Note: this resource requires whitelisting for access. Please contact your

5257

# account manager for access to Marketplace resources.

5258

#

5259

# Represents a proposal in the Marketplace. A proposal is the unit of

5260

# negotiation between a seller and a buyer and contains deals which

5261

# are served.

5262

#

5263

# Note: you can not update, create, or otherwise modify Private

5264

# Auction or Preferred Deals deals through the API.

5265

#

5266

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5267

"notes": [ # Output only. The notes associated with this proposal.

5268

{ # A proposal may be associated to several notes.

5269

"createTime": "A String", # Output only. The timestamp for when this note was created.

5270

"noteId": "A String", # Output only. The unique ID for the note.

5271

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5272

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5273

"note": "A String", # The actual note to attach.

5274

# (max-length: 1024 unicode code units)

5275

#

5276

# Note: This field may be set only when creating the resource. Modifying

5277

# this field while updating the resource will result in an error.

5278

},

5279

],

5280

"sellerContacts": [ # Output only. Contact information for the seller.

5281

{ # Contains information on how a buyer or seller can be reached.

5282

"name": "A String", # The name of the contact.

5283

"email": "A String", # Email address for the contact.

5284

},

5285

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5286

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5287

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5288

{ # A deal represents a segment of inventory for displaying ads on.

5289

# A proposal can contain multiple deals. A deal contains the terms and

5290

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5291

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5292

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5293

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5294

# target ad inventory. For example, they can choose to target ad requests only

5295

# if the user is in the US.

5296

# Multiple types of targeting are always applied as a logical AND, unless noted

5297

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5298

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5299

"excludedPositionTypes": [ # A list of video positions to be excluded.

5300

# Position types can either be included or excluded (XOR).

5301

"A String",

5302

],

5303

"targetedPositionTypes": [ # A list of video positions to be included.

5304

# When the included list is present, the excluded list must be empty.

5305

# When the excluded list is present, the included list must be empty.

5306

"A String",

5307

],

5308

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5309

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

5310

# mobile applications.

5311

# Different placement targeting types will be logically OR'ed.

5312

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5313

# For Private Auction and AdX Preferred Deals, URLs are either included or

5314

# excluded.

5315

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5316

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5317

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5318

"A String",

5319

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5320

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5325

# This doesn't apply to Auction Packages.

5326

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5327

# display the ads in.

5328

# publishers own.

5329

# Mobile application IDs are from App Store and Google Play Store.

5330

# Android App ID, for example, com.google.android.apps.maps, can be found in

5331

# Google Play Store URL.

5332

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5333

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5334

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5335

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5336

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5337

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5338

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5343

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5344

# included and excluded numeric IDs.

5345

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5346

"A String",

5347

],

5348

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5349

"A String",

5350

],

5351

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5352

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

5353

# request. It only applies to Private Auction, AdX Preferred Deals and

5354

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5355

# and Preferred Deals in Ad Manager.

5356

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5357

{ # Represents size of a single ad slot, or a creative.

5358

"width": "A String", # The width of the ad slot in pixels.

5359

# This field will be present only when size type is `PIXEL`.

5360

"sizeType": "A String", # The size type of the ad slot.

5361

"height": "A String", # The height of the ad slot in pixels.

5362

# This field will be present only when size type is `PIXEL`.

5363

},

5364

],

5365

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5366

{ # Represents size of a single ad slot, or a creative.

5367

"width": "A String", # The width of the ad slot in pixels.

5368

# This field will be present only when size type is `PIXEL`.

5369

"sizeType": "A String", # The size type of the ad slot.

5370

"height": "A String", # The height of the ad slot in pixels.

5371

# This field will be present only when size type is `PIXEL`.

5372

},

5373

],

5374

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5375

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5376

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5377

# included and excluded numeric IDs.

5378

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5379

"A String",

5380

],

5381

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

5386

# included and excluded numeric IDs.

5387

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5388

"A String",

5389

],

5390

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5391

"A String",

5392

],

5393

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5394

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5395

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5396

# included and excluded numeric IDs.

5397

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5398

"A String",

5399

],

5400

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

5405

# included and excluded numeric IDs.

5406

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5407

"A String",

5408

],

5409

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5414

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5415

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5416

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5417

# deal.

5418

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

5419

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5420

# in Ad Manager.

5421

# Preferred Deal in Ad Manager.

5422

# This doesn't apply to Private Auction and AdX Preferred Deals.

5423

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

5424

"creativeSpecifications": [

5425

{ # Represents information for a creative that is associated with a Programmatic

5426

# Guaranteed/Preferred Deal in Ad Manager.

5427

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5428

"width": "A String", # The width of the ad slot in pixels.

5429

# This field will be present only when size type is `PIXEL`.

5430

"sizeType": "A String", # The size type of the ad slot.

5431

"height": "A String", # The height of the ad slot in pixels.

5432

# This field will be present only when size type is `PIXEL`.

5433

},

5434

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

5435

{ # Represents size of a single ad slot, or a creative.

5436

"width": "A String", # The width of the ad slot in pixels.

5437

# This field will be present only when size type is `PIXEL`.

5438

"sizeType": "A String", # The size type of the ad slot.

5439

"height": "A String", # The height of the ad slot in pixels.

5440

# This field will be present only when size type is `PIXEL`.

5441

},

5442

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5443

},

5444

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5445

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5446

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5447

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

5448

# If present on create, and the server `product_revision` has advanced sinced

5449

# the passed-in `create_product_revision`, an `ABORTED` error will be

5450

# returned.

5451

#

5452

# Note: This field may be set only when creating the resource. Modifying

5453

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5454

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5455

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5456

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5457

# operations (max-length: 1024 unicode code units).

5458

},

5459

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5460

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

5461

# The deal is considered paused if either hasBuyerPaused or

5462

# hasSellPaused is true.

5463

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5464

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5465

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

5466

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

5467

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5468

},

5469

},

5470

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

5471

# finalized. This is the deal ID that shows up in serving/reporting etc.

5472

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5473

# PUBLISHER means creative is provided by seller and ADVERTISER means

5474

# creative is provided by buyer.

5475

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

5476

# This will generally be stored in the granularity of one second since deal

5477

# serving starts at seconds boundary. Any time specified with more

5478

# granularity (e.g., in milliseconds) will be truncated towards the start of

5479

# time in seconds.

5480

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5481

"sellerContacts": [ # Output only. Seller contact information for the deal.

5482

{ # Contains information on how a buyer or seller can be reached.

5483

"name": "A String", # The name of the contact.

5484

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5485

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5486

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5487

"createProductId": "A String", # The product ID from which this deal was created.

5488

#

5489

# Note: This field may be set only when creating the resource. Modifying

5490

# this field while updating the resource will result in an error.

5491

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5492

"syndicationProduct": "A String", # The syndication product associated with the deal.

5493

#

5494

# Note: This field may be set only when creating the resource. Modifying

5495

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5496

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5497

"createTime": "A String", # Output only. The time of the deal creation.

5498

"description": "A String", # Description for the deal terms.

5499

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

5500

# to see but are non-negotiable. These are set by the publisher.

5501

"frequencyCaps": [ # Output only. Specifies any frequency caps.

5502

{ # Frequency cap.

5503

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5504

# which impressions per user are counted and capped.

5505

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

5506

# specified time period.

5507

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

5508

# amount of time over which impressions per user are counted and capped.

5509

},

5510

],

5511

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

5512

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

5513

},

5514

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5515

# targeting entity is AND'd together.

5516

{ # Advertisers can target different attributes of an ad slot. For example,

5517

# they can choose to show ads only if the user is in the U.S. Such

5518

# targeting criteria can be specified as part of Shared Targeting.

5519

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5520

# together.

5521

{ # A polymorphic targeting value used as part of Shared Targeting.

5522

"longValue": "A String", # The long value to include/exclude.

5523

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5524

# Filled in when the key is GOOG_DAYPART_TARGETING.

5525

# The definition of this targeting is derived from the structure

5526

# used by Ad Manager.

5527

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5528

"dayParts": [ # A list of day part targeting criterion.

5529

{ # Daypart targeting message that specifies if the ad can be shown

5530

# only during certain parts of a day/week.

5531

"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

5532

# granularity). The end time is exclusive. This field is not available

5533

# for filtering in PQL queries.

5534

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5535

# types are google.type.Date and `google.protobuf.Timestamp`.

5536

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5537

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5538

# allow the value 60 if it allows leap-seconds.

5539

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5540

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5541

# to allow the value "24:00:00" for scenarios like business closing time.

5542

},

5543

"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).

5544

# The start time is inclusive.

5545

# This field is not available for filtering in PQL queries.

5546

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5547

# types are google.type.Date and `google.protobuf.Timestamp`.

5548

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5549

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5550

# allow the value 60 if it allows leap-seconds.

5551

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5552

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5553

# to allow the value "24:00:00" for scenarios like business closing time.

5554

},

5555

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5560

# Filled in when key = GOOG_CREATIVE_SIZE

5561

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5562

# Companion sizes may be filled in only when creative_size_type = VIDEO

5563

{ # Message depicting the size of the creative. The units of width and

5564

# height depend on the type of the targeting.

5565

"height": 42, # The height of the creative.

5566

"width": 42, # The width of the creative

5567

},

5568

],

5569

"creativeSizeType": "A String", # The creative size type.

5570

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5571

# creative_size_type = CreativeSizeType.VIDEO.

5572

"allowedFormats": [ # What formats are allowed by the publisher.

5573

# If this repeated field is empty then all formats are allowed.

5574

# For example, if this field contains AllowedFormatType.AUDIO then the

5575

# publisher only allows an audio ad (without any video).

5576

"A String",

5577

],

5578

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5579

# of the creative

5580

# height depend on the type of the targeting.

5581

"height": 42, # The height of the creative.

5582

"width": 42, # The width of the creative

5583

},

5584

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5585

# only if creative_size_type = CreativeSizeType.NATIVE.

5586

},

5587

"stringValue": "A String", # The string value to include/exclude.

5588

},

5589

],

5590

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5591

# together.

5592

{ # A polymorphic targeting value used as part of Shared Targeting.

5593

"longValue": "A String", # The long value to include/exclude.

5594

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5595

# Filled in when the key is GOOG_DAYPART_TARGETING.

5596

# The definition of this targeting is derived from the structure

5597

# used by Ad Manager.

5598

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5599

"dayParts": [ # A list of day part targeting criterion.

5600

{ # Daypart targeting message that specifies if the ad can be shown

5601

# only during certain parts of a day/week.

5602

"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

5603

# granularity). The end time is exclusive. This field is not available

5604

# for filtering in PQL queries.

5605

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5606

# types are google.type.Date and `google.protobuf.Timestamp`.

5607

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5608

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5609

# allow the value 60 if it allows leap-seconds.

5610

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5611

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5612

# to allow the value "24:00:00" for scenarios like business closing time.

5613

},

5614

"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).

5615

# The start time is inclusive.

5616

# This field is not available for filtering in PQL queries.

5617

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5618

# types are google.type.Date and `google.protobuf.Timestamp`.

5619

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5620

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5621

# allow the value 60 if it allows leap-seconds.

5622

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5623

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5624

# to allow the value "24:00:00" for scenarios like business closing time.

5625

},

5626

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5631

# Filled in when key = GOOG_CREATIVE_SIZE

5632

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5633

# Companion sizes may be filled in only when creative_size_type = VIDEO

5634

{ # Message depicting the size of the creative. The units of width and

5635

# height depend on the type of the targeting.

5636

"height": 42, # The height of the creative.

5637

"width": 42, # The width of the creative

5638

},

5639

],

5640

"creativeSizeType": "A String", # The creative size type.

5641

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5642

# creative_size_type = CreativeSizeType.VIDEO.

5643

"allowedFormats": [ # What formats are allowed by the publisher.

5644

# If this repeated field is empty then all formats are allowed.

5645

# For example, if this field contains AllowedFormatType.AUDIO then the

5646

# publisher only allows an audio ad (without any video).

5647

"A String",

5648

],

5649

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5650

# of the creative

5651

# height depend on the type of the targeting.

5652

"height": 42, # The height of the creative.

5653

"width": 42, # The width of the creative

5654

},

5655

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5656

# only if creative_size_type = CreativeSizeType.NATIVE.

5657

},

5658

"stringValue": "A String", # The string value to include/exclude.

5659

},

5660

],

5661

"key": "A String", # The key representing the shared targeting criterion.

5662

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5663

# Third parties may define their own keys.

5664

# A list of permissible keys along with the acceptable values will be

5665

# provided as part of the external documentation.

5666

},

5667

],

5668

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

5669

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

5670

# and expected impressions from the publisher.

5671

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

5672

# Can be set by buyer or seller.

5673

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

5674

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

5675

# the API at this time, but can be returned in a get or list request.

5676

"fixedPrices": [ # Fixed price for the specified buyer.

5677

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5678

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5679

# a particular buyer or buyer/advertiser pair, we look for the most specific

5680

# matching rule - we first look for a rule matching the buyer and advertiser,

5681

# next a rule with the buyer but an empty advertiser list, and otherwise look

5682

# for a matching rule where no buyer is set.

5683

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5684

# If empty, all advertisers with this buyer pay this price.

5685

"A String",

5686

],

5687

"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

5688

# (if the

5689

# advertisers match, and there's no more specific rule matching the buyer).

5690

# Authorized Buyers account ID.

5691

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5692

},

5693

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5694

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5695

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5696

"units": "A String", # The whole units of the amount.

5697

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5698

"nanos": 42, # Number of nano (10^-9) units of the amount.

5699

# The value must be between -999,999,999 and +999,999,999 inclusive.

5700

# If `units` is positive, `nanos` must be positive or zero.

5701

# If `units` is zero, `nanos` can be positive, zero, or negative.

5702

# If `units` is negative, `nanos` must be negative or zero.

5703

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5704

"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.

5711

# Can be set by buyer or seller.

5712

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5713

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5714

"units": "A String", # The whole units of the amount.

5715

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5716

"nanos": 42, # Number of nano (10^-9) units of the amount.

5717

# The value must be between -999,999,999 and +999,999,999 inclusive.

5718

# If `units` is positive, `nanos` must be positive or zero.

5719

# If `units` is zero, `nanos` can be positive, zero, or negative.

5720

# If `units` is negative, `nanos` must be negative or zero.

5721

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5722

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5723

},

5724

},

5725

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

5726

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

5727

# of guaranteed looks that the buyer is guaranteeing to buy.

5728

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

5729

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

5730

"fixedPrices": [ # Fixed price for the specified buyer.

5731

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5732

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5733

# a particular buyer or buyer/advertiser pair, we look for the most specific

5734

# matching rule - we first look for a rule matching the buyer and advertiser,

5735

# next a rule with the buyer but an empty advertiser list, and otherwise look

5736

# for a matching rule where no buyer is set.

5737

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5738

# If empty, all advertisers with this buyer pay this price.

5739

"A String",

5740

],

5741

"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

5742

# (if the

5743

# advertisers match, and there's no more specific rule matching the buyer).

5744

# Authorized Buyers account ID.

5745

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5746

},

5747

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5748

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5749

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5750

"units": "A String", # The whole units of the amount.

5751

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5752

"nanos": 42, # Number of nano (10^-9) units of the amount.

5753

# The value must be between -999,999,999 and +999,999,999 inclusive.

5754

# If `units` is positive, `nanos` must be positive or zero.

5755

# If `units` is zero, `nanos` can be positive, zero, or negative.

5756

# If `units` is negative, `nanos` must be negative or zero.

5757

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5758

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

5765

# by the seller, but they can be returned in a get or list request.

5766

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

5767

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5768

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5769

# a particular buyer or buyer/advertiser pair, we look for the most specific

5770

# matching rule - we first look for a rule matching the buyer and advertiser,

5771

# next a rule with the buyer but an empty advertiser list, and otherwise look

5772

# for a matching rule where no buyer is set.

5773

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5774

# If empty, all advertisers with this buyer pay this price.

5775

"A String",

5776

],

5777

"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

5778

# (if the

5779

# advertisers match, and there's no more specific rule matching the buyer).

5780

# Authorized Buyers account ID.

5781

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5782

},

5783

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5784

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5785

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5786

"units": "A String", # The whole units of the amount.

5787

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5788

"nanos": 42, # Number of nano (10^-9) units of the amount.

5789

# The value must be between -999,999,999 and +999,999,999 inclusive.

5790

# If `units` is positive, `nanos` must be positive or zero.

5791

# If `units` is zero, `nanos` can be positive, zero, or negative.

5792

# If `units` is negative, `nanos` must be negative or zero.

5793

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5794

"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

5800

# in this private auction.

5801

},

5802

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

5803

# time zone used to mark the boundaries of a day. It should be an

5804

# IANA TZ name, such as "America/Los_Angeles". For more information,

5805

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

5806

"description": "A String", # Publisher provided description for the terms.

5807

},

5808

"availableEndTime": "A String", # Proposed flight end time of the deal.

5809

# This will generally be stored in a granularity of a second.

5810

# A value is not required for Private Auction deals or Preferred Deals.

5811

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5812

},

5813

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5814

"proposalState": "A String", # Output only. The current state of the proposal.

5815

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5816

# Each update to the proposal or the deal causes the proposal revision number

5817

# to auto-increment. The buyer keeps track of the last revision number they

5818

# know of and pass it in when making an update. If the head revision number

5819

# on the server has since incremented, then an ABORTED error is returned

5820

# during the update operation to let the buyer know that a subsequent update

5821

# was made.

5822

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

5823

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5824

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5825

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5826

#

5827

# Note: This field may be set only when creating the resource. Modifying

5828

# this field while updating the resource will result in an error.

5829

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5830

"subAccountId": "A String", # Optional sub-account ID for the seller.

5831

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5832

# The seller account ID is then available to buyer in the product.

5833

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5834

"buyerContacts": [ # Contact information for the buyer.

5835

{ # Contains information on how a buyer or seller can be reached.

5836

"name": "A String", # The name of the contact.

5837

"email": "A String", # Email address for the contact.

5838

},

5839

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5840

"displayName": "A String", # The name for the proposal.

5841

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5842

# left a comment.

5843

"proposalId": "A String", # Output only. The unique ID of the proposal.

5844

"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.

5845

# Authorized Buyers account ID.

5846

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5847

},

5848

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5849

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5850

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5851

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5852

# operations (max-length: 1024 unicode code units).

5853

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5854

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5855

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5856

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5857

#

5858

# Note: This field may be set only when creating the resource. Modifying

5859

# this field while updating the resource will result in an error.

5860

# Authorized Buyers account ID.

5861

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5862

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5867

<code class="details" id="update">update(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5868

<pre>Update the given proposal at the client known revision number. If the

5869

server revision has advanced since the passed-in

5870

`proposal.proposal_revision`, an `ABORTED` error message will be returned.

5871

Only the buyer-modifiable fields of the proposal will be updated.

5872

5873

Note that the deals in the proposal will be updated to match the passed-in

5874

copy.

5875

If a passed-in deal does not have a `deal_id`, the server will assign a new

5876

unique ID and create the deal.

5877

If passed-in deal has a `deal_id`, it will be updated to match the

5878

passed-in copy.

5879

Any existing deals not present in the passed-in proposal will be deleted.

5880

It is an error to pass in a deal with a `deal_id` not present at head.

5881

5882

Args:

5883

accountId: string, Account ID of the buyer. (required)

5884

proposalId: string, The unique ID of the proposal. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5885

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5886

The object takes the form of:

5887

5888

{ # Note: this resource requires whitelisting for access. Please contact your

5889

# account manager for access to Marketplace resources.

5890

#

5891

# Represents a proposal in the Marketplace. A proposal is the unit of

5892

# negotiation between a seller and a buyer and contains deals which

5893

# are served.

5894

#

5895

# Note: you can not update, create, or otherwise modify Private

5896

# Auction or Preferred Deals deals through the API.

5897

#

5898

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5899

"notes": [ # Output only. The notes associated with this proposal.

5900

{ # A proposal may be associated to several notes.

5901

"createTime": "A String", # Output only. The timestamp for when this note was created.

5902

"noteId": "A String", # Output only. The unique ID for the note.

5903

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5904

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5905

"note": "A String", # The actual note to attach.

5906

# (max-length: 1024 unicode code units)

5907

#

5908

# Note: This field may be set only when creating the resource. Modifying

5909

# this field while updating the resource will result in an error.

5910

},

5911

],

5912

"sellerContacts": [ # Output only. Contact information for the seller.

5913

{ # Contains information on how a buyer or seller can be reached.

5914

"name": "A String", # The name of the contact.

5915

"email": "A String", # Email address for the contact.

5916

},

5917

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5918

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5919

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5920

{ # A deal represents a segment of inventory for displaying ads on.

5921

# A proposal can contain multiple deals. A deal contains the terms and

5922

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5923

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5924

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5925

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5926

# target ad inventory. For example, they can choose to target ad requests only

5927

# if the user is in the US.

5928

# Multiple types of targeting are always applied as a logical AND, unless noted

5929

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5930

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5931

"excludedPositionTypes": [ # A list of video positions to be excluded.

5932

# Position types can either be included or excluded (XOR).

5933

"A String",

5934

],

5935

"targetedPositionTypes": [ # A list of video positions to be included.

5936

# When the included list is present, the excluded list must be empty.

5937

# When the excluded list is present, the included list must be empty.

5938

"A String",

5939

],

5940

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5941

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

5942

# mobile applications.

5943

# Different placement targeting types will be logically OR'ed.

5944

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5945

# For Private Auction and AdX Preferred Deals, URLs are either included or

5946

# excluded.

5947

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5948

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5949

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5950

"A String",

5951

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5952

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5957

# This doesn't apply to Auction Packages.

5958

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5959

# display the ads in.

5960

# publishers own.

5961

# Mobile application IDs are from App Store and Google Play Store.

5962

# Android App ID, for example, com.google.android.apps.maps, can be found in

5963

# Google Play Store URL.

5964

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5965

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5966

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5967

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5968

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5969

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5970

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5975

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5976

# included and excluded numeric IDs.

5977

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5978

"A String",

5979

],

5980

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

5981

"A String",

5982

],

5983

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5984

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

5985

# request. It only applies to Private Auction, AdX Preferred Deals and

5986

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5987

# and Preferred Deals in Ad Manager.

5988

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5989

{ # Represents size of a single ad slot, or a creative.

5990

"width": "A String", # The width of the ad slot in pixels.

5991

# This field will be present only when size type is `PIXEL`.

5992

"sizeType": "A String", # The size type of the ad slot.

5993

"height": "A String", # The height of the ad slot in pixels.

5994

# This field will be present only when size type is `PIXEL`.

5995

},

5996

],

5997

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5998

{ # Represents size of a single ad slot, or a creative.

5999

"width": "A String", # The width of the ad slot in pixels.

6000

# This field will be present only when size type is `PIXEL`.

6001

"sizeType": "A String", # The size type of the ad slot.

6002

"height": "A String", # The height of the ad slot in pixels.

6003

# This field will be present only when size type is `PIXEL`.

6004

},

6005

],

6006

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6007

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6008

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6009

# included and excluded numeric IDs.

6010

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6011

"A String",

6012

],

6013

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

6018

# included and excluded numeric IDs.

6019

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6020

"A String",

6021

],

6022

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6023

"A String",

6024

],

6025

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6026

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6027

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6028

# included and excluded numeric IDs.

6029

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6030

"A String",

6031

],

6032

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

6037

# included and excluded numeric IDs.

6038

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6039

"A String",

6040

],

6041

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6046

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6047

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6048

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6049

# deal.

6050

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

6051

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6052

# in Ad Manager.

6053

# Preferred Deal in Ad Manager.

6054

# This doesn't apply to Private Auction and AdX Preferred Deals.

6055

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

6056

"creativeSpecifications": [

6057

{ # Represents information for a creative that is associated with a Programmatic

6058

# Guaranteed/Preferred Deal in Ad Manager.

6059

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6060

"width": "A String", # The width of the ad slot in pixels.

6061

# This field will be present only when size type is `PIXEL`.

6062

"sizeType": "A String", # The size type of the ad slot.

6063

"height": "A String", # The height of the ad slot in pixels.

6064

# This field will be present only when size type is `PIXEL`.

6065

},

6066

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

6067

{ # Represents size of a single ad slot, or a creative.

6068

"width": "A String", # The width of the ad slot in pixels.

6069

# This field will be present only when size type is `PIXEL`.

6070

"sizeType": "A String", # The size type of the ad slot.

6071

"height": "A String", # The height of the ad slot in pixels.

6072

# This field will be present only when size type is `PIXEL`.

6073

},

6074

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6075

},

6076

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6077

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6078

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6079

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

6080

# If present on create, and the server `product_revision` has advanced sinced

6081

# the passed-in `create_product_revision`, an `ABORTED` error will be

6082

# returned.

6083

#

6084

# Note: This field may be set only when creating the resource. Modifying

6085

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6086

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6087

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6088

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6089

# operations (max-length: 1024 unicode code units).

6090

},

6091

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6092

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

6093

# The deal is considered paused if either hasBuyerPaused or

6094

# hasSellPaused is true.

6095

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6096

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6097

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

6098

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

6099

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6100

},

6101

},

6102

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6103

# finalized. This is the deal ID that shows up in serving/reporting etc.

6104

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6105

# PUBLISHER means creative is provided by seller and ADVERTISER means

6106

# creative is provided by buyer.

6107

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

6108

# This will generally be stored in the granularity of one second since deal

6109

# serving starts at seconds boundary. Any time specified with more

6110

# granularity (e.g., in milliseconds) will be truncated towards the start of

6111

# time in seconds.

6112

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6113

"sellerContacts": [ # Output only. Seller contact information for the deal.

6114

{ # Contains information on how a buyer or seller can be reached.

6115

"name": "A String", # The name of the contact.

6116

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6117

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6118

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6119

"createProductId": "A String", # The product ID from which this deal was created.

6120

#

6121

# Note: This field may be set only when creating the resource. Modifying

6122

# this field while updating the resource will result in an error.

6123

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6124

"syndicationProduct": "A String", # The syndication product associated with the deal.

6125

#

6126

# Note: This field may be set only when creating the resource. Modifying

6127

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6128

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6129

"createTime": "A String", # Output only. The time of the deal creation.

6130

"description": "A String", # Description for the deal terms.

6131

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

6132

# to see but are non-negotiable. These are set by the publisher.

6133

"frequencyCaps": [ # Output only. Specifies any frequency caps.

6134

{ # Frequency cap.

6135

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6136

# which impressions per user are counted and capped.

6137

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

6138

# specified time period.

6139

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

6140

# amount of time over which impressions per user are counted and capped.

6141

},

6142

],

6143

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

6144

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

6145

},

6146

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6147

# targeting entity is AND'd together.

6148

{ # Advertisers can target different attributes of an ad slot. For example,

6149

# they can choose to show ads only if the user is in the U.S. Such

6150

# targeting criteria can be specified as part of Shared Targeting.

6151

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6152

# together.

6153

{ # A polymorphic targeting value used as part of Shared Targeting.

6154

"longValue": "A String", # The long value to include/exclude.

6155

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6156

# Filled in when the key is GOOG_DAYPART_TARGETING.

6157

# The definition of this targeting is derived from the structure

6158

# used by Ad Manager.

6159

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6160

"dayParts": [ # A list of day part targeting criterion.

6161

{ # Daypart targeting message that specifies if the ad can be shown

6162

# only during certain parts of a day/week.

6163

"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

6164

# granularity). The end time is exclusive. This field is not available

6165

# for filtering in PQL queries.

6166

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6167

# types are google.type.Date and `google.protobuf.Timestamp`.

6168

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6169

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6170

# allow the value 60 if it allows leap-seconds.

6171

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6172

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6173

# to allow the value "24:00:00" for scenarios like business closing time.

6174

},

6175

"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).

6176

# The start time is inclusive.

6177

# This field is not available for filtering in PQL queries.

6178

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6179

# types are google.type.Date and `google.protobuf.Timestamp`.

6180

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6181

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6182

# allow the value 60 if it allows leap-seconds.

6183

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6184

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6185

# to allow the value "24:00:00" for scenarios like business closing time.

6186

},

6187

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6192

# Filled in when key = GOOG_CREATIVE_SIZE

6193

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6194

# Companion sizes may be filled in only when creative_size_type = VIDEO

6195

{ # Message depicting the size of the creative. The units of width and

6196

# height depend on the type of the targeting.

6197

"height": 42, # The height of the creative.

6198

"width": 42, # The width of the creative

6199

},

6200

],

6201

"creativeSizeType": "A String", # The creative size type.

6202

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6203

# creative_size_type = CreativeSizeType.VIDEO.

6204

"allowedFormats": [ # What formats are allowed by the publisher.

6205

# If this repeated field is empty then all formats are allowed.

6206

# For example, if this field contains AllowedFormatType.AUDIO then the

6207

# publisher only allows an audio ad (without any video).

6208

"A String",

6209

],

6210

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6211

# of the creative

6212

# height depend on the type of the targeting.

6213

"height": 42, # The height of the creative.

6214

"width": 42, # The width of the creative

6215

},

6216

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6217

# only if creative_size_type = CreativeSizeType.NATIVE.

6218

},

6219

"stringValue": "A String", # The string value to include/exclude.

6220

},

6221

],

6222

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6223

# together.

6224

{ # A polymorphic targeting value used as part of Shared Targeting.

6225

"longValue": "A String", # The long value to include/exclude.

6226

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6227

# Filled in when the key is GOOG_DAYPART_TARGETING.

6228

# The definition of this targeting is derived from the structure

6229

# used by Ad Manager.

6230

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6231

"dayParts": [ # A list of day part targeting criterion.

6232

{ # Daypart targeting message that specifies if the ad can be shown

6233

# only during certain parts of a day/week.

6234

"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

6235

# granularity). The end time is exclusive. This field is not available

6236

# for filtering in PQL queries.

6237

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6238

# types are google.type.Date and `google.protobuf.Timestamp`.

6239

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6240

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6241

# allow the value 60 if it allows leap-seconds.

6242

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6243

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6244

# to allow the value "24:00:00" for scenarios like business closing time.

6245

},

6246

"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).

6247

# The start time is inclusive.

6248

# This field is not available for filtering in PQL queries.

6249

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6250

# types are google.type.Date and `google.protobuf.Timestamp`.

6251

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6252

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6253

# allow the value 60 if it allows leap-seconds.

6254

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6255

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6256

# to allow the value "24:00:00" for scenarios like business closing time.

6257

},

6258

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6263

# Filled in when key = GOOG_CREATIVE_SIZE

6264

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6265

# Companion sizes may be filled in only when creative_size_type = VIDEO

6266

{ # Message depicting the size of the creative. The units of width and

6267

# height depend on the type of the targeting.

6268

"height": 42, # The height of the creative.

6269

"width": 42, # The width of the creative

6270

},

6271

],

6272

"creativeSizeType": "A String", # The creative size type.

6273

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6274

# creative_size_type = CreativeSizeType.VIDEO.

6275

"allowedFormats": [ # What formats are allowed by the publisher.

6276

# If this repeated field is empty then all formats are allowed.

6277

# For example, if this field contains AllowedFormatType.AUDIO then the

6278

# publisher only allows an audio ad (without any video).

6279

"A String",

6280

],

6281

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6282

# of the creative

6283

# height depend on the type of the targeting.

6284

"height": 42, # The height of the creative.

6285

"width": 42, # The width of the creative

6286

},

6287

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6288

# only if creative_size_type = CreativeSizeType.NATIVE.

6289

},

6290

"stringValue": "A String", # The string value to include/exclude.

6291

},

6292

],

6293

"key": "A String", # The key representing the shared targeting criterion.

6294

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6295

# Third parties may define their own keys.

6296

# A list of permissible keys along with the acceptable values will be

6297

# provided as part of the external documentation.

6298

},

6299

],

6300

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6301

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6302

# and expected impressions from the publisher.

6303

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6304

# Can be set by buyer or seller.

6305

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6306

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6307

# the API at this time, but can be returned in a get or list request.

6308

"fixedPrices": [ # Fixed price for the specified buyer.

6309

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6310

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6311

# a particular buyer or buyer/advertiser pair, we look for the most specific

6312

# matching rule - we first look for a rule matching the buyer and advertiser,

6313

# next a rule with the buyer but an empty advertiser list, and otherwise look

6314

# for a matching rule where no buyer is set.

6315

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6316

# If empty, all advertisers with this buyer pay this price.

6317

"A String",

6318

],

6319

"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

6320

# (if the

6321

# advertisers match, and there's no more specific rule matching the buyer).

6322

# Authorized Buyers account ID.

6323

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6324

},

6325

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6326

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6327

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6328

"units": "A String", # The whole units of the amount.

6329

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6330

"nanos": 42, # Number of nano (10^-9) units of the amount.

6331

# The value must be between -999,999,999 and +999,999,999 inclusive.

6332

# If `units` is positive, `nanos` must be positive or zero.

6333

# If `units` is zero, `nanos` can be positive, zero, or negative.

6334

# If `units` is negative, `nanos` must be negative or zero.

6335

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6336

"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.

6343

# Can be set by buyer or seller.

6344

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6345

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6346

"units": "A String", # The whole units of the amount.

6347

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6348

"nanos": 42, # Number of nano (10^-9) units of the amount.

6349

# The value must be between -999,999,999 and +999,999,999 inclusive.

6350

# If `units` is positive, `nanos` must be positive or zero.

6351

# If `units` is zero, `nanos` can be positive, zero, or negative.

6352

# If `units` is negative, `nanos` must be negative or zero.

6353

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6354

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6355

},

6356

},

6357

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6358

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6359

# of guaranteed looks that the buyer is guaranteeing to buy.

6360

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6361

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6362

"fixedPrices": [ # Fixed price for the specified buyer.

6363

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6364

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6365

# a particular buyer or buyer/advertiser pair, we look for the most specific

6366

# matching rule - we first look for a rule matching the buyer and advertiser,

6367

# next a rule with the buyer but an empty advertiser list, and otherwise look

6368

# for a matching rule where no buyer is set.

6369

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6370

# If empty, all advertisers with this buyer pay this price.

6371

"A String",

6372

],

6373

"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

6374

# (if the

6375

# advertisers match, and there's no more specific rule matching the buyer).

6376

# Authorized Buyers account ID.

6377

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6378

},

6379

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6380

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6381

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6382

"units": "A String", # The whole units of the amount.

6383

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6384

"nanos": 42, # Number of nano (10^-9) units of the amount.

6385

# The value must be between -999,999,999 and +999,999,999 inclusive.

6386

# If `units` is positive, `nanos` must be positive or zero.

6387

# If `units` is zero, `nanos` can be positive, zero, or negative.

6388

# If `units` is negative, `nanos` must be negative or zero.

6389

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6390

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6397

# by the seller, but they can be returned in a get or list request.

6398

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6399

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6400

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6401

# a particular buyer or buyer/advertiser pair, we look for the most specific

6402

# matching rule - we first look for a rule matching the buyer and advertiser,

6403

# next a rule with the buyer but an empty advertiser list, and otherwise look

6404

# for a matching rule where no buyer is set.

6405

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6406

# If empty, all advertisers with this buyer pay this price.

6407

"A String",

6408

],

6409

"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

6410

# (if the

6411

# advertisers match, and there's no more specific rule matching the buyer).

6412

# Authorized Buyers account ID.

6413

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6414

},

6415

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6416

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6417

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6418

"units": "A String", # The whole units of the amount.

6419

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6420

"nanos": 42, # Number of nano (10^-9) units of the amount.

6421

# The value must be between -999,999,999 and +999,999,999 inclusive.

6422

# If `units` is positive, `nanos` must be positive or zero.

6423

# If `units` is zero, `nanos` can be positive, zero, or negative.

6424

# If `units` is negative, `nanos` must be negative or zero.

6425

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6426

"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

6432

# in this private auction.

6433

},

6434

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6435

# time zone used to mark the boundaries of a day. It should be an

6436

# IANA TZ name, such as "America/Los_Angeles". For more information,

6437

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

6438

"description": "A String", # Publisher provided description for the terms.

6439

},

6440

"availableEndTime": "A String", # Proposed flight end time of the deal.

6441

# This will generally be stored in a granularity of a second.

6442

# A value is not required for Private Auction deals or Preferred Deals.

6443

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6444

},

6445

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6446

"proposalState": "A String", # Output only. The current state of the proposal.

6447

"proposalRevision": "A String", # Output only. The revision number for the proposal.

6448

# Each update to the proposal or the deal causes the proposal revision number

6449

# to auto-increment. The buyer keeps track of the last revision number they

6450

# know of and pass it in when making an update. If the head revision number

6451

# on the server has since incremented, then an ABORTED error is returned

6452

# during the update operation to let the buyer know that a subsequent update

6453

# was made.

6454

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

6455

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6456

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6457

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6458

#

6459

# Note: This field may be set only when creating the resource. Modifying

6460

# this field while updating the resource will result in an error.

6461

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6462

"subAccountId": "A String", # Optional sub-account ID for the seller.

6463

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6464

# The seller account ID is then available to buyer in the product.

6465

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6466

"buyerContacts": [ # Contact information for the buyer.

6467

{ # Contains information on how a buyer or seller can be reached.

6468

"name": "A String", # The name of the contact.

6469

"email": "A String", # Email address for the contact.

6470

},

6471

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6472

"displayName": "A String", # The name for the proposal.

6473

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

6474

# left a comment.

6475

"proposalId": "A String", # Output only. The unique ID of the proposal.

6476

"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.

6477

# Authorized Buyers account ID.

6478

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6479

},

6480

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

6481

"updateTime": "A String", # Output only. The time when the proposal was last revised.

6482

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

6483

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6484

# operations (max-length: 1024 unicode code units).

6485

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6486

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

6487

# proposal.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6488

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

6489

#

6490

# Note: This field may be set only when creating the resource. Modifying

6491

# this field while updating the resource will result in an error.

6492

# Authorized Buyers account ID.

6493

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6494

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6495

}

6496

6497

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

6504

6505

{ # Note: this resource requires whitelisting for access. Please contact your

6506

# account manager for access to Marketplace resources.

6507

#

6508

# Represents a proposal in the Marketplace. A proposal is the unit of

6509

# negotiation between a seller and a buyer and contains deals which

6510

# are served.

6511

#

6512

# Note: you can not update, create, or otherwise modify Private

6513

# Auction or Preferred Deals deals through the API.

6514

#

6515

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6516

"notes": [ # Output only. The notes associated with this proposal.

6517

{ # A proposal may be associated to several notes.

6518

"createTime": "A String", # Output only. The timestamp for when this note was created.

6519

"noteId": "A String", # Output only. The unique ID for the note.

6520

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

6521

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

6522

"note": "A String", # The actual note to attach.

6523

# (max-length: 1024 unicode code units)

6524

#

6525

# Note: This field may be set only when creating the resource. Modifying

6526

# this field while updating the resource will result in an error.

6527

},

6528

],

6529

"sellerContacts": [ # Output only. Contact information for the seller.

6530

{ # Contains information on how a buyer or seller can be reached.

6531

"name": "A String", # The name of the contact.

6532

"email": "A String", # Email address for the contact.

6533

},

6534

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6535

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6536

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

6537

{ # A deal represents a segment of inventory for displaying ads on.

6538

# A proposal can contain multiple deals. A deal contains the terms and

6539

# targeting information that is used for serving.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6540

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6541

"displayName": "A String", # The name of the deal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6542

"targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6543

# target ad inventory. For example, they can choose to target ad requests only

6544

# if the user is in the US.

6545

# Multiple types of targeting are always applied as a logical AND, unless noted

6546

# otherwise.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6547

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6548

"excludedPositionTypes": [ # A list of video positions to be excluded.

6549

# Position types can either be included or excluded (XOR).

6550

"A String",

6551

],

6552

"targetedPositionTypes": [ # A list of video positions to be included.

6553

# When the included list is present, the excluded list must be empty.

6554

# When the excluded list is present, the included list must be empty.

6555

"A String",

6556

],

6557

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6558

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

6559

# mobile applications.

6560

# Different placement targeting types will be logically OR'ed.

6561

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6562

# For Private Auction and AdX Preferred Deals, URLs are either included or

6563

# excluded.

6564

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6565

# apply.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6566

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6567

"A String",

6568

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6569

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6574

# This doesn't apply to Auction Packages.

6575

"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6576

# display the ads in.

6577

# publishers own.

6578

# Mobile application IDs are from App Store and Google Play Store.

6579

# Android App ID, for example, com.google.android.apps.maps, can be found in

6580

# Google Play Store URL.

6581

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6582

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6583

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6584

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6585

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6586

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6587

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

},

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6592

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6593

# included and excluded numeric IDs.

6594

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6595

"A String",

6596

],

6597

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6598

"A String",

6599

],

6600

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6601

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

6602

# request. It only applies to Private Auction, AdX Preferred Deals and

6603

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6604

# and Preferred Deals in Ad Manager.

6605

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6606

{ # Represents size of a single ad slot, or a creative.

6607

"width": "A String", # The width of the ad slot in pixels.

6608

# This field will be present only when size type is `PIXEL`.

6609

"sizeType": "A String", # The size type of the ad slot.

6610

"height": "A String", # The height of the ad slot in pixels.

6611

# This field will be present only when size type is `PIXEL`.

6612

},

6613

],

6614

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6615

{ # Represents size of a single ad slot, or a creative.

6616

"width": "A String", # The width of the ad slot in pixels.

6617

# This field will be present only when size type is `PIXEL`.

6618

"sizeType": "A String", # The size type of the ad slot.

6619

"height": "A String", # The height of the ad slot in pixels.

6620

# This field will be present only when size type is `PIXEL`.

6621

},

6622

],

6623

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6624

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6625

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6626

# included and excluded numeric IDs.

6627

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6628

"A String",

6629

],

6630

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.

6635

# included and excluded numeric IDs.

6636

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6637

"A String",

6638

],

6639

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

6640

"A String",

6641

],

6642

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6643

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6644

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6645

# included and excluded numeric IDs.

6646

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6647

"A String",

6648

],

6649

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

6654

# included and excluded numeric IDs.

6655

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6656

"A String",

6657

],

6658

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6663

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6664

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6665

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6666

# deal.

6667

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

6668

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6669

# in Ad Manager.

6670

# Preferred Deal in Ad Manager.

6671

# This doesn't apply to Private Auction and AdX Preferred Deals.

6672

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

6673

"creativeSpecifications": [

6674

{ # Represents information for a creative that is associated with a Programmatic

6675

# Guaranteed/Preferred Deal in Ad Manager.

6676

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6677

"width": "A String", # The width of the ad slot in pixels.

6678

# This field will be present only when size type is `PIXEL`.

6679

"sizeType": "A String", # The size type of the ad slot.

6680

"height": "A String", # The height of the ad slot in pixels.

6681

# This field will be present only when size type is `PIXEL`.

6682

},

6683

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

6684

{ # Represents size of a single ad slot, or a creative.

6685

"width": "A String", # The width of the ad slot in pixels.

6686

# This field will be present only when size type is `PIXEL`.

6687

"sizeType": "A String", # The size type of the ad slot.

6688

"height": "A String", # The height of the ad slot in pixels.

6689

# This field will be present only when size type is `PIXEL`.

6690

},

6691

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6692

},

6693

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6694

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6695

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6696

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

6697

# If present on create, and the server `product_revision` has advanced sinced

6698

# the passed-in `create_product_revision`, an `ABORTED` error will be

6699

# returned.

6700

#

6701

# Note: This field may be set only when creating the resource. Modifying

6702

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6703

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6704

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6705

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6706

# operations (max-length: 1024 unicode code units).

6707

},

6708

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6709

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

6710

# The deal is considered paused if either hasBuyerPaused or

6711

# hasSellPaused is true.

6712

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6713

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6714

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

6715

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

6716

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6717

},

6718

},

6719

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6720

# finalized. This is the deal ID that shows up in serving/reporting etc.

6721

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6722

# PUBLISHER means creative is provided by seller and ADVERTISER means

6723

# creative is provided by buyer.

6724

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

6725

# This will generally be stored in the granularity of one second since deal

6726

# serving starts at seconds boundary. Any time specified with more

6727

# granularity (e.g., in milliseconds) will be truncated towards the start of

6728

# time in seconds.

6729

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6730

"sellerContacts": [ # Output only. Seller contact information for the deal.

6731

{ # Contains information on how a buyer or seller can be reached.

6732

"name": "A String", # The name of the contact.

6733

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6734

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6735

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6736

"createProductId": "A String", # The product ID from which this deal was created.

6737

#

6738

# Note: This field may be set only when creating the resource. Modifying

6739

# this field while updating the resource will result in an error.

6740

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6741

"syndicationProduct": "A String", # The syndication product associated with the deal.

6742

#

6743

# Note: This field may be set only when creating the resource. Modifying

6744

# this field while updating the resource will result in an error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6745

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6746

"createTime": "A String", # Output only. The time of the deal creation.

6747

"description": "A String", # Description for the deal terms.

6748

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

6749

# to see but are non-negotiable. These are set by the publisher.

6750

"frequencyCaps": [ # Output only. Specifies any frequency caps.

6751

{ # Frequency cap.

6752

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6753

# which impressions per user are counted and capped.

6754

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

6755

# specified time period.

6756

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

6757

# amount of time over which impressions per user are counted and capped.

6758

},

6759

],

6760

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

6761

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

6762

},

6763

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6764

# targeting entity is AND'd together.

6765

{ # Advertisers can target different attributes of an ad slot. For example,

6766

# they can choose to show ads only if the user is in the U.S. Such

6767

# targeting criteria can be specified as part of Shared Targeting.

6768

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6769

# together.

6770

{ # A polymorphic targeting value used as part of Shared Targeting.

6771

"longValue": "A String", # The long value to include/exclude.

6772

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6773

# Filled in when the key is GOOG_DAYPART_TARGETING.

6774

# The definition of this targeting is derived from the structure

6775

# used by Ad Manager.

6776

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6777

"dayParts": [ # A list of day part targeting criterion.

6778

{ # Daypart targeting message that specifies if the ad can be shown

6779

# only during certain parts of a day/week.

6780

"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

6781

# granularity). The end time is exclusive. This field is not available

6782

# for filtering in PQL queries.

6783

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6784

# types are google.type.Date and `google.protobuf.Timestamp`.

6785

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6786

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6787

# allow the value 60 if it allows leap-seconds.

6788

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6789

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6790

# to allow the value "24:00:00" for scenarios like business closing time.

6791

},

6792

"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).

6793

# The start time is inclusive.

6794

# This field is not available for filtering in PQL queries.

6795

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6796

# types are google.type.Date and `google.protobuf.Timestamp`.

6797

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6798

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6799

# allow the value 60 if it allows leap-seconds.

6800

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6801

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6802

# to allow the value "24:00:00" for scenarios like business closing time.

6803

},

6804

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6809

# Filled in when key = GOOG_CREATIVE_SIZE

6810

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6811

# Companion sizes may be filled in only when creative_size_type = VIDEO

6812

{ # Message depicting the size of the creative. The units of width and

6813

# height depend on the type of the targeting.

6814

"height": 42, # The height of the creative.

6815

"width": 42, # The width of the creative

6816

},

6817

],

6818

"creativeSizeType": "A String", # The creative size type.

6819

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6820

# creative_size_type = CreativeSizeType.VIDEO.

6821

"allowedFormats": [ # What formats are allowed by the publisher.

6822

# If this repeated field is empty then all formats are allowed.

6823

# For example, if this field contains AllowedFormatType.AUDIO then the

6824

# publisher only allows an audio ad (without any video).

6825

"A String",

6826

],

6827

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6828

# of the creative

6829

# height depend on the type of the targeting.

6830

"height": 42, # The height of the creative.

6831

"width": 42, # The width of the creative

6832

},

6833

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6834

# only if creative_size_type = CreativeSizeType.NATIVE.

6835

},

6836

"stringValue": "A String", # The string value to include/exclude.

6837

},

6838

],

6839

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6840

# together.

6841

{ # A polymorphic targeting value used as part of Shared Targeting.

6842

"longValue": "A String", # The long value to include/exclude.

6843

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6844

# Filled in when the key is GOOG_DAYPART_TARGETING.

6845

# The definition of this targeting is derived from the structure

6846

# used by Ad Manager.

6847

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6848

"dayParts": [ # A list of day part targeting criterion.

6849

{ # Daypart targeting message that specifies if the ad can be shown

6850

# only during certain parts of a day/week.

6851

"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

6852

# granularity). The end time is exclusive. This field is not available

6853

# for filtering in PQL queries.

6854

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6855

# types are google.type.Date and `google.protobuf.Timestamp`.

6856

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6857

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6858

# allow the value 60 if it allows leap-seconds.

6859

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6860

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6861

# to allow the value "24:00:00" for scenarios like business closing time.

6862

},

6863

"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).

6864

# The start time is inclusive.

6865

# This field is not available for filtering in PQL queries.

6866

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6867

# types are google.type.Date and `google.protobuf.Timestamp`.

6868

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6869

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6870

# allow the value 60 if it allows leap-seconds.

6871

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6872

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6873

# to allow the value "24:00:00" for scenarios like business closing time.

6874

},

6875

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6880

# Filled in when key = GOOG_CREATIVE_SIZE

6881

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6882

# Companion sizes may be filled in only when creative_size_type = VIDEO

6883

{ # Message depicting the size of the creative. The units of width and

6884

# height depend on the type of the targeting.

6885

"height": 42, # The height of the creative.

6886

"width": 42, # The width of the creative

6887

},

6888

],

6889

"creativeSizeType": "A String", # The creative size type.

6890

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6891

# creative_size_type = CreativeSizeType.VIDEO.

6892

"allowedFormats": [ # What formats are allowed by the publisher.

6893

# If this repeated field is empty then all formats are allowed.

6894

# For example, if this field contains AllowedFormatType.AUDIO then the

6895

# publisher only allows an audio ad (without any video).

6896

"A String",

6897

],

6898

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6899

# of the creative

6900

# height depend on the type of the targeting.

6901

"height": 42, # The height of the creative.

6902

"width": 42, # The width of the creative

6903

},

6904

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6905

# only if creative_size_type = CreativeSizeType.NATIVE.

6906

},

6907

"stringValue": "A String", # The string value to include/exclude.

6908

},

6909

],

6910

"key": "A String", # The key representing the shared targeting criterion.

6911

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6912

# Third parties may define their own keys.

6913

# A list of permissible keys along with the acceptable values will be

6914

# provided as part of the external documentation.

6915

},

6916

],

6917

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6918

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6919

# and expected impressions from the publisher.

6920

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6921

# Can be set by buyer or seller.

6922

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

6923

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6924

# the API at this time, but can be returned in a get or list request.

6925

"fixedPrices": [ # Fixed price for the specified buyer.

6926

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6927

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6928

# a particular buyer or buyer/advertiser pair, we look for the most specific

6929

# matching rule - we first look for a rule matching the buyer and advertiser,

6930

# next a rule with the buyer but an empty advertiser list, and otherwise look

6931

# for a matching rule where no buyer is set.

6932

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6933

# If empty, all advertisers with this buyer pay this price.

6934

"A String",

6935

],

6936

"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

6937

# (if the

6938

# advertisers match, and there's no more specific rule matching the buyer).

6939

# Authorized Buyers account ID.

6940

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6941

},

6942

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6943

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6944

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6945

"units": "A String", # The whole units of the amount.

6946

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6947

"nanos": 42, # Number of nano (10^-9) units of the amount.

6948

# The value must be between -999,999,999 and +999,999,999 inclusive.

6949

# If `units` is positive, `nanos` must be positive or zero.

6950

# If `units` is zero, `nanos` can be positive, zero, or negative.

6951

# If `units` is negative, `nanos` must be negative or zero.

6952

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6953

"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.

6960

# Can be set by buyer or seller.

6961

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6962

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6963

"units": "A String", # The whole units of the amount.

6964

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6965

"nanos": 42, # Number of nano (10^-9) units of the amount.

6966

# The value must be between -999,999,999 and +999,999,999 inclusive.

6967

# If `units` is positive, `nanos` must be positive or zero.

6968

# If `units` is zero, `nanos` can be positive, zero, or negative.

6969

# If `units` is negative, `nanos` must be negative or zero.

6970

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6971

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6972

},

6973

},

6974

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6975

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6976

# of guaranteed looks that the buyer is guaranteeing to buy.

6977

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6978

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

6979

"fixedPrices": [ # Fixed price for the specified buyer.

6980

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6981

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6982

# a particular buyer or buyer/advertiser pair, we look for the most specific

6983

# matching rule - we first look for a rule matching the buyer and advertiser,

6984

# next a rule with the buyer but an empty advertiser list, and otherwise look

6985

# for a matching rule where no buyer is set.

6986

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6987

# If empty, all advertisers with this buyer pay this price.

6988

"A String",

6989

],

6990

"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

6991

# (if the

6992

# advertisers match, and there's no more specific rule matching the buyer).

6993

# Authorized Buyers account ID.

6994

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6995

},

6996

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6997

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6998

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6999

"units": "A String", # The whole units of the amount.

7000

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7001

"nanos": 42, # Number of nano (10^-9) units of the amount.

7002

# The value must be between -999,999,999 and +999,999,999 inclusive.

7003

# If `units` is positive, `nanos` must be positive or zero.

7004

# If `units` is zero, `nanos` can be positive, zero, or negative.

7005

# If `units` is negative, `nanos` must be negative or zero.

7006

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7007

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

},

},

},

],

},

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

7014

# by the seller, but they can be returned in a get or list request.

7015

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

7016

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

7017

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

7018

# a particular buyer or buyer/advertiser pair, we look for the most specific

7019

# matching rule - we first look for a rule matching the buyer and advertiser,

7020

# next a rule with the buyer but an empty advertiser list, and otherwise look

7021

# for a matching rule where no buyer is set.

7022

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

7023

# If empty, all advertisers with this buyer pay this price.

7024

"A String",

7025

],

7026

"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

7027

# (if the

7028

# advertisers match, and there's no more specific rule matching the buyer).

7029

# Authorized Buyers account ID.

7030

"accountId": "A String", # Authorized Buyers account ID of the buyer.

7031

},

7032

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

7033

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

7034

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

7035

"units": "A String", # The whole units of the amount.

7036

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

7037

"nanos": 42, # Number of nano (10^-9) units of the amount.

7038

# The value must be between -999,999,999 and +999,999,999 inclusive.

7039

# If `units` is positive, `nanos` must be positive or zero.

7040

# If `units` is zero, `nanos` can be positive, zero, or negative.

7041

# If `units` is negative, `nanos` must be negative or zero.

7042

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

7043

"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

7049

# in this private auction.

7050

},

7051

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

7052

# time zone used to mark the boundaries of a day. It should be an

7053

# IANA TZ name, such as "America/Los_Angeles". For more information,

7054

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

7055

"description": "A String", # Publisher provided description for the terms.

7056

},

7057

"availableEndTime": "A String", # Proposed flight end time of the deal.

7058

# This will generally be stored in a granularity of a second.

7059

# A value is not required for Private Auction deals or Preferred Deals.

7060

"updateTime": "A String", # Output only. The time when the deal was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7061

},

7062

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7063

"proposalState": "A String", # Output only. The current state of the proposal.

7064

"proposalRevision": "A String", # Output only. The revision number for the proposal.

7065

# Each update to the proposal or the deal causes the proposal revision number

7066

# to auto-increment. The buyer keeps track of the last revision number they

7067

# know of and pass it in when making an update. If the head revision number

7068

# on the server has since incremented, then an ABORTED error is returned

7069

# during the update operation to let the buyer know that a subsequent update

7070

# was made.

7071

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

7072

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

7073

# proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7074

"seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7075

#

7076

# Note: This field may be set only when creating the resource. Modifying

7077

# this field while updating the resource will result in an error.

7078

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7079

"subAccountId": "A String", # Optional sub-account ID for the seller.

7080

"accountId": "A String", # The unique ID for the seller. The seller fills in this field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7081

# The seller account ID is then available to buyer in the product.

7082

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7083

"buyerContacts": [ # Contact information for the buyer.

7084

{ # Contains information on how a buyer or seller can be reached.

7085

"name": "A String", # The name of the contact.

7086

"email": "A String", # Email address for the contact.

7087

},

7088

],

Bu Sun Kim