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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

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

83

84

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

85

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

86

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

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

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Dan O'Meara

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

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

117

118

Args:

119

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

120

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

Dan O'Meara

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

[diff] [blame]

121

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

122

The object takes the form of:

123

124

{ # Request to accept a proposal.

Bu Sun Kim

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

}

127

128

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

135

136

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

137

# account manager for access to Marketplace resources.

138

#

139

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

140

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

141

# are served.

142

#

143

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

144

# Auction or Preferred Deals deals through the API.

145

#

146

# Fields are updatable unless noted otherwise.

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

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

153

# was made.

Bu Sun Kim

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

[diff] [blame]

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

158

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

159

# targeting information that is used for serving.

Bu Sun Kim

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

[diff] [blame]

160

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

161

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

162

# deal.

163

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

Bu Sun Kim

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

[diff] [blame]

164

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

165

# PUBLISHER means creative is provided by seller and ADVERTISER means

166

# creative is provided by buyer.

Bu Sun Kim

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

[diff] [blame]

167

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

168

# targeting entity is AND'd together.

169

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

170

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

171

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

172

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

173

# together.

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

# Filled in when the key is GOOG_DAYPART_TARGETING.

177

# The definition of this targeting is derived from the structure

178

# used by Ad Manager.

179

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

180

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

181

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

182

# only during certain parts of a day/week.

Bu Sun Kim

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

[diff] [blame]

183

"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

184

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

185

# for filtering in PQL queries.

186

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

187

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

Bu Sun Kim

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

[diff] [blame]

188

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

Bu Sun Kim

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

[diff] [blame]

189

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

190

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

Bu Sun Kim

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

[diff] [blame]

191

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

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

194

},

Bu Sun Kim

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

[diff] [blame]

195

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

196

# The start time is inclusive.

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

},

207

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

Bu Sun Kim

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

[diff] [blame]

208

},

209

],

210

},

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

# Filled in when key = GOOG_CREATIVE_SIZE

214

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

215

# only if creative_size_type = CreativeSizeType.NATIVE.

216

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

217

# of the creative

218

# height depend on the type of the targeting.

219

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

220

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

221

},

222

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

223

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

224

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

225

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

226

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

227

"A String",

228

],

229

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

230

# creative_size_type = CreativeSizeType.VIDEO.

231

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

232

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

233

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

234

# height depend on the type of the targeting.

235

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

236

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

},

],

},

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

241

},

242

],

243

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

244

# together.

245

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

246

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

247

# Filled in when the key is GOOG_DAYPART_TARGETING.

248

# The definition of this targeting is derived from the structure

249

# used by Ad Manager.

250

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

251

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

252

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

253

# only during certain parts of a day/week.

254

"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

255

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

256

# for filtering in PQL queries.

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

},

266

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

267

# The start time is inclusive.

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

},

278

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

},

],

},

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

283

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

284

# Filled in when key = GOOG_CREATIVE_SIZE

285

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

286

# only if creative_size_type = CreativeSizeType.NATIVE.

287

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

288

# of the creative

289

# height depend on the type of the targeting.

290

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

291

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

292

},

293

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

294

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

295

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

296

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

297

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

298

"A String",

299

],

300

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

301

# creative_size_type = CreativeSizeType.VIDEO.

302

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

303

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

304

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

305

# height depend on the type of the targeting.

306

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

307

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

312

},

313

],

314

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

315

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

316

# Third parties may define their own keys.

317

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

318

# provided as part of the external documentation.

Bu Sun Kim

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

[diff] [blame]

319

},

320

],

321

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

322

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

323

# in Ad Manager.

324

# Preferred Deal in Ad Manager.

325

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

326

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

327

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

328

"creativeSpecifications": [

329

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

330

# Guaranteed/Preferred Deal in Ad Manager.

331

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

332

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

333

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

334

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

335

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

336

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

Bu Sun Kim

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

[diff] [blame]

337

},

Bu Sun Kim

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

[diff] [blame]

338

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

339

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

340

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

341

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

342

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

343

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

344

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

},

],

},

],

},

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

351

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

352

# The deal is considered paused if either hasBuyerPaused or

353

# hasSellPaused is true.

354

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

355

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

356

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

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

},

Bu Sun Kim

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

[diff] [blame]

360

},

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

# and expected impressions from the publisher.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

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

367

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

368

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

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

371

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

372

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

373

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

374

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

375

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

376

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

377

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

378

"A String",

379

],

Bu Sun Kim

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

[diff] [blame]

380

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

Bu Sun Kim

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

[diff] [blame]

381

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

Bu Sun Kim

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

[diff] [blame]

382

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

Bu Sun Kim

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

[diff] [blame]

383

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

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

386

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

387

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

388

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

389

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

390

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

Bu Sun Kim

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

[diff] [blame]

391

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

Bu Sun Kim

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

[diff] [blame]

392

},

Bu Sun Kim

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

[diff] [blame]

393

},

Bu Sun Kim

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

[diff] [blame]

394

"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

395

# (if the

396

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

397

# Authorized Buyers account ID.

398

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

},

},

],

},

Bu Sun Kim

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

[diff] [blame]

403

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

404

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

405

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

406

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

407

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

Bu Sun Kim

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

[diff] [blame]

408

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

409

# Can be set by buyer or seller.

410

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

411

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

412

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

413

# in this private auction.

414

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

415

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

416

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

417

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

418

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

419

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

420

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

423

"A String",

424

],

Bu Sun Kim

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

[diff] [blame]

425

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

Bu Sun Kim

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

[diff] [blame]

426

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

Bu Sun Kim

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

[diff] [blame]

427

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

Bu Sun Kim

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

[diff] [blame]

428

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

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

431

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

432

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

433

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

434

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

435

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

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

},

Bu Sun Kim

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

[diff] [blame]

438

},

Bu Sun Kim

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

[diff] [blame]

439

"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

440

# (if the

441

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

442

# Authorized Buyers account ID.

443

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

},

},

],

},

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

457

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

458

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

459

"A String",

460

],

Bu Sun Kim

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

[diff] [blame]

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

},

474

},

Bu Sun Kim

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

[diff] [blame]

475

"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

476

# (if the

477

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

478

# Authorized Buyers account ID.

479

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

},

},

],

},

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

485

# Can be set by buyer or seller.

Bu Sun Kim

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

[diff] [blame]

486

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

Bu Sun Kim

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

[diff] [blame]

487

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

Bu Sun Kim

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

[diff] [blame]

488

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

489

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

Bu Sun Kim

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

[diff] [blame]

490

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

491

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

492

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

493

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

494

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

495

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

Bu Sun Kim

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

[diff] [blame]

496

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

Bu Sun Kim

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

[diff] [blame]

497

},

Bu Sun Kim

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

[diff] [blame]

498

},

499

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

Bu Sun Kim

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

[diff] [blame]

500

},

Bu Sun Kim

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

[diff] [blame]

501

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

502

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

503

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

504

#

505

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

506

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

507

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

508

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

Bu Sun Kim

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

[diff] [blame]

509

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

510

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

511

# if the user is in the US.

512

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

513

# otherwise.

Bu Sun Kim

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

[diff] [blame]

514

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

515

# mobile applications.

516

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

517

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

518

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

519

# excluded.

520

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

521

# apply.

Bu Sun Kim

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

[diff] [blame]

522

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

Bu Sun Kim

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

[diff] [blame]

523

"A String",

524

],

Bu Sun Kim

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

[diff] [blame]

525

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

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

530

# This doesn't apply to Auction Packages.

531

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

532

# display the ads in.

533

# publishers own.

534

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

535

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

536

# Google Play Store URL.

537

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

538

# First party mobile applications is either included or excluded.

Bu Sun Kim

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

[diff] [blame]

539

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

Bu Sun Kim

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

[diff] [blame]

540

"A String",

Dan O'Meara

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

[diff] [blame]

541

],

Bu Sun Kim

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

[diff] [blame]

542

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

Bu Sun Kim

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

[diff] [blame]

543

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

548

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

549

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

550

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

551

# and Preferred Deals in Ad Manager.

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

},

560

],

561

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

562

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

563

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

564

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

565

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

566

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

567

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

},

],

},

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

572

# included and excluded numeric IDs.

573

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

574

"A String",

575

],

576

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

"A String",

],

},

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

581

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

582

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

583

# included and excluded numeric IDs.

584

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

585

"A String",

586

],

587

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

"A String",

],

},

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

592

# included and excluded numeric IDs.

593

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

594

"A String",

595

],

596

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

"A String",

],

},

},

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

602

# included and excluded numeric IDs.

603

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

604

"A String",

605

],

606

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

611

# included and excluded numeric IDs.

612

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

613

"A String",

614

],

615

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

"A String",

],

},

},

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

621

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

622

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

623

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

624

"A String",

625

],

626

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

627

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

628

"A String",

629

],

630

},

Bu Sun Kim

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

[diff] [blame]

631

},

Bu Sun Kim

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

[diff] [blame]

632

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

633

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

634

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

635

},

Bu Sun Kim

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

[diff] [blame]

636

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

Bu Sun Kim

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

[diff] [blame]

637

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

Bu Sun Kim

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

[diff] [blame]

638

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

Bu Sun Kim

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

[diff] [blame]

639

{ # Frequency cap.

Bu Sun Kim

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

[diff] [blame]

640

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

Bu Sun Kim

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

[diff] [blame]

641

# specified time period.

Bu Sun Kim

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

[diff] [blame]

642

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

643

# which impressions per user are counted and capped.

Bu Sun Kim

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

[diff] [blame]

644

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

645

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

Bu Sun Kim

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

[diff] [blame]

646

},

647

],

Bu Sun Kim

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

[diff] [blame]

648

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

Bu Sun Kim

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

[diff] [blame]

649

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

Bu Sun Kim

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

[diff] [blame]

650

},

Bu Sun Kim

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

[diff] [blame]

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

# time in seconds.

659

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

660

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

661

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

662

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

663

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

664

# returned.

665

#

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

Bu Sun Kim

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

[diff] [blame]

674

},

Bu Sun Kim

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

[diff] [blame]

675

],

Bu Sun Kim

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

[diff] [blame]

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

#

679

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

680

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

Bu Sun Kim

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

[diff] [blame]

681

},

682

],

Bu Sun Kim

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

[diff] [blame]

683

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

684

# Authorized Buyers account ID.

685

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

686

},

687

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

Bu Sun Kim

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

[diff] [blame]

688

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

689

#

690

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

691

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

692

# Ad Manager account ID.

Bu Sun Kim

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

[diff] [blame]

693

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

694

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

695

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

696

},

Bu Sun Kim

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

[diff] [blame]

697

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

698

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

699

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

700

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

701

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

702

{ # A proposal may be associated to several notes.

703

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

704

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

705

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

706

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

707

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

708

# (max-length: 1024 unicode code units)

709

#

710

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

711

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

712

},

713

],

714

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

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

],

720

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

721

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

722

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

723

},

724

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

725

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

726

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

727

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

728

},

729

],

730

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

731

# proposal.

732

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

733

# proposal.

734

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

735

#

736

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

737

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

738

# Authorized Buyers account ID.

739

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

740

},

741

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

742

# left a comment.

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

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

762

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

763

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

764

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

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

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

783

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

784

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

785

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

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-05-27 12:20:54 -0700

[diff] [blame]

828

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

829

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

830

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

831

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

832

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

833

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

834

# was made.

Bu Sun Kim

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

[diff] [blame]

835

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

Bu Sun Kim

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

[diff] [blame]

836

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

Bu Sun Kim

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

[diff] [blame]

837

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

838

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

839

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

840

# targeting information that is used for serving.

Bu Sun Kim

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

[diff] [blame]

841

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

842

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

843

# deal.

844

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

Bu Sun Kim

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

[diff] [blame]

845

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

846

# PUBLISHER means creative is provided by seller and ADVERTISER means

847

# creative is provided by buyer.

Bu Sun Kim

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

[diff] [blame]

848

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

849

# targeting entity is AND'd together.

850

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

851

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

852

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

853

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

854

# together.

855

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

Bu Sun Kim

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

[diff] [blame]

856

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

857

# Filled in when the key is GOOG_DAYPART_TARGETING.

858

# The definition of this targeting is derived from the structure

859

# used by Ad Manager.

860

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

861

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

862

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

863

# only during certain parts of a day/week.

Bu Sun Kim

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

[diff] [blame]

864

"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

865

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

866

# for filtering in PQL queries.

867

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

868

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

Bu Sun Kim

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

[diff] [blame]

869

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

Bu Sun Kim

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

[diff] [blame]

870

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

871

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

Bu Sun Kim

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

[diff] [blame]

872

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

Bu Sun Kim

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

[diff] [blame]

873

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

874

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

875

},

Bu Sun Kim

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

[diff] [blame]

876

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

877

# The start time is inclusive.

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

},

888

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

Bu Sun Kim

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

[diff] [blame]

889

},

890

],

891

},

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

# Filled in when key = GOOG_CREATIVE_SIZE

895

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

896

# only if creative_size_type = CreativeSizeType.NATIVE.

897

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

898

# of the creative

899

# height depend on the type of the targeting.

900

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

901

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

902

},

903

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

904

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

905

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

906

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

907

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

908

"A String",

909

],

910

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

911

# creative_size_type = CreativeSizeType.VIDEO.

912

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

913

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

914

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

915

# height depend on the type of the targeting.

916

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

917

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

},

],

},

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

922

},

923

],

924

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

925

# together.

926

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

927

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

928

# Filled in when the key is GOOG_DAYPART_TARGETING.

929

# The definition of this targeting is derived from the structure

930

# used by Ad Manager.

931

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

932

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

933

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

934

# only during certain parts of a day/week.

935

"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

936

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

937

# for filtering in PQL queries.

938

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

939

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

940

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

941

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

942

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

943

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

944

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

945

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

946

},

947

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

948

# The start time is inclusive.

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

},

959

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

},

],

},

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

964

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

965

# Filled in when key = GOOG_CREATIVE_SIZE

966

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

967

# only if creative_size_type = CreativeSizeType.NATIVE.

968

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

969

# of the creative

970

# height depend on the type of the targeting.

971

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

972

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

973

},

974

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

975

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

976

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

977

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

978

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

979

"A String",

980

],

981

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

982

# creative_size_type = CreativeSizeType.VIDEO.

983

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

984

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

985

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

986

# height depend on the type of the targeting.

987

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

988

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

993

},

994

],

995

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

996

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

997

# Third parties may define their own keys.

998

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

999

# provided as part of the external documentation.

Bu Sun Kim

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

[diff] [blame]

1000

},

1001

],

1002

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

1003

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

1004

# in Ad Manager.

1005

# Preferred Deal in Ad Manager.

1006

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

1007

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

1008

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

1009

"creativeSpecifications": [

1010

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

1011

# Guaranteed/Preferred Deal in Ad Manager.

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

},

Bu Sun Kim

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

[diff] [blame]

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

},

],

},

],

},

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

1032

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

1033

# The deal is considered paused if either hasBuyerPaused or

1034

# hasSellPaused is true.

1035

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

1036

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

1037

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

1038

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

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

},

Bu Sun Kim

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

[diff] [blame]

1041

},

Bu Sun Kim

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

[diff] [blame]

1042

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

1043

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

1044

# and expected impressions from the publisher.

Bu Sun Kim

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

[diff] [blame]

1045

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

1046

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

1047

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

1048

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

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

1057

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

1058

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

1059

"A String",

1060

],

Bu Sun Kim

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

[diff] [blame]

1061

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

Bu Sun Kim

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

[diff] [blame]

1062

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

Bu Sun Kim

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

[diff] [blame]

1063

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

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

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

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

Bu Sun Kim

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

[diff] [blame]

1072

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

Bu Sun Kim

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

[diff] [blame]

1073

},

Bu Sun Kim

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

[diff] [blame]

1074

},

Bu Sun Kim

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

[diff] [blame]

1075

"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

1076

# (if the

1077

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

1078

# Authorized Buyers account ID.

1079

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

},

},

],

},

Bu Sun Kim

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

[diff] [blame]

1084

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

1085

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

1086

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

1087

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

1088

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

Bu Sun Kim

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

[diff] [blame]

1089

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

1090

# Can be set by buyer or seller.

1091

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

1092

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

1093

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

1094

# in this private auction.

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

1102

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

1103

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

1104

"A String",

1105

],

Bu Sun Kim

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

[diff] [blame]

1106

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

Bu Sun Kim

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

[diff] [blame]

1107

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

Bu Sun Kim

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

[diff] [blame]

1108

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

Bu Sun Kim

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

[diff] [blame]

1109

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

1110

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

Bu Sun Kim

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

[diff] [blame]

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

Bu Sun Kim

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

[diff] [blame]

1117

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

Bu Sun Kim

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

[diff] [blame]

1118

},

Bu Sun Kim

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

[diff] [blame]

1119

},

Bu Sun Kim

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

[diff] [blame]

1120

"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

1121

# (if the

1122

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

1123

# Authorized Buyers account ID.

1124

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

},

},

],

},

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

# for a matching rule where no buyer is set.

Bu Sun Kim

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

[diff] [blame]

1138

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

1139

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

1140

"A String",

1141

],

Bu Sun Kim

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

[diff] [blame]

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

},

1155

},

Bu Sun Kim

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

[diff] [blame]

1156

"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

1157

# (if the

1158

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

1159

# Authorized Buyers account ID.

1160

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

},

},

],

},

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

1166

# Can be set by buyer or seller.

Bu Sun Kim

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

[diff] [blame]

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1169

"units": "A String", # The whole units of the amount.

1170

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1171

"nanos": 42, # Number of nano (10^-9) units of the amount.

1172

# The value must be between -999,999,999 and +999,999,999 inclusive.

1173

# If `units` is positive, `nanos` must be positive or zero.

1174

# If `units` is zero, `nanos` can be positive, zero, or negative.

1175

# If `units` is negative, `nanos` must be negative or zero.

1176

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1177

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1179

},

1180

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1181

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1182

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

1183

# finalized. This is the deal ID that shows up in serving/reporting etc.

1184

"createProductId": "A String", # The product ID from which this deal was created.

1185

#

1186

# Note: This field may be set only when creating the resource. Modifying

1187

# this field while updating the resource will result in an error.

1188

"updateTime": "A String", # Output only. The time when the deal was last updated.

1189

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1190

"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]

1191

# target ad inventory. For example, they can choose to target ad requests only

1192

# if the user is in the US.

1193

# Multiple types of targeting are always applied as a logical AND, unless noted

1194

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1195

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

1196

# mobile applications.

1197

# Different placement targeting types will be logically OR'ed.

1198

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

1199

# For Private Auction and AdX Preferred Deals, URLs are either included or

1200

# excluded.

1201

# For Programmatic Guaranteed and Preferred Deals, this doesn't

1202

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1203

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1204

"A String",

1205

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1206

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

1211

# This doesn't apply to Auction Packages.

1212

"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]

1213

# display the ads in.

1214

# publishers own.

1215

# Mobile application IDs are from App Store and Google Play Store.

1216

# Android App ID, for example, com.google.android.apps.maps, can be found in

1217

# Google Play Store URL.

1218

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

1219

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1220

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1222

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1223

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1224

"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]

1229

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

1230

# request. It only applies to Private Auction, AdX Preferred Deals and

1231

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

1232

# and Preferred Deals in Ad Manager.

1233

"targetedInventorySizes": [ # A list of inventory sizes to be included.

1234

{ # Represents size of a single ad slot, or a creative.

1235

"width": "A String", # The width of the ad slot in pixels.

1236

# This field will be present only when size type is `PIXEL`.

1237

"height": "A String", # The height of the ad slot in pixels.

1238

# This field will be present only when size type is `PIXEL`.

1239

"sizeType": "A String", # The size type of the ad slot.

1240

},

1241

],

1242

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

1243

{ # Represents size of a single ad slot, or a creative.

1244

"width": "A String", # The width of the ad slot in pixels.

1245

# This field will be present only when size type is `PIXEL`.

1246

"height": "A String", # The height of the ad slot in pixels.

1247

# This field will be present only when size type is `PIXEL`.

1248

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

1253

# included and excluded numeric IDs.

1254

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1255

"A String",

1256

],

1257

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

1262

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

1263

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

1264

# included and excluded numeric IDs.

1265

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1266

"A String",

1267

],

1268

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

1273

# included and excluded numeric IDs.

1274

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1275

"A String",

1276

],

1277

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

1283

# included and excluded numeric IDs.

1284

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1285

"A String",

1286

],

1287

"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.

1292

# included and excluded numeric IDs.

1293

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1294

"A String",

1295

],

1296

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

1302

"targetedPositionTypes": [ # A list of video positions to be included.

1303

# When the included list is present, the excluded list must be empty.

1304

# When the excluded list is present, the included list must be empty.

1305

"A String",

1306

],

1307

"excludedPositionTypes": [ # A list of video positions to be excluded.

1308

# Position types can either be included or excluded (XOR).

1309

"A String",

1310

],

1311

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1312

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1313

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

1314

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1315

# operations (max-length: 1024 unicode code units).

1316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1317

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1318

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1319

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1320

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1321

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1322

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1323

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1324

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1325

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

1326

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1327

},

1328

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1329

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1330

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1331

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1332

"availableEndTime": "A String", # Proposed flight end time of the deal.

1333

# This will generally be stored in a granularity of a second.

1334

# A value is not required for Private Auction deals or Preferred Deals.

1335

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

1336

# This will generally be stored in the granularity of one second since deal

1337

# serving starts at seconds boundary. Any time specified with more

1338

# granularity (e.g., in milliseconds) will be truncated towards the start of

1339

# time in seconds.

1340

"displayName": "A String", # The name of the deal.

1341

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

1342

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

1343

# If present on create, and the server `product_revision` has advanced sinced

1344

# the passed-in `create_product_revision`, an `ABORTED` error will be

1345

# returned.

1346

#

1347

# Note: This field may be set only when creating the resource. Modifying

1348

# this field while updating the resource will result in an error.

1349

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1350

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

1351

"sellerContacts": [ # Output only. Seller contact information for the deal.

1352

{ # Contains information on how a buyer or seller can be reached.

1353

"name": "A String", # The name of the contact.

1354

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1355

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1356

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1357

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1358

"syndicationProduct": "A String", # The syndication product associated with the deal.

1359

#

1360

# Note: This field may be set only when creating the resource. Modifying

1361

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1362

},

1363

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1364

"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.

1365

# Authorized Buyers account ID.

1366

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1367

},

1368

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"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]

1370

#

1371

# Note: This field may be set only when creating the resource. Modifying

1372

# this field while updating the resource will result in an error.

1373

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

"subAccountId": "A String", # Optional sub-account ID for the seller.

1375

"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]

1376

# The seller account ID is then available to buyer in the product.

1377

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1378

"updateTime": "A String", # Output only. The time when the proposal was last revised.

1379

"proposalId": "A String", # Output only. The unique ID of the proposal.

1380

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

1381

"proposalState": "A String", # Output only. The current state of the proposal.

1382

"notes": [ # Output only. The notes associated with this proposal.

1383

{ # A proposal may be associated to several notes.

1384

"noteId": "A String", # Output only. The unique ID for the note.

1385

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

1386

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

1387

"createTime": "A String", # Output only. The timestamp for when this note was created.

1388

"note": "A String", # The actual note to attach.

1389

# (max-length: 1024 unicode code units)

1390

#

1391

# Note: This field may be set only when creating the resource. Modifying

1392

# this field while updating the resource will result in an error.

1393

},

1394

],

1395

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

1401

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

1402

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1403

# operations (max-length: 1024 unicode code units).

1404

},

1405

"buyerContacts": [ # Contact information for the buyer.

1406

{ # Contains information on how a buyer or seller can be reached.

1407

"name": "A String", # The name of the contact.

1408

"email": "A String", # Email address for the contact.

1409

},

1410

],

1411

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

1412

# proposal.

1413

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1414

# proposal.

1415

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

1416

#

1417

# Note: This field may be set only when creating the resource. Modifying

1418

# this field while updating the resource will result in an error.

1419

# Authorized Buyers account ID.

1420

"accountId": "A String", # Authorized Buyers account ID of the buyer.

1421

},

1422

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

1423

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</code>

1429

<pre>Update the given proposal to indicate that setup has been completed.

1430

This method is called by the buyer when the line items have been created

1431

on their end for a finalized proposal and all the required creatives

1432

have been uploaded using the creatives API. This call updates the

1433

`is_setup_completed` bit on the proposal and also notifies the seller.

1434

The server will advance the revision number of the most recent proposal.

1435

1436

Args:

1437

accountId: string, Account ID of the buyer. (required)

1438

proposalId: string, The ID of the proposal to mark as setup completed. (required)

1439

body: object, The request body.

1440

The object takes the form of:

1441

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

{ # Request message for indicating that the proposal's setup step is complete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1443

}

1444

1445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1452

1453

{ # Note: this resource requires whitelisting for access. Please contact your

1454

# account manager for access to Marketplace resources.

1455

#

1456

# Represents a proposal in the Marketplace. A proposal is the unit of

1457

# negotiation between a seller and a buyer and contains deals which

1458

# are served.

1459

#

1460

# Note: you can not update, create, or otherwise modify Private

1461

# Auction or Preferred Deals deals through the API.

1462

#

1463

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1464

"proposalRevision": "A String", # Output only. The revision number for the proposal.

1465

# Each update to the proposal or the deal causes the proposal revision number

1466

# to auto-increment. The buyer keeps track of the last revision number they

1467

# know of and pass it in when making an update. If the head revision number

1468

# on the server has since incremented, then an ABORTED error is returned

1469

# during the update operation to let the buyer know that a subsequent update

1470

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1471

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

1474

{ # A deal represents a segment of inventory for displaying ads on.

1475

# A proposal can contain multiple deals. A deal contains the terms and

1476

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1477

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

1478

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

1479

# deal.

1480

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1481

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

1482

# PUBLISHER means creative is provided by seller and ADVERTISER means

1483

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

1485

# targeting entity is AND'd together.

1486

{ # Advertisers can target different attributes of an ad slot. For example,

1487

# they can choose to show ads only if the user is in the U.S. Such

1488

# targeting criteria can be specified as part of Shared Targeting.

1489

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

1490

# together.

1491

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1493

# Filled in when the key is GOOG_DAYPART_TARGETING.

1494

# The definition of this targeting is derived from the structure

1495

# used by Ad Manager.

1496

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1497

"dayParts": [ # A list of day part targeting criterion.

1498

{ # Daypart targeting message that specifies if the ad can be shown

1499

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1500

"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

1501

# granularity). The end time is exclusive. This field is not available

1502

# for filtering in PQL queries.

1503

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1504

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1505

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1506

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1507

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1508

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1509

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1510

# allow the value 60 if it allows leap-seconds.

1511

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1512

"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).

1513

# The start time is inclusive.

1514

# This field is not available for filtering in PQL queries.

1515

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1516

# types are google.type.Date and `google.protobuf.Timestamp`.

1517

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1518

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1519

# to allow the value "24:00:00" for scenarios like business closing time.

1520

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1521

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1522

# allow the value 60 if it allows leap-seconds.

1523

},

1524

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1525

},

1526

],

1527

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1528

"longValue": "A String", # The long value to include/exclude.

1529

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1530

# Filled in when key = GOOG_CREATIVE_SIZE

1531

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1532

# only if creative_size_type = CreativeSizeType.NATIVE.

1533

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1534

# of the creative

1535

# height depend on the type of the targeting.

1536

"width": 42, # The width of the creative

1537

"height": 42, # The height of the creative.

1538

},

1539

"creativeSizeType": "A String", # The creative size type.

1540

"allowedFormats": [ # What formats are allowed by the publisher.

1541

# If this repeated field is empty then all formats are allowed.

1542

# For example, if this field contains AllowedFormatType.AUDIO then the

1543

# publisher only allows an audio ad (without any video).

1544

"A String",

1545

],

1546

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1547

# creative_size_type = CreativeSizeType.VIDEO.

1548

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1549

# Companion sizes may be filled in only when creative_size_type = VIDEO

1550

{ # Message depicting the size of the creative. The units of width and

1551

# height depend on the type of the targeting.

1552

"width": 42, # The width of the creative

1553

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

1558

},

1559

],

1560

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

1561

# together.

1562

{ # A polymorphic targeting value used as part of Shared Targeting.

1563

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

1564

# Filled in when the key is GOOG_DAYPART_TARGETING.

1565

# The definition of this targeting is derived from the structure

1566

# used by Ad Manager.

1567

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

1568

"dayParts": [ # A list of day part targeting criterion.

1569

{ # Daypart targeting message that specifies if the ad can be shown

1570

# only during certain parts of a day/week.

1571

"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

1572

# granularity). The end time is exclusive. This field is not available

1573

# for filtering in PQL queries.

1574

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1575

# types are google.type.Date and `google.protobuf.Timestamp`.

1576

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1577

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1578

# to allow the value "24:00:00" for scenarios like business closing time.

1579

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1580

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1581

# allow the value 60 if it allows leap-seconds.

1582

},

1583

"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).

1584

# The start time is inclusive.

1585

# This field is not available for filtering in PQL queries.

1586

# or are specified elsewhere. An API may choose to allow leap seconds. Related

1587

# types are google.type.Date and `google.protobuf.Timestamp`.

1588

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

1589

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

1590

# to allow the value "24:00:00" for scenarios like business closing time.

1591

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

1592

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

1593

# allow the value 60 if it allows leap-seconds.

1594

},

1595

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

1600

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

1601

# Filled in when key = GOOG_CREATIVE_SIZE

1602

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

1603

# only if creative_size_type = CreativeSizeType.NATIVE.

1604

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

1605

# of the creative

1606

# height depend on the type of the targeting.

1607

"width": 42, # The width of the creative

1608

"height": 42, # The height of the creative.

1609

},

1610

"creativeSizeType": "A String", # The creative size type.

1611

"allowedFormats": [ # What formats are allowed by the publisher.

1612

# If this repeated field is empty then all formats are allowed.

1613

# For example, if this field contains AllowedFormatType.AUDIO then the

1614

# publisher only allows an audio ad (without any video).

1615

"A String",

1616

],

1617

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

1618

# creative_size_type = CreativeSizeType.VIDEO.

1619

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

1620

# Companion sizes may be filled in only when creative_size_type = VIDEO

1621

{ # Message depicting the size of the creative. The units of width and

1622

# height depend on the type of the targeting.

1623

"width": 42, # The width of the creative

1624

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

},

1630

],

1631

"key": "A String", # The key representing the shared targeting criterion.

1632

# Targeting criteria defined by Google ad servers will begin with GOOG_.

1633

# Third parties may define their own keys.

1634

# A list of permissible keys along with the acceptable values will be

1635

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1636

},

1637

],

1638

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

1639

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

1640

# in Ad Manager.

1641

# Preferred Deal in Ad Manager.

1642

# This doesn't apply to Private Auction and AdX Preferred Deals.

1643

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

1644

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

1645

"creativeSpecifications": [

1646

{ # Represents information for a creative that is associated with a Programmatic

1647

# Guaranteed/Preferred Deal in Ad Manager.

1648

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

1649

"width": "A String", # The width of the ad slot in pixels.

1650

# This field will be present only when size type is `PIXEL`.

1651

"height": "A String", # The height of the ad slot in pixels.

1652

# This field will be present only when size type is `PIXEL`.

1653

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1654

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1655

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

1656

{ # Represents size of a single ad slot, or a creative.

1657

"width": "A String", # The width of the ad slot in pixels.

1658

# This field will be present only when size type is `PIXEL`.

1659

"height": "A String", # The height of the ad slot in pixels.

1660

# This field will be present only when size type is `PIXEL`.

1661

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

1668

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

1669

# The deal is considered paused if either hasBuyerPaused or

1670

# hasSellPaused is true.

1671

"firstPausedBy": "A String", # The role of the person who first paused this deal.

1672

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

1673

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

1674

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

1675

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1677

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1678

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

1679

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

1680

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1681

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

1682

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

1683

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

1684

# of guaranteed looks that the buyer is guaranteeing to buy.

1685

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1686

"fixedPrices": [ # Fixed price for the specified buyer.

1687

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1688

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1689

# a particular buyer or buyer/advertiser pair, we look for the most specific

1690

# matching rule - we first look for a rule matching the buyer and advertiser,

1691

# next a rule with the buyer but an empty advertiser list, and otherwise look

1692

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1693

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1694

# If empty, all advertisers with this buyer pay this price.

1695

"A String",

1696

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1697

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1698

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1699

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1700

"units": "A String", # The whole units of the amount.

1701

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1702

"nanos": 42, # Number of nano (10^-9) units of the amount.

1703

# The value must be between -999,999,999 and +999,999,999 inclusive.

1704

# If `units` is positive, `nanos` must be positive or zero.

1705

# If `units` is zero, `nanos` can be positive, zero, or negative.

1706

# If `units` is negative, `nanos` must be negative or zero.

1707

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1708

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1709

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1711

"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

1712

# (if the

1713

# advertisers match, and there's no more specific rule matching the buyer).

1714

# Authorized Buyers account ID.

1715

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1720

"description": "A String", # Publisher provided description for the terms.

1721

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

1722

# time zone used to mark the boundaries of a day. It should be an

1723

# IANA TZ name, such as "America/Los_Angeles". For more information,

1724

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1725

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

1726

# Can be set by buyer or seller.

1727

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

1728

# by the seller, but they can be returned in a get or list request.

1729

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

1730

# in this private auction.

1731

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

1732

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1733

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1734

# a particular buyer or buyer/advertiser pair, we look for the most specific

1735

# matching rule - we first look for a rule matching the buyer and advertiser,

1736

# next a rule with the buyer but an empty advertiser list, and otherwise look

1737

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1738

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1739

# If empty, all advertisers with this buyer pay this price.

1740

"A String",

1741

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1742

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1743

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1744

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1745

"units": "A String", # The whole units of the amount.

1746

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1747

"nanos": 42, # Number of nano (10^-9) units of the amount.

1748

# The value must be between -999,999,999 and +999,999,999 inclusive.

1749

# If `units` is positive, `nanos` must be positive or zero.

1750

# If `units` is zero, `nanos` can be positive, zero, or negative.

1751

# If `units` is negative, `nanos` must be negative or zero.

1752

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1753

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1754

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1756

"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

1757

# (if the

1758

# advertisers match, and there's no more specific rule matching the buyer).

1759

# Authorized Buyers account ID.

1760

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

1766

# the API at this time, but can be returned in a get or list request.

1767

"fixedPrices": [ # Fixed price for the specified buyer.

1768

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

1769

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

1770

# a particular buyer or buyer/advertiser pair, we look for the most specific

1771

# matching rule - we first look for a rule matching the buyer and advertiser,

1772

# next a rule with the buyer but an empty advertiser list, and otherwise look

1773

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1774

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

1775

# If empty, all advertisers with this buyer pay this price.

1776

"A String",

1777

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1778

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

1779

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

1780

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

1781

"units": "A String", # The whole units of the amount.

1782

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1783

"nanos": 42, # Number of nano (10^-9) units of the amount.

1784

# The value must be between -999,999,999 and +999,999,999 inclusive.

1785

# If `units` is positive, `nanos` must be positive or zero.

1786

# If `units` is zero, `nanos` can be positive, zero, or negative.

1787

# If `units` is negative, `nanos` must be negative or zero.

1788

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1789

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1790

},

1791

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1792

"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

1793

# (if the

1794

# advertisers match, and there's no more specific rule matching the buyer).

1795

# Authorized Buyers account ID.

1796

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

1802

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1803

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1804

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1805

"units": "A String", # The whole units of the amount.

1806

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1807

"nanos": 42, # Number of nano (10^-9) units of the amount.

1808

# The value must be between -999,999,999 and +999,999,999 inclusive.

1809

# If `units` is positive, `nanos` must be positive or zero.

1810

# If `units` is zero, `nanos` can be positive, zero, or negative.

1811

# If `units` is negative, `nanos` must be negative or zero.

1812

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1813

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1814

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1815

},

1816

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1817

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1818

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

1819

# finalized. This is the deal ID that shows up in serving/reporting etc.

1820

"createProductId": "A String", # The product ID from which this deal was created.

1821

#

1822

# Note: This field may be set only when creating the resource. Modifying

1823

# this field while updating the resource will result in an error.

1824

"updateTime": "A String", # Output only. The time when the deal was last updated.

1825

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

"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]

1827

# target ad inventory. For example, they can choose to target ad requests only

1828

# if the user is in the US.

1829

# Multiple types of targeting are always applied as a logical AND, unless noted

1830

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1831

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

1832

# mobile applications.

1833

# Different placement targeting types will be logically OR'ed.

1834

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

1835

# For Private Auction and AdX Preferred Deals, URLs are either included or

1836

# excluded.

1837

# For Programmatic Guaranteed and Preferred Deals, this doesn't

1838

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1839

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1840

"A String",

1841

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1842

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

1847

# This doesn't apply to Auction Packages.

1848

"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]

1849

# display the ads in.

1850

# publishers own.

1851

# Mobile application IDs are from App Store and Google Play Store.

1852

# Android App ID, for example, com.google.android.apps.maps, can be found in

1853

# Google Play Store URL.

1854

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

1855

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1856

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1857

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1858

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1859

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1860

"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]

1865

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

1866

# request. It only applies to Private Auction, AdX Preferred Deals and

1867

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

1868

# and Preferred Deals in Ad Manager.

1869

"targetedInventorySizes": [ # A list of inventory sizes to be included.

1870

{ # Represents size of a single ad slot, or a creative.

1871

"width": "A String", # The width of the ad slot in pixels.

1872

# This field will be present only when size type is `PIXEL`.

1873

"height": "A String", # The height of the ad slot in pixels.

1874

# This field will be present only when size type is `PIXEL`.

1875

"sizeType": "A String", # The size type of the ad slot.

1876

},

1877

],

1878

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

1879

{ # Represents size of a single ad slot, or a creative.

1880

"width": "A String", # The width of the ad slot in pixels.

1881

# This field will be present only when size type is `PIXEL`.

1882

"height": "A String", # The height of the ad slot in pixels.

1883

# This field will be present only when size type is `PIXEL`.

1884

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

1889

# included and excluded numeric IDs.

1890

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1891

"A String",

1892

],

1893

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

1898

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

1899

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

1900

# included and excluded numeric IDs.

1901

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1902

"A String",

1903

],

1904

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

1909

# included and excluded numeric IDs.

1910

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1911

"A String",

1912

],

1913

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

1919

# included and excluded numeric IDs.

1920

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1921

"A String",

1922

],

1923

"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.

1928

# included and excluded numeric IDs.

1929

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

1930

"A String",

1931

],

1932

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

1938

"targetedPositionTypes": [ # A list of video positions to be included.

1939

# When the included list is present, the excluded list must be empty.

1940

# When the excluded list is present, the included list must be empty.

1941

"A String",

1942

],

1943

"excludedPositionTypes": [ # A list of video positions to be excluded.

1944

# Position types can either be included or excluded (XOR).

1945

"A String",

1946

],

1947

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1948

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1949

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

1950

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

1951

# operations (max-length: 1024 unicode code units).

1952

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1953

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1954

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1955

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1956

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1957

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1958

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1959

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

1960

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1961

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

1962

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1963

},

1964

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1965

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1966

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1967

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1968

"availableEndTime": "A String", # Proposed flight end time of the deal.

1969

# This will generally be stored in a granularity of a second.

1970

# A value is not required for Private Auction deals or Preferred Deals.

1971

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

1972

# This will generally be stored in the granularity of one second since deal

1973

# serving starts at seconds boundary. Any time specified with more

1974

# granularity (e.g., in milliseconds) will be truncated towards the start of

1975

# time in seconds.

1976

"displayName": "A String", # The name of the deal.

1977

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

1978

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

1979

# If present on create, and the server `product_revision` has advanced sinced

1980

# the passed-in `create_product_revision`, an `ABORTED` error will be

1981

# returned.

1982

#

1983

# Note: This field may be set only when creating the resource. Modifying

1984

# this field while updating the resource will result in an error.

1985

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

1986

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

1987

"sellerContacts": [ # Output only. Seller contact information for the deal.

1988

{ # Contains information on how a buyer or seller can be reached.

1989

"name": "A String", # The name of the contact.

1990

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1991

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1992

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1993

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1994

"syndicationProduct": "A String", # The syndication product associated with the deal.

1995

#

1996

# Note: This field may be set only when creating the resource. Modifying

1997

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1998

},

1999

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2000

"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.

2001

# Authorized Buyers account ID.

2002

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2003

},

2004

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2005

"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]

2006

#

2007

# Note: This field may be set only when creating the resource. Modifying

2008

# this field while updating the resource will result in an error.

2009

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2010

"subAccountId": "A String", # Optional sub-account ID for the seller.

2011

"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]

2012

# The seller account ID is then available to buyer in the product.

2013

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2014

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2015

"proposalId": "A String", # Output only. The unique ID of the proposal.

2016

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2017

"proposalState": "A String", # Output only. The current state of the proposal.

2018

"notes": [ # Output only. The notes associated with this proposal.

2019

{ # A proposal may be associated to several notes.

2020

"noteId": "A String", # Output only. The unique ID for the note.

2021

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2022

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2023

"createTime": "A String", # Output only. The timestamp for when this note was created.

2024

"note": "A String", # The actual note to attach.

2025

# (max-length: 1024 unicode code units)

2026

#

2027

# Note: This field may be set only when creating the resource. Modifying

2028

# this field while updating the resource will result in an error.

2029

},

2030

],

2031

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

2037

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2038

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2039

# operations (max-length: 1024 unicode code units).

2040

},

2041

"buyerContacts": [ # Contact information for the buyer.

2042

{ # Contains information on how a buyer or seller can be reached.

2043

"name": "A String", # The name of the contact.

2044

"email": "A String", # Email address for the contact.

2045

},

2046

],

2047

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2048

# proposal.

2049

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2050

# proposal.

2051

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2052

#

2053

# Note: This field may be set only when creating the resource. Modifying

2054

# this field while updating the resource will result in an error.

2055

# Authorized Buyers account ID.

2056

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2057

},

2058

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2059

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2064

<code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2065

<pre>Create the given proposal. Each created proposal and any deals it contains

2066

are assigned a unique ID by the server.

2067

2068

Args:

2069

accountId: string, Account ID of the buyer. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2070

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2071

The object takes the form of:

2072

2073

{ # Note: this resource requires whitelisting for access. Please contact your

2074

# account manager for access to Marketplace resources.

2075

#

2076

# Represents a proposal in the Marketplace. A proposal is the unit of

2077

# negotiation between a seller and a buyer and contains deals which

2078

# are served.

2079

#

2080

# Note: you can not update, create, or otherwise modify Private

2081

# Auction or Preferred Deals deals through the API.

2082

#

2083

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2084

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2085

# Each update to the proposal or the deal causes the proposal revision number

2086

# to auto-increment. The buyer keeps track of the last revision number they

2087

# know of and pass it in when making an update. If the head revision number

2088

# on the server has since incremented, then an ABORTED error is returned

2089

# during the update operation to let the buyer know that a subsequent update

2090

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2091

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2092

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2093

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2094

{ # A deal represents a segment of inventory for displaying ads on.

2095

# A proposal can contain multiple deals. A deal contains the terms and

2096

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2097

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2098

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2099

# deal.

2100

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2101

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2102

# PUBLISHER means creative is provided by seller and ADVERTISER means

2103

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2104

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2105

# targeting entity is AND'd together.

2106

{ # Advertisers can target different attributes of an ad slot. For example,

2107

# they can choose to show ads only if the user is in the U.S. Such

2108

# targeting criteria can be specified as part of Shared Targeting.

2109

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2110

# together.

2111

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2112

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2113

# Filled in when the key is GOOG_DAYPART_TARGETING.

2114

# The definition of this targeting is derived from the structure

2115

# used by Ad Manager.

2116

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2117

"dayParts": [ # A list of day part targeting criterion.

2118

{ # Daypart targeting message that specifies if the ad can be shown

2119

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

"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

2121

# granularity). The end time is exclusive. This field is not available

2122

# for filtering in PQL queries.

2123

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2124

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2125

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2126

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2127

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2128

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2130

# allow the value 60 if it allows leap-seconds.

2131

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2132

"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).

2133

# The start time is inclusive.

2134

# This field is not available for filtering in PQL queries.

2135

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2136

# types are google.type.Date and `google.protobuf.Timestamp`.

2137

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2138

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2139

# to allow the value "24:00:00" for scenarios like business closing time.

2140

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2141

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2142

# allow the value 60 if it allows leap-seconds.

2143

},

2144

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2145

},

2146

],

2147

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2148

"longValue": "A String", # The long value to include/exclude.

2149

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2150

# Filled in when key = GOOG_CREATIVE_SIZE

2151

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2152

# only if creative_size_type = CreativeSizeType.NATIVE.

2153

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2154

# of the creative

2155

# height depend on the type of the targeting.

2156

"width": 42, # The width of the creative

2157

"height": 42, # The height of the creative.

2158

},

2159

"creativeSizeType": "A String", # The creative size type.

2160

"allowedFormats": [ # What formats are allowed by the publisher.

2161

# If this repeated field is empty then all formats are allowed.

2162

# For example, if this field contains AllowedFormatType.AUDIO then the

2163

# publisher only allows an audio ad (without any video).

2164

"A String",

2165

],

2166

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2167

# creative_size_type = CreativeSizeType.VIDEO.

2168

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2169

# Companion sizes may be filled in only when creative_size_type = VIDEO

2170

{ # Message depicting the size of the creative. The units of width and

2171

# height depend on the type of the targeting.

2172

"width": 42, # The width of the creative

2173

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

2178

},

2179

],

2180

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2181

# together.

2182

{ # A polymorphic targeting value used as part of Shared Targeting.

2183

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2184

# Filled in when the key is GOOG_DAYPART_TARGETING.

2185

# The definition of this targeting is derived from the structure

2186

# used by Ad Manager.

2187

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2188

"dayParts": [ # A list of day part targeting criterion.

2189

{ # Daypart targeting message that specifies if the ad can be shown

2190

# only during certain parts of a day/week.

2191

"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

2192

# granularity). The end time is exclusive. This field is not available

2193

# for filtering in PQL queries.

2194

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2195

# types are google.type.Date and `google.protobuf.Timestamp`.

2196

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2197

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2198

# to allow the value "24:00:00" for scenarios like business closing time.

2199

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2200

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2201

# allow the value 60 if it allows leap-seconds.

2202

},

2203

"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).

2204

# The start time is inclusive.

2205

# This field is not available for filtering in PQL queries.

2206

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2207

# types are google.type.Date and `google.protobuf.Timestamp`.

2208

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2209

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2210

# to allow the value "24:00:00" for scenarios like business closing time.

2211

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2212

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2213

# allow the value 60 if it allows leap-seconds.

2214

},

2215

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

2220

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2221

# Filled in when key = GOOG_CREATIVE_SIZE

2222

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2223

# only if creative_size_type = CreativeSizeType.NATIVE.

2224

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2225

# of the creative

2226

# height depend on the type of the targeting.

2227

"width": 42, # The width of the creative

2228

"height": 42, # The height of the creative.

2229

},

2230

"creativeSizeType": "A String", # The creative size type.

2231

"allowedFormats": [ # What formats are allowed by the publisher.

2232

# If this repeated field is empty then all formats are allowed.

2233

# For example, if this field contains AllowedFormatType.AUDIO then the

2234

# publisher only allows an audio ad (without any video).

2235

"A String",

2236

],

2237

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2238

# creative_size_type = CreativeSizeType.VIDEO.

2239

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2240

# Companion sizes may be filled in only when creative_size_type = VIDEO

2241

{ # Message depicting the size of the creative. The units of width and

2242

# height depend on the type of the targeting.

2243

"width": 42, # The width of the creative

2244

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

},

2250

],

2251

"key": "A String", # The key representing the shared targeting criterion.

2252

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2253

# Third parties may define their own keys.

2254

# A list of permissible keys along with the acceptable values will be

2255

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2256

},

2257

],

2258

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2259

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2260

# in Ad Manager.

2261

# Preferred Deal in Ad Manager.

2262

# This doesn't apply to Private Auction and AdX Preferred Deals.

2263

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2264

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2265

"creativeSpecifications": [

2266

{ # Represents information for a creative that is associated with a Programmatic

2267

# Guaranteed/Preferred Deal in Ad Manager.

2268

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2269

"width": "A String", # The width of the ad slot in pixels.

2270

# This field will be present only when size type is `PIXEL`.

2271

"height": "A String", # The height of the ad slot in pixels.

2272

# This field will be present only when size type is `PIXEL`.

2273

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2274

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2275

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2276

{ # Represents size of a single ad slot, or a creative.

2277

"width": "A String", # The width of the ad slot in pixels.

2278

# This field will be present only when size type is `PIXEL`.

2279

"height": "A String", # The height of the ad slot in pixels.

2280

# This field will be present only when size type is `PIXEL`.

2281

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2288

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2289

# The deal is considered paused if either hasBuyerPaused or

2290

# hasSellPaused is true.

2291

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2292

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2293

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2294

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2295

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2296

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2297

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2298

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2299

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2300

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2301

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2302

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2303

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2304

# of guaranteed looks that the buyer is guaranteeing to buy.

2305

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2306

"fixedPrices": [ # Fixed price for the specified buyer.

2307

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2308

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2309

# a particular buyer or buyer/advertiser pair, we look for the most specific

2310

# matching rule - we first look for a rule matching the buyer and advertiser,

2311

# next a rule with the buyer but an empty advertiser list, and otherwise look

2312

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2313

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2314

# If empty, all advertisers with this buyer pay this price.

2315

"A String",

2316

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2317

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2318

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2319

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2320

"units": "A String", # The whole units of the amount.

2321

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2322

"nanos": 42, # Number of nano (10^-9) units of the amount.

2323

# The value must be between -999,999,999 and +999,999,999 inclusive.

2324

# If `units` is positive, `nanos` must be positive or zero.

2325

# If `units` is zero, `nanos` can be positive, zero, or negative.

2326

# If `units` is negative, `nanos` must be negative or zero.

2327

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2328

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2329

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2331

"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

2332

# (if the

2333

# advertisers match, and there's no more specific rule matching the buyer).

2334

# Authorized Buyers account ID.

2335

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2340

"description": "A String", # Publisher provided description for the terms.

2341

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2342

# time zone used to mark the boundaries of a day. It should be an

2343

# IANA TZ name, such as "America/Los_Angeles". For more information,

2344

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2346

# Can be set by buyer or seller.

2347

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

2348

# by the seller, but they can be returned in a get or list request.

2349

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

2350

# in this private auction.

2351

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

2352

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2353

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2354

# a particular buyer or buyer/advertiser pair, we look for the most specific

2355

# matching rule - we first look for a rule matching the buyer and advertiser,

2356

# next a rule with the buyer but an empty advertiser list, and otherwise look

2357

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2358

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2359

# If empty, all advertisers with this buyer pay this price.

2360

"A String",

2361

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2362

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2363

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2364

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2365

"units": "A String", # The whole units of the amount.

2366

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2367

"nanos": 42, # Number of nano (10^-9) units of the amount.

2368

# The value must be between -999,999,999 and +999,999,999 inclusive.

2369

# If `units` is positive, `nanos` must be positive or zero.

2370

# If `units` is zero, `nanos` can be positive, zero, or negative.

2371

# If `units` is negative, `nanos` must be negative or zero.

2372

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2373

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2374

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2375

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2376

"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

2377

# (if the

2378

# advertisers match, and there's no more specific rule matching the buyer).

2379

# Authorized Buyers account ID.

2380

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

2386

# the API at this time, but can be returned in a get or list request.

2387

"fixedPrices": [ # Fixed price for the specified buyer.

2388

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2389

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2390

# a particular buyer or buyer/advertiser pair, we look for the most specific

2391

# matching rule - we first look for a rule matching the buyer and advertiser,

2392

# next a rule with the buyer but an empty advertiser list, and otherwise look

2393

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2394

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2395

# If empty, all advertisers with this buyer pay this price.

2396

"A String",

2397

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2398

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

2399

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

2400

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

2401

"units": "A String", # The whole units of the amount.

2402

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

2403

"nanos": 42, # Number of nano (10^-9) units of the amount.

2404

# The value must be between -999,999,999 and +999,999,999 inclusive.

2405

# If `units` is positive, `nanos` must be positive or zero.

2406

# If `units` is zero, `nanos` can be positive, zero, or negative.

2407

# If `units` is negative, `nanos` must be negative or zero.

2408

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

2409

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

2410

},

2411

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2412

"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

2413

# (if the

2414

# advertisers match, and there's no more specific rule matching the buyer).

2415

# Authorized Buyers account ID.

2416

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

2422

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2423

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2424

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2425

"units": "A String", # The whole units of the amount.

2426

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2427

"nanos": 42, # Number of nano (10^-9) units of the amount.

2428

# The value must be between -999,999,999 and +999,999,999 inclusive.

2429

# If `units` is positive, `nanos` must be positive or zero.

2430

# If `units` is zero, `nanos` can be positive, zero, or negative.

2431

# If `units` is negative, `nanos` must be negative or zero.

2432

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2433

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2434

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2435

},

2436

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2437

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2438

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

2439

# finalized. This is the deal ID that shows up in serving/reporting etc.

2440

"createProductId": "A String", # The product ID from which this deal was created.

2441

#

2442

# Note: This field may be set only when creating the resource. Modifying

2443

# this field while updating the resource will result in an error.

2444

"updateTime": "A String", # Output only. The time when the deal was last updated.

2445

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2446

"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]

2447

# target ad inventory. For example, they can choose to target ad requests only

2448

# if the user is in the US.

2449

# Multiple types of targeting are always applied as a logical AND, unless noted

2450

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

2452

# mobile applications.

2453

# Different placement targeting types will be logically OR'ed.

2454

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

2455

# For Private Auction and AdX Preferred Deals, URLs are either included or

2456

# excluded.

2457

# For Programmatic Guaranteed and Preferred Deals, this doesn't

2458

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2459

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2460

"A String",

2461

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2462

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

2467

# This doesn't apply to Auction Packages.

2468

"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]

2469

# display the ads in.

2470

# publishers own.

2471

# Mobile application IDs are from App Store and Google Play Store.

2472

# Android App ID, for example, com.google.android.apps.maps, can be found in

2473

# Google Play Store URL.

2474

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

2475

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2476

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2477

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2478

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2479

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2480

"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]

2485

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

2486

# request. It only applies to Private Auction, AdX Preferred Deals and

2487

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

2488

# and Preferred Deals in Ad Manager.

2489

"targetedInventorySizes": [ # A list of inventory sizes to be included.

2490

{ # Represents size of a single ad slot, or a creative.

2491

"width": "A String", # The width of the ad slot in pixels.

2492

# This field will be present only when size type is `PIXEL`.

2493

"height": "A String", # The height of the ad slot in pixels.

2494

# This field will be present only when size type is `PIXEL`.

2495

"sizeType": "A String", # The size type of the ad slot.

2496

},

2497

],

2498

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

2499

{ # Represents size of a single ad slot, or a creative.

2500

"width": "A String", # The width of the ad slot in pixels.

2501

# This field will be present only when size type is `PIXEL`.

2502

"height": "A String", # The height of the ad slot in pixels.

2503

# This field will be present only when size type is `PIXEL`.

2504

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

2509

# included and excluded numeric IDs.

2510

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2511

"A String",

2512

],

2513

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

2518

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

2519

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

2520

# included and excluded numeric IDs.

2521

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2522

"A String",

2523

],

2524

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

2529

# included and excluded numeric IDs.

2530

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2531

"A String",

2532

],

2533

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

2539

# included and excluded numeric IDs.

2540

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2541

"A String",

2542

],

2543

"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.

2548

# included and excluded numeric IDs.

2549

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

2550

"A String",

2551

],

2552

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

2558

"targetedPositionTypes": [ # A list of video positions to be included.

2559

# When the included list is present, the excluded list must be empty.

2560

# When the excluded list is present, the included list must be empty.

2561

"A String",

2562

],

2563

"excludedPositionTypes": [ # A list of video positions to be excluded.

2564

# Position types can either be included or excluded (XOR).

2565

"A String",

2566

],

2567

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2568

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2569

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

2570

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2571

# operations (max-length: 1024 unicode code units).

2572

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2573

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2574

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2575

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2576

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2577

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2578

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2579

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

2580

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2581

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

2582

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2583

},

2584

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2586

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2587

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2588

"availableEndTime": "A String", # Proposed flight end time of the deal.

2589

# This will generally be stored in a granularity of a second.

2590

# A value is not required for Private Auction deals or Preferred Deals.

2591

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

2592

# This will generally be stored in the granularity of one second since deal

2593

# serving starts at seconds boundary. Any time specified with more

2594

# granularity (e.g., in milliseconds) will be truncated towards the start of

2595

# time in seconds.

2596

"displayName": "A String", # The name of the deal.

2597

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

2598

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

2599

# If present on create, and the server `product_revision` has advanced sinced

2600

# the passed-in `create_product_revision`, an `ABORTED` error will be

2601

# returned.

2602

#

2603

# Note: This field may be set only when creating the resource. Modifying

2604

# this field while updating the resource will result in an error.

2605

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

2606

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

2607

"sellerContacts": [ # Output only. Seller contact information for the deal.

2608

{ # Contains information on how a buyer or seller can be reached.

2609

"name": "A String", # The name of the contact.

2610

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2611

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2612

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2613

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2614

"syndicationProduct": "A String", # The syndication product associated with the deal.

2615

#

2616

# Note: This field may be set only when creating the resource. Modifying

2617

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2618

},

2619

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2620

"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.

2621

# Authorized Buyers account ID.

2622

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2623

},

2624

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2625

"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]

2626

#

2627

# Note: This field may be set only when creating the resource. Modifying

2628

# this field while updating the resource will result in an error.

2629

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2630

"subAccountId": "A String", # Optional sub-account ID for the seller.

2631

"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]

2632

# The seller account ID is then available to buyer in the product.

2633

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2634

"updateTime": "A String", # Output only. The time when the proposal was last revised.

2635

"proposalId": "A String", # Output only. The unique ID of the proposal.

2636

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

2637

"proposalState": "A String", # Output only. The current state of the proposal.

2638

"notes": [ # Output only. The notes associated with this proposal.

2639

{ # A proposal may be associated to several notes.

2640

"noteId": "A String", # Output only. The unique ID for the note.

2641

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

2642

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

2643

"createTime": "A String", # Output only. The timestamp for when this note was created.

2644

"note": "A String", # The actual note to attach.

2645

# (max-length: 1024 unicode code units)

2646

#

2647

# Note: This field may be set only when creating the resource. Modifying

2648

# this field while updating the resource will result in an error.

2649

},

2650

],

2651

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

2657

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

2658

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

2659

# operations (max-length: 1024 unicode code units).

2660

},

2661

"buyerContacts": [ # Contact information for the buyer.

2662

{ # Contains information on how a buyer or seller can be reached.

2663

"name": "A String", # The name of the contact.

2664

"email": "A String", # Email address for the contact.

2665

},

2666

],

2667

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

2668

# proposal.

2669

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2670

# proposal.

2671

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

2672

#

2673

# Note: This field may be set only when creating the resource. Modifying

2674

# this field while updating the resource will result in an error.

2675

# Authorized Buyers account ID.

2676

"accountId": "A String", # Authorized Buyers account ID of the buyer.

2677

},

2678

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

2679

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2680

}

2681

2682

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2689

2690

{ # Note: this resource requires whitelisting for access. Please contact your

2691

# account manager for access to Marketplace resources.

2692

#

2693

# Represents a proposal in the Marketplace. A proposal is the unit of

2694

# negotiation between a seller and a buyer and contains deals which

2695

# are served.

2696

#

2697

# Note: you can not update, create, or otherwise modify Private

2698

# Auction or Preferred Deals deals through the API.

2699

#

2700

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2701

"proposalRevision": "A String", # Output only. The revision number for the proposal.

2702

# Each update to the proposal or the deal causes the proposal revision number

2703

# to auto-increment. The buyer keeps track of the last revision number they

2704

# know of and pass it in when making an update. If the head revision number

2705

# on the server has since incremented, then an ABORTED error is returned

2706

# during the update operation to let the buyer know that a subsequent update

2707

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2708

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2709

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2710

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

2711

{ # A deal represents a segment of inventory for displaying ads on.

2712

# A proposal can contain multiple deals. A deal contains the terms and

2713

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2714

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

2715

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

2716

# deal.

2717

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2718

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

2719

# PUBLISHER means creative is provided by seller and ADVERTISER means

2720

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2721

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

2722

# targeting entity is AND'd together.

2723

{ # Advertisers can target different attributes of an ad slot. For example,

2724

# they can choose to show ads only if the user is in the U.S. Such

2725

# targeting criteria can be specified as part of Shared Targeting.

2726

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

2727

# together.

2728

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2729

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2730

# Filled in when the key is GOOG_DAYPART_TARGETING.

2731

# The definition of this targeting is derived from the structure

2732

# used by Ad Manager.

2733

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2734

"dayParts": [ # A list of day part targeting criterion.

2735

{ # Daypart targeting message that specifies if the ad can be shown

2736

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2737

"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

2738

# granularity). The end time is exclusive. This field is not available

2739

# for filtering in PQL queries.

2740

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2741

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2742

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2744

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2745

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2746

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2747

# allow the value 60 if it allows leap-seconds.

2748

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2749

"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).

2750

# The start time is inclusive.

2751

# This field is not available for filtering in PQL queries.

2752

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2753

# types are google.type.Date and `google.protobuf.Timestamp`.

2754

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2755

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2756

# to allow the value "24:00:00" for scenarios like business closing time.

2757

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2758

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2759

# allow the value 60 if it allows leap-seconds.

2760

},

2761

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2762

},

2763

],

2764

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2765

"longValue": "A String", # The long value to include/exclude.

2766

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2767

# Filled in when key = GOOG_CREATIVE_SIZE

2768

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2769

# only if creative_size_type = CreativeSizeType.NATIVE.

2770

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2771

# of the creative

2772

# height depend on the type of the targeting.

2773

"width": 42, # The width of the creative

2774

"height": 42, # The height of the creative.

2775

},

2776

"creativeSizeType": "A String", # The creative size type.

2777

"allowedFormats": [ # What formats are allowed by the publisher.

2778

# If this repeated field is empty then all formats are allowed.

2779

# For example, if this field contains AllowedFormatType.AUDIO then the

2780

# publisher only allows an audio ad (without any video).

2781

"A String",

2782

],

2783

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2784

# creative_size_type = CreativeSizeType.VIDEO.

2785

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2786

# Companion sizes may be filled in only when creative_size_type = VIDEO

2787

{ # Message depicting the size of the creative. The units of width and

2788

# height depend on the type of the targeting.

2789

"width": 42, # The width of the creative

2790

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

2795

},

2796

],

2797

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

2798

# together.

2799

{ # A polymorphic targeting value used as part of Shared Targeting.

2800

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

2801

# Filled in when the key is GOOG_DAYPART_TARGETING.

2802

# The definition of this targeting is derived from the structure

2803

# used by Ad Manager.

2804

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

2805

"dayParts": [ # A list of day part targeting criterion.

2806

{ # Daypart targeting message that specifies if the ad can be shown

2807

# only during certain parts of a day/week.

2808

"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

2809

# granularity). The end time is exclusive. This field is not available

2810

# for filtering in PQL queries.

2811

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2812

# types are google.type.Date and `google.protobuf.Timestamp`.

2813

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2814

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2815

# to allow the value "24:00:00" for scenarios like business closing time.

2816

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2817

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2818

# allow the value 60 if it allows leap-seconds.

2819

},

2820

"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).

2821

# The start time is inclusive.

2822

# This field is not available for filtering in PQL queries.

2823

# or are specified elsewhere. An API may choose to allow leap seconds. Related

2824

# types are google.type.Date and `google.protobuf.Timestamp`.

2825

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

2826

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

2827

# to allow the value "24:00:00" for scenarios like business closing time.

2828

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

2829

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

2830

# allow the value 60 if it allows leap-seconds.

2831

},

2832

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

2837

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

2838

# Filled in when key = GOOG_CREATIVE_SIZE

2839

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

2840

# only if creative_size_type = CreativeSizeType.NATIVE.

2841

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

2842

# of the creative

2843

# height depend on the type of the targeting.

2844

"width": 42, # The width of the creative

2845

"height": 42, # The height of the creative.

2846

},

2847

"creativeSizeType": "A String", # The creative size type.

2848

"allowedFormats": [ # What formats are allowed by the publisher.

2849

# If this repeated field is empty then all formats are allowed.

2850

# For example, if this field contains AllowedFormatType.AUDIO then the

2851

# publisher only allows an audio ad (without any video).

2852

"A String",

2853

],

2854

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

2855

# creative_size_type = CreativeSizeType.VIDEO.

2856

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

2857

# Companion sizes may be filled in only when creative_size_type = VIDEO

2858

{ # Message depicting the size of the creative. The units of width and

2859

# height depend on the type of the targeting.

2860

"width": 42, # The width of the creative

2861

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2866

},

2867

],

2868

"key": "A String", # The key representing the shared targeting criterion.

2869

# Targeting criteria defined by Google ad servers will begin with GOOG_.

2870

# Third parties may define their own keys.

2871

# A list of permissible keys along with the acceptable values will be

2872

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2873

},

2874

],

2875

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

2876

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

2877

# in Ad Manager.

2878

# Preferred Deal in Ad Manager.

2879

# This doesn't apply to Private Auction and AdX Preferred Deals.

2880

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

2881

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

2882

"creativeSpecifications": [

2883

{ # Represents information for a creative that is associated with a Programmatic

2884

# Guaranteed/Preferred Deal in Ad Manager.

2885

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

2886

"width": "A String", # The width of the ad slot in pixels.

2887

# This field will be present only when size type is `PIXEL`.

2888

"height": "A String", # The height of the ad slot in pixels.

2889

# This field will be present only when size type is `PIXEL`.

2890

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2891

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2892

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

2893

{ # Represents size of a single ad slot, or a creative.

2894

"width": "A String", # The width of the ad slot in pixels.

2895

# This field will be present only when size type is `PIXEL`.

2896

"height": "A String", # The height of the ad slot in pixels.

2897

# This field will be present only when size type is `PIXEL`.

2898

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

2905

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

2906

# The deal is considered paused if either hasBuyerPaused or

2907

# hasSellPaused is true.

2908

"firstPausedBy": "A String", # The role of the person who first paused this deal.

2909

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

2910

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

2911

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

2912

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2913

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2914

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2915

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

2916

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

2917

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2918

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

2919

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

2920

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

2921

# of guaranteed looks that the buyer is guaranteeing to buy.

2922

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2923

"fixedPrices": [ # Fixed price for the specified buyer.

2924

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2925

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2926

# a particular buyer or buyer/advertiser pair, we look for the most specific

2927

# matching rule - we first look for a rule matching the buyer and advertiser,

2928

# next a rule with the buyer but an empty advertiser list, and otherwise look

2929

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2930

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2931

# If empty, all advertisers with this buyer pay this price.

2932

"A String",

2933

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2934

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2935

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2936

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2937

"units": "A String", # The whole units of the amount.

2938

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2939

"nanos": 42, # Number of nano (10^-9) units of the amount.

2940

# The value must be between -999,999,999 and +999,999,999 inclusive.

2941

# If `units` is positive, `nanos` must be positive or zero.

2942

# If `units` is zero, `nanos` can be positive, zero, or negative.

2943

# If `units` is negative, `nanos` must be negative or zero.

2944

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2945

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2947

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2948

"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

2949

# (if the

2950

# advertisers match, and there's no more specific rule matching the buyer).

2951

# Authorized Buyers account ID.

2952

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2957

"description": "A String", # Publisher provided description for the terms.

2958

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

2959

# time zone used to mark the boundaries of a day. It should be an

2960

# IANA TZ name, such as "America/Los_Angeles". For more information,

2961

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2962

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

2963

# Can be set by buyer or seller.

2964

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

2965

# by the seller, but they can be returned in a get or list request.

2966

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

2967

# in this private auction.

2968

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

2969

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

2970

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

2971

# a particular buyer or buyer/advertiser pair, we look for the most specific

2972

# matching rule - we first look for a rule matching the buyer and advertiser,

2973

# next a rule with the buyer but an empty advertiser list, and otherwise look

2974

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2975

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

2976

# If empty, all advertisers with this buyer pay this price.

2977

"A String",

2978

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2979

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2980

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2981

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2982

"units": "A String", # The whole units of the amount.

2983

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2984

"nanos": 42, # Number of nano (10^-9) units of the amount.

2985

# The value must be between -999,999,999 and +999,999,999 inclusive.

2986

# If `units` is positive, `nanos` must be positive or zero.

2987

# If `units` is zero, `nanos` can be positive, zero, or negative.

2988

# If `units` is negative, `nanos` must be negative or zero.

2989

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2990

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2991

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2993

"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

2994

# (if the

2995

# advertisers match, and there's no more specific rule matching the buyer).

2996

# Authorized Buyers account ID.

2997

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3003

# the API at this time, but can be returned in a get or list request.

3004

"fixedPrices": [ # Fixed price for the specified buyer.

3005

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3006

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3007

# a particular buyer or buyer/advertiser pair, we look for the most specific

3008

# matching rule - we first look for a rule matching the buyer and advertiser,

3009

# next a rule with the buyer but an empty advertiser list, and otherwise look

3010

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3012

# If empty, all advertisers with this buyer pay this price.

3013

"A String",

3014

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3015

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3016

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3017

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3018

"units": "A String", # The whole units of the amount.

3019

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3020

"nanos": 42, # Number of nano (10^-9) units of the amount.

3021

# The value must be between -999,999,999 and +999,999,999 inclusive.

3022

# If `units` is positive, `nanos` must be positive or zero.

3023

# If `units` is zero, `nanos` can be positive, zero, or negative.

3024

# If `units` is negative, `nanos` must be negative or zero.

3025

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3026

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3027

},

3028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"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

3030

# (if the

3031

# advertisers match, and there's no more specific rule matching the buyer).

3032

# Authorized Buyers account ID.

3033

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

3039

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3040

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3041

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3042

"units": "A String", # The whole units of the amount.

3043

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3044

"nanos": 42, # Number of nano (10^-9) units of the amount.

3045

# The value must be between -999,999,999 and +999,999,999 inclusive.

3046

# If `units` is positive, `nanos` must be positive or zero.

3047

# If `units` is zero, `nanos` can be positive, zero, or negative.

3048

# If `units` is negative, `nanos` must be negative or zero.

3049

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3050

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3051

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3052

},

3053

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3054

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3055

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3056

# finalized. This is the deal ID that shows up in serving/reporting etc.

3057

"createProductId": "A String", # The product ID from which this deal was created.

3058

#

3059

# Note: This field may be set only when creating the resource. Modifying

3060

# this field while updating the resource will result in an error.

3061

"updateTime": "A String", # Output only. The time when the deal was last updated.

3062

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3063

"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]

3064

# target ad inventory. For example, they can choose to target ad requests only

3065

# if the user is in the US.

3066

# Multiple types of targeting are always applied as a logical AND, unless noted

3067

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3068

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

3069

# mobile applications.

3070

# Different placement targeting types will be logically OR'ed.

3071

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3072

# For Private Auction and AdX Preferred Deals, URLs are either included or

3073

# excluded.

3074

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3075

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3076

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3077

"A String",

3078

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3079

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3084

# This doesn't apply to Auction Packages.

3085

"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]

3086

# display the ads in.

3087

# publishers own.

3088

# Mobile application IDs are from App Store and Google Play Store.

3089

# Android App ID, for example, com.google.android.apps.maps, can be found in

3090

# Google Play Store URL.

3091

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3092

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3093

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3094

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3095

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3096

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

"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]

3102

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

3103

# request. It only applies to Private Auction, AdX Preferred Deals and

3104

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3105

# and Preferred Deals in Ad Manager.

3106

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3107

{ # Represents size of a single ad slot, or a creative.

3108

"width": "A String", # The width of the ad slot in pixels.

3109

# This field will be present only when size type is `PIXEL`.

3110

"height": "A String", # The height of the ad slot in pixels.

3111

# This field will be present only when size type is `PIXEL`.

3112

"sizeType": "A String", # The size type of the ad slot.

3113

},

3114

],

3115

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3116

{ # Represents size of a single ad slot, or a creative.

3117

"width": "A String", # The width of the ad slot in pixels.

3118

# This field will be present only when size type is `PIXEL`.

3119

"height": "A String", # The height of the ad slot in pixels.

3120

# This field will be present only when size type is `PIXEL`.

3121

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3126

# included and excluded numeric IDs.

3127

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3128

"A String",

3129

],

3130

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

3135

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3136

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

3137

# included and excluded numeric IDs.

3138

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3139

"A String",

3140

],

3141

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3146

# included and excluded numeric IDs.

3147

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3148

"A String",

3149

],

3150

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3156

# included and excluded numeric IDs.

3157

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3158

"A String",

3159

],

3160

"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.

3165

# included and excluded numeric IDs.

3166

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3167

"A String",

3168

],

3169

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3175

"targetedPositionTypes": [ # A list of video positions to be included.

3176

# When the included list is present, the excluded list must be empty.

3177

# When the excluded list is present, the included list must be empty.

3178

"A String",

3179

],

3180

"excludedPositionTypes": [ # A list of video positions to be excluded.

3181

# Position types can either be included or excluded (XOR).

3182

"A String",

3183

],

3184

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3185

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3186

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3187

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3188

# operations (max-length: 1024 unicode code units).

3189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3190

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3191

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3192

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3193

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3194

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3195

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3197

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3198

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

3199

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3200

},

3201

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3202

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3203

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3204

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3205

"availableEndTime": "A String", # Proposed flight end time of the deal.

3206

# This will generally be stored in a granularity of a second.

3207

# A value is not required for Private Auction deals or Preferred Deals.

3208

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

3209

# This will generally be stored in the granularity of one second since deal

3210

# serving starts at seconds boundary. Any time specified with more

3211

# granularity (e.g., in milliseconds) will be truncated towards the start of

3212

# time in seconds.

3213

"displayName": "A String", # The name of the deal.

3214

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3215

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

3216

# If present on create, and the server `product_revision` has advanced sinced

3217

# the passed-in `create_product_revision`, an `ABORTED` error will be

3218

# returned.

3219

#

3220

# Note: This field may be set only when creating the resource. Modifying

3221

# this field while updating the resource will result in an error.

3222

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3223

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

3224

"sellerContacts": [ # Output only. Seller contact information for the deal.

3225

{ # Contains information on how a buyer or seller can be reached.

3226

"name": "A String", # The name of the contact.

3227

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3228

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3229

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3231

"syndicationProduct": "A String", # The syndication product associated with the deal.

3232

#

3233

# Note: This field may be set only when creating the resource. Modifying

3234

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3235

},

3236

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3237

"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.

3238

# Authorized Buyers account ID.

3239

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3240

},

3241

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3242

"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]

3243

#

3244

# Note: This field may be set only when creating the resource. Modifying

3245

# this field while updating the resource will result in an error.

3246

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3247

"subAccountId": "A String", # Optional sub-account ID for the seller.

3248

"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]

3249

# The seller account ID is then available to buyer in the product.

3250

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3251

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3252

"proposalId": "A String", # Output only. The unique ID of the proposal.

3253

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3254

"proposalState": "A String", # Output only. The current state of the proposal.

3255

"notes": [ # Output only. The notes associated with this proposal.

3256

{ # A proposal may be associated to several notes.

3257

"noteId": "A String", # Output only. The unique ID for the note.

3258

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3259

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3260

"createTime": "A String", # Output only. The timestamp for when this note was created.

3261

"note": "A String", # The actual note to attach.

3262

# (max-length: 1024 unicode code units)

3263

#

3264

# Note: This field may be set only when creating the resource. Modifying

3265

# this field while updating the resource will result in an error.

3266

},

3267

],

3268

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

3274

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3275

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3276

# operations (max-length: 1024 unicode code units).

3277

},

3278

"buyerContacts": [ # Contact information for the buyer.

3279

{ # Contains information on how a buyer or seller can be reached.

3280

"name": "A String", # The name of the contact.

3281

"email": "A String", # Email address for the contact.

3282

},

3283

],

3284

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3285

# proposal.

3286

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3287

# proposal.

3288

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3289

#

3290

# Note: This field may be set only when creating the resource. Modifying

3291

# this field while updating the resource will result in an error.

3292

# Authorized Buyers account ID.

3293

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3294

},

3295

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3296

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(accountId, proposalId, x__xgafv=None)</code>

3302

<pre>Gets a proposal given its ID. The proposal is returned at its head

revision.

Args:

accountId: string, Account ID of the buyer. (required)

3307

proposalId: string, The unique ID of the proposal (required)

3308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3315

3316

{ # Note: this resource requires whitelisting for access. Please contact your

3317

# account manager for access to Marketplace resources.

3318

#

3319

# Represents a proposal in the Marketplace. A proposal is the unit of

3320

# negotiation between a seller and a buyer and contains deals which

3321

# are served.

3322

#

3323

# Note: you can not update, create, or otherwise modify Private

3324

# Auction or Preferred Deals deals through the API.

3325

#

3326

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3327

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3328

# Each update to the proposal or the deal causes the proposal revision number

3329

# to auto-increment. The buyer keeps track of the last revision number they

3330

# know of and pass it in when making an update. If the head revision number

3331

# on the server has since incremented, then an ABORTED error is returned

3332

# during the update operation to let the buyer know that a subsequent update

3333

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3334

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3335

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3336

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3337

{ # A deal represents a segment of inventory for displaying ads on.

3338

# A proposal can contain multiple deals. A deal contains the terms and

3339

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3340

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

3341

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3342

# deal.

3343

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3344

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3345

# PUBLISHER means creative is provided by seller and ADVERTISER means

3346

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3347

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3348

# targeting entity is AND'd together.

3349

{ # Advertisers can target different attributes of an ad slot. For example,

3350

# they can choose to show ads only if the user is in the U.S. Such

3351

# targeting criteria can be specified as part of Shared Targeting.

3352

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3353

# together.

3354

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3355

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3356

# Filled in when the key is GOOG_DAYPART_TARGETING.

3357

# The definition of this targeting is derived from the structure

3358

# used by Ad Manager.

3359

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3360

"dayParts": [ # A list of day part targeting criterion.

3361

{ # Daypart targeting message that specifies if the ad can be shown

3362

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3363

"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

3364

# granularity). The end time is exclusive. This field is not available

3365

# for filtering in PQL queries.

3366

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3367

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3368

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3369

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3370

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3371

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3373

# allow the value 60 if it allows leap-seconds.

3374

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3375

"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).

3376

# The start time is inclusive.

3377

# This field is not available for filtering in PQL queries.

3378

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3379

# types are google.type.Date and `google.protobuf.Timestamp`.

3380

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3381

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3382

# to allow the value "24:00:00" for scenarios like business closing time.

3383

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3384

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3385

# allow the value 60 if it allows leap-seconds.

3386

},

3387

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3388

},

3389

],

3390

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3391

"longValue": "A String", # The long value to include/exclude.

3392

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3393

# Filled in when key = GOOG_CREATIVE_SIZE

3394

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3395

# only if creative_size_type = CreativeSizeType.NATIVE.

3396

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3397

# of the creative

3398

# height depend on the type of the targeting.

3399

"width": 42, # The width of the creative

3400

"height": 42, # The height of the creative.

3401

},

3402

"creativeSizeType": "A String", # The creative size type.

3403

"allowedFormats": [ # What formats are allowed by the publisher.

3404

# If this repeated field is empty then all formats are allowed.

3405

# For example, if this field contains AllowedFormatType.AUDIO then the

3406

# publisher only allows an audio ad (without any video).

3407

"A String",

3408

],

3409

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3410

# creative_size_type = CreativeSizeType.VIDEO.

3411

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3412

# Companion sizes may be filled in only when creative_size_type = VIDEO

3413

{ # Message depicting the size of the creative. The units of width and

3414

# height depend on the type of the targeting.

3415

"width": 42, # The width of the creative

3416

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

3421

},

3422

],

3423

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

3424

# together.

3425

{ # A polymorphic targeting value used as part of Shared Targeting.

3426

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3427

# Filled in when the key is GOOG_DAYPART_TARGETING.

3428

# The definition of this targeting is derived from the structure

3429

# used by Ad Manager.

3430

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

3431

"dayParts": [ # A list of day part targeting criterion.

3432

{ # Daypart targeting message that specifies if the ad can be shown

3433

# only during certain parts of a day/week.

3434

"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

3435

# granularity). The end time is exclusive. This field is not available

3436

# for filtering in PQL queries.

3437

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3438

# types are google.type.Date and `google.protobuf.Timestamp`.

3439

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3440

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3441

# to allow the value "24:00:00" for scenarios like business closing time.

3442

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3443

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3444

# allow the value 60 if it allows leap-seconds.

3445

},

3446

"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).

3447

# The start time is inclusive.

3448

# This field is not available for filtering in PQL queries.

3449

# or are specified elsewhere. An API may choose to allow leap seconds. Related

3450

# types are google.type.Date and `google.protobuf.Timestamp`.

3451

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

3452

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

3453

# to allow the value "24:00:00" for scenarios like business closing time.

3454

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

3455

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

3456

# allow the value 60 if it allows leap-seconds.

3457

},

3458

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

3463

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

3464

# Filled in when key = GOOG_CREATIVE_SIZE

3465

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

3466

# only if creative_size_type = CreativeSizeType.NATIVE.

3467

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

3468

# of the creative

3469

# height depend on the type of the targeting.

3470

"width": 42, # The width of the creative

3471

"height": 42, # The height of the creative.

3472

},

3473

"creativeSizeType": "A String", # The creative size type.

3474

"allowedFormats": [ # What formats are allowed by the publisher.

3475

# If this repeated field is empty then all formats are allowed.

3476

# For example, if this field contains AllowedFormatType.AUDIO then the

3477

# publisher only allows an audio ad (without any video).

3478

"A String",

3479

],

3480

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

3481

# creative_size_type = CreativeSizeType.VIDEO.

3482

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

3483

# Companion sizes may be filled in only when creative_size_type = VIDEO

3484

{ # Message depicting the size of the creative. The units of width and

3485

# height depend on the type of the targeting.

3486

"width": 42, # The width of the creative

3487

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3492

},

3493

],

3494

"key": "A String", # The key representing the shared targeting criterion.

3495

# Targeting criteria defined by Google ad servers will begin with GOOG_.

3496

# Third parties may define their own keys.

3497

# A list of permissible keys along with the acceptable values will be

3498

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3499

},

3500

],

3501

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

3502

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

3503

# in Ad Manager.

3504

# Preferred Deal in Ad Manager.

3505

# This doesn't apply to Private Auction and AdX Preferred Deals.

3506

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

3507

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

3508

"creativeSpecifications": [

3509

{ # Represents information for a creative that is associated with a Programmatic

3510

# Guaranteed/Preferred Deal in Ad Manager.

3511

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

3512

"width": "A String", # The width of the ad slot in pixels.

3513

# This field will be present only when size type is `PIXEL`.

3514

"height": "A String", # The height of the ad slot in pixels.

3515

# This field will be present only when size type is `PIXEL`.

3516

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3517

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3518

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

3519

{ # Represents size of a single ad slot, or a creative.

3520

"width": "A String", # The width of the ad slot in pixels.

3521

# This field will be present only when size type is `PIXEL`.

3522

"height": "A String", # The height of the ad slot in pixels.

3523

# This field will be present only when size type is `PIXEL`.

3524

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

3531

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

3532

# The deal is considered paused if either hasBuyerPaused or

3533

# hasSellPaused is true.

3534

"firstPausedBy": "A String", # The role of the person who first paused this deal.

3535

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

3536

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

3537

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

3538

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3539

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3540

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3541

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

3542

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

3543

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3544

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

3545

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

3546

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

3547

# of guaranteed looks that the buyer is guaranteeing to buy.

3548

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3549

"fixedPrices": [ # Fixed price for the specified buyer.

3550

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3551

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3552

# a particular buyer or buyer/advertiser pair, we look for the most specific

3553

# matching rule - we first look for a rule matching the buyer and advertiser,

3554

# next a rule with the buyer but an empty advertiser list, and otherwise look

3555

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3556

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3557

# If empty, all advertisers with this buyer pay this price.

3558

"A String",

3559

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3560

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3561

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3562

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3563

"units": "A String", # The whole units of the amount.

3564

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3565

"nanos": 42, # Number of nano (10^-9) units of the amount.

3566

# The value must be between -999,999,999 and +999,999,999 inclusive.

3567

# If `units` is positive, `nanos` must be positive or zero.

3568

# If `units` is zero, `nanos` can be positive, zero, or negative.

3569

# If `units` is negative, `nanos` must be negative or zero.

3570

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3571

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3572

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3574

"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

3575

# (if the

3576

# advertisers match, and there's no more specific rule matching the buyer).

3577

# Authorized Buyers account ID.

3578

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3583

"description": "A String", # Publisher provided description for the terms.

3584

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

3585

# time zone used to mark the boundaries of a day. It should be an

3586

# IANA TZ name, such as "America/Los_Angeles". For more information,

3587

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3588

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

3589

# Can be set by buyer or seller.

3590

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

3591

# by the seller, but they can be returned in a get or list request.

3592

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

3593

# in this private auction.

3594

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

3595

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3596

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3597

# a particular buyer or buyer/advertiser pair, we look for the most specific

3598

# matching rule - we first look for a rule matching the buyer and advertiser,

3599

# next a rule with the buyer but an empty advertiser list, and otherwise look

3600

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3601

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3602

# If empty, all advertisers with this buyer pay this price.

3603

"A String",

3604

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3606

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3607

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3608

"units": "A String", # The whole units of the amount.

3609

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3610

"nanos": 42, # Number of nano (10^-9) units of the amount.

3611

# The value must be between -999,999,999 and +999,999,999 inclusive.

3612

# If `units` is positive, `nanos` must be positive or zero.

3613

# If `units` is zero, `nanos` can be positive, zero, or negative.

3614

# If `units` is negative, `nanos` must be negative or zero.

3615

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3616

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3617

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3618

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3619

"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

3620

# (if the

3621

# advertisers match, and there's no more specific rule matching the buyer).

3622

# Authorized Buyers account ID.

3623

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

3629

# the API at this time, but can be returned in a get or list request.

3630

"fixedPrices": [ # Fixed price for the specified buyer.

3631

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

3632

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

3633

# a particular buyer or buyer/advertiser pair, we look for the most specific

3634

# matching rule - we first look for a rule matching the buyer and advertiser,

3635

# next a rule with the buyer but an empty advertiser list, and otherwise look

3636

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3637

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

3638

# If empty, all advertisers with this buyer pay this price.

3639

"A String",

3640

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3641

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

3642

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

3643

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

3644

"units": "A String", # The whole units of the amount.

3645

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

3646

"nanos": 42, # Number of nano (10^-9) units of the amount.

3647

# The value must be between -999,999,999 and +999,999,999 inclusive.

3648

# If `units` is positive, `nanos` must be positive or zero.

3649

# If `units` is zero, `nanos` can be positive, zero, or negative.

3650

# If `units` is negative, `nanos` must be negative or zero.

3651

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

3652

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

3653

},

3654

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3655

"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

3656

# (if the

3657

# advertisers match, and there's no more specific rule matching the buyer).

3658

# Authorized Buyers account ID.

3659

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

3665

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3666

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3667

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3668

"units": "A String", # The whole units of the amount.

3669

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3670

"nanos": 42, # Number of nano (10^-9) units of the amount.

3671

# The value must be between -999,999,999 and +999,999,999 inclusive.

3672

# If `units` is positive, `nanos` must be positive or zero.

3673

# If `units` is zero, `nanos` can be positive, zero, or negative.

3674

# If `units` is negative, `nanos` must be negative or zero.

3675

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3676

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3677

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3678

},

3679

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3680

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3681

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

3682

# finalized. This is the deal ID that shows up in serving/reporting etc.

3683

"createProductId": "A String", # The product ID from which this deal was created.

3684

#

3685

# Note: This field may be set only when creating the resource. Modifying

3686

# this field while updating the resource will result in an error.

3687

"updateTime": "A String", # Output only. The time when the deal was last updated.

3688

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3689

"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]

3690

# target ad inventory. For example, they can choose to target ad requests only

3691

# if the user is in the US.

3692

# Multiple types of targeting are always applied as a logical AND, unless noted

3693

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3694

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

3695

# mobile applications.

3696

# Different placement targeting types will be logically OR'ed.

3697

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

3698

# For Private Auction and AdX Preferred Deals, URLs are either included or

3699

# excluded.

3700

# For Programmatic Guaranteed and Preferred Deals, this doesn't

3701

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3702

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

"A String",

3704

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3705

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

3710

# This doesn't apply to Auction Packages.

3711

"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]

3712

# display the ads in.

3713

# publishers own.

3714

# Mobile application IDs are from App Store and Google Play Store.

3715

# Android App ID, for example, com.google.android.apps.maps, can be found in

3716

# Google Play Store URL.

3717

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

3718

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3719

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3720

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3721

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3722

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3723

"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]

3728

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

3729

# request. It only applies to Private Auction, AdX Preferred Deals and

3730

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

3731

# and Preferred Deals in Ad Manager.

3732

"targetedInventorySizes": [ # A list of inventory sizes to be included.

3733

{ # Represents size of a single ad slot, or a creative.

3734

"width": "A String", # The width of the ad slot in pixels.

3735

# This field will be present only when size type is `PIXEL`.

3736

"height": "A String", # The height of the ad slot in pixels.

3737

# This field will be present only when size type is `PIXEL`.

3738

"sizeType": "A String", # The size type of the ad slot.

3739

},

3740

],

3741

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

3742

{ # Represents size of a single ad slot, or a creative.

3743

"width": "A String", # The width of the ad slot in pixels.

3744

# This field will be present only when size type is `PIXEL`.

3745

"height": "A String", # The height of the ad slot in pixels.

3746

# This field will be present only when size type is `PIXEL`.

3747

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

3752

# included and excluded numeric IDs.

3753

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3754

"A String",

3755

],

3756

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

3761

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

3762

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

3763

# included and excluded numeric IDs.

3764

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3765

"A String",

3766

],

3767

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

3772

# included and excluded numeric IDs.

3773

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3774

"A String",

3775

],

3776

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

3782

# included and excluded numeric IDs.

3783

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3784

"A String",

3785

],

3786

"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.

3791

# included and excluded numeric IDs.

3792

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

3793

"A String",

3794

],

3795

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

3801

"targetedPositionTypes": [ # A list of video positions to be included.

3802

# When the included list is present, the excluded list must be empty.

3803

# When the excluded list is present, the included list must be empty.

3804

"A String",

3805

],

3806

"excludedPositionTypes": [ # A list of video positions to be excluded.

3807

# Position types can either be included or excluded (XOR).

3808

"A String",

3809

],

3810

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3811

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3812

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

3813

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3814

# operations (max-length: 1024 unicode code units).

3815

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3816

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3817

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3818

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3819

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3820

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3821

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3822

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

3823

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3824

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

3825

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3826

},

3827

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3828

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3829

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3830

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3831

"availableEndTime": "A String", # Proposed flight end time of the deal.

3832

# This will generally be stored in a granularity of a second.

3833

# A value is not required for Private Auction deals or Preferred Deals.

3834

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

3835

# This will generally be stored in the granularity of one second since deal

3836

# serving starts at seconds boundary. Any time specified with more

3837

# granularity (e.g., in milliseconds) will be truncated towards the start of

3838

# time in seconds.

3839

"displayName": "A String", # The name of the deal.

3840

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

3841

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

3842

# If present on create, and the server `product_revision` has advanced sinced

3843

# the passed-in `create_product_revision`, an `ABORTED` error will be

3844

# returned.

3845

#

3846

# Note: This field may be set only when creating the resource. Modifying

3847

# this field while updating the resource will result in an error.

3848

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

3849

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

3850

"sellerContacts": [ # Output only. Seller contact information for the deal.

3851

{ # Contains information on how a buyer or seller can be reached.

3852

"name": "A String", # The name of the contact.

3853

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3854

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3855

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3856

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3857

"syndicationProduct": "A String", # The syndication product associated with the deal.

3858

#

3859

# Note: This field may be set only when creating the resource. Modifying

3860

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3861

},

3862

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3863

"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.

3864

# Authorized Buyers account ID.

3865

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3866

},

3867

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3868

"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]

3869

#

3870

# Note: This field may be set only when creating the resource. Modifying

3871

# this field while updating the resource will result in an error.

3872

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3873

"subAccountId": "A String", # Optional sub-account ID for the seller.

3874

"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]

3875

# The seller account ID is then available to buyer in the product.

3876

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3877

"updateTime": "A String", # Output only. The time when the proposal was last revised.

3878

"proposalId": "A String", # Output only. The unique ID of the proposal.

3879

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

3880

"proposalState": "A String", # Output only. The current state of the proposal.

3881

"notes": [ # Output only. The notes associated with this proposal.

3882

{ # A proposal may be associated to several notes.

3883

"noteId": "A String", # Output only. The unique ID for the note.

3884

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

3885

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

3886

"createTime": "A String", # Output only. The timestamp for when this note was created.

3887

"note": "A String", # The actual note to attach.

3888

# (max-length: 1024 unicode code units)

3889

#

3890

# Note: This field may be set only when creating the resource. Modifying

3891

# this field while updating the resource will result in an error.

3892

},

3893

],

3894

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

3900

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

3901

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

3902

# operations (max-length: 1024 unicode code units).

3903

},

3904

"buyerContacts": [ # Contact information for the buyer.

3905

{ # Contains information on how a buyer or seller can be reached.

3906

"name": "A String", # The name of the contact.

3907

"email": "A String", # Email address for the contact.

3908

},

3909

],

3910

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

3911

# proposal.

3912

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3913

# proposal.

3914

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

3915

#

3916

# Note: This field may be set only when creating the resource. Modifying

3917

# this field while updating the resource will result in an error.

3918

# Authorized Buyers account ID.

3919

"accountId": "A String", # Authorized Buyers account ID of the buyer.

3920

},

3921

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

3922

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3927

<code class="details" id="list">list(accountId, pageToken=None, filterSyntax=None, filter=None, pageSize=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

2020-05-27 12:20:54 -0700

[diff] [blame]

3937

pageToken: string, The page token as returned from ListProposalsResponse.

3938

filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL

3939

but in the future it will be LIST_FILTER.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3940

filter: string, An optional PQL filter query used to query for proposals.

3941

3942

Nested repeated fields, such as proposal.deals.targetingCriterion,

3943

cannot be filtered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3944

pageSize: integer, Requested page size. The server may return fewer results than requested.

3945

If unspecified, the server will pick an appropriate default.

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-05-27 12:20:54 -0700

[diff] [blame]

3967

"proposalRevision": "A String", # Output only. The revision number for the proposal.

3968

# Each update to the proposal or the deal causes the proposal revision number

3969

# to auto-increment. The buyer keeps track of the last revision number they

3970

# know of and pass it in when making an update. If the head revision number

3971

# on the server has since incremented, then an ABORTED error is returned

3972

# during the update operation to let the buyer know that a subsequent update

3973

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3974

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3975

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3976

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

3977

{ # A deal represents a segment of inventory for displaying ads on.

3978

# A proposal can contain multiple deals. A deal contains the terms and

3979

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3980

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

3981

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

3982

# deal.

3983

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3984

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

3985

# PUBLISHER means creative is provided by seller and ADVERTISER means

3986

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3987

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

3988

# targeting entity is AND'd together.

3989

{ # Advertisers can target different attributes of an ad slot. For example,

3990

# they can choose to show ads only if the user is in the U.S. Such

3991

# targeting criteria can be specified as part of Shared Targeting.

3992

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

3993

# together.

3994

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3995

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

3996

# Filled in when the key is GOOG_DAYPART_TARGETING.

3997

# The definition of this targeting is derived from the structure

3998

# used by Ad Manager.

3999

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4000

"dayParts": [ # A list of day part targeting criterion.

4001

{ # Daypart targeting message that specifies if the ad can be shown

4002

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4003

"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

4004

# granularity). The end time is exclusive. This field is not available

4005

# for filtering in PQL queries.

4006

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4007

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4008

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4010

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4011

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4012

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4013

# allow the value 60 if it allows leap-seconds.

4014

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4015

"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).

4016

# The start time is inclusive.

4017

# This field is not available for filtering in PQL queries.

4018

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4019

# types are google.type.Date and `google.protobuf.Timestamp`.

4020

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4021

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4022

# to allow the value "24:00:00" for scenarios like business closing time.

4023

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4024

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4025

# allow the value 60 if it allows leap-seconds.

4026

},

4027

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4028

},

4029

],

4030

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4031

"longValue": "A String", # The long value to include/exclude.

4032

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4033

# Filled in when key = GOOG_CREATIVE_SIZE

4034

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4035

# only if creative_size_type = CreativeSizeType.NATIVE.

4036

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4037

# of the creative

4038

# height depend on the type of the targeting.

4039

"width": 42, # The width of the creative

4040

"height": 42, # The height of the creative.

4041

},

4042

"creativeSizeType": "A String", # The creative size type.

4043

"allowedFormats": [ # What formats are allowed by the publisher.

4044

# If this repeated field is empty then all formats are allowed.

4045

# For example, if this field contains AllowedFormatType.AUDIO then the

4046

# publisher only allows an audio ad (without any video).

4047

"A String",

4048

],

4049

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4050

# creative_size_type = CreativeSizeType.VIDEO.

4051

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4052

# Companion sizes may be filled in only when creative_size_type = VIDEO

4053

{ # Message depicting the size of the creative. The units of width and

4054

# height depend on the type of the targeting.

4055

"width": 42, # The width of the creative

4056

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

4061

},

4062

],

4063

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4064

# together.

4065

{ # A polymorphic targeting value used as part of Shared Targeting.

4066

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4067

# Filled in when the key is GOOG_DAYPART_TARGETING.

4068

# The definition of this targeting is derived from the structure

4069

# used by Ad Manager.

4070

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4071

"dayParts": [ # A list of day part targeting criterion.

4072

{ # Daypart targeting message that specifies if the ad can be shown

4073

# only during certain parts of a day/week.

4074

"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

4075

# granularity). The end time is exclusive. This field is not available

4076

# for filtering in PQL queries.

4077

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4078

# types are google.type.Date and `google.protobuf.Timestamp`.

4079

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4080

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4081

# to allow the value "24:00:00" for scenarios like business closing time.

4082

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4083

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4084

# allow the value 60 if it allows leap-seconds.

4085

},

4086

"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).

4087

# The start time is inclusive.

4088

# This field is not available for filtering in PQL queries.

4089

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4090

# types are google.type.Date and `google.protobuf.Timestamp`.

4091

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4092

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4093

# to allow the value "24:00:00" for scenarios like business closing time.

4094

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4095

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4096

# allow the value 60 if it allows leap-seconds.

4097

},

4098

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

4103

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4104

# Filled in when key = GOOG_CREATIVE_SIZE

4105

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4106

# only if creative_size_type = CreativeSizeType.NATIVE.

4107

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4108

# of the creative

4109

# height depend on the type of the targeting.

4110

"width": 42, # The width of the creative

4111

"height": 42, # The height of the creative.

4112

},

4113

"creativeSizeType": "A String", # The creative size type.

4114

"allowedFormats": [ # What formats are allowed by the publisher.

4115

# If this repeated field is empty then all formats are allowed.

4116

# For example, if this field contains AllowedFormatType.AUDIO then the

4117

# publisher only allows an audio ad (without any video).

4118

"A String",

4119

],

4120

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4121

# creative_size_type = CreativeSizeType.VIDEO.

4122

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4123

# Companion sizes may be filled in only when creative_size_type = VIDEO

4124

{ # Message depicting the size of the creative. The units of width and

4125

# height depend on the type of the targeting.

4126

"width": 42, # The width of the creative

4127

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4132

},

4133

],

4134

"key": "A String", # The key representing the shared targeting criterion.

4135

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4136

# Third parties may define their own keys.

4137

# A list of permissible keys along with the acceptable values will be

4138

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4139

},

4140

],

4141

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4142

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4143

# in Ad Manager.

4144

# Preferred Deal in Ad Manager.

4145

# This doesn't apply to Private Auction and AdX Preferred Deals.

4146

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4147

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

4148

"creativeSpecifications": [

4149

{ # Represents information for a creative that is associated with a Programmatic

4150

# Guaranteed/Preferred Deal in Ad Manager.

4151

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4152

"width": "A String", # The width of the ad slot in pixels.

4153

# This field will be present only when size type is `PIXEL`.

4154

"height": "A String", # The height of the ad slot in pixels.

4155

# This field will be present only when size type is `PIXEL`.

4156

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4157

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4158

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4159

{ # Represents size of a single ad slot, or a creative.

4160

"width": "A String", # The width of the ad slot in pixels.

4161

# This field will be present only when size type is `PIXEL`.

4162

"height": "A String", # The height of the ad slot in pixels.

4163

# This field will be present only when size type is `PIXEL`.

4164

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4171

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

4172

# The deal is considered paused if either hasBuyerPaused or

4173

# hasSellPaused is true.

4174

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4175

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

4176

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4177

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4178

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4179

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4180

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4181

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4182

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4183

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4184

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4185

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4186

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4187

# of guaranteed looks that the buyer is guaranteeing to buy.

4188

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4189

"fixedPrices": [ # Fixed price for the specified buyer.

4190

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4191

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4192

# a particular buyer or buyer/advertiser pair, we look for the most specific

4193

# matching rule - we first look for a rule matching the buyer and advertiser,

4194

# next a rule with the buyer but an empty advertiser list, and otherwise look

4195

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4196

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4197

# If empty, all advertisers with this buyer pay this price.

4198

"A String",

4199

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4200

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4201

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4202

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4203

"units": "A String", # The whole units of the amount.

4204

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4205

"nanos": 42, # Number of nano (10^-9) units of the amount.

4206

# The value must be between -999,999,999 and +999,999,999 inclusive.

4207

# If `units` is positive, `nanos` must be positive or zero.

4208

# If `units` is zero, `nanos` can be positive, zero, or negative.

4209

# If `units` is negative, `nanos` must be negative or zero.

4210

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4211

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4212

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4213

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4214

"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

4215

# (if the

4216

# advertisers match, and there's no more specific rule matching the buyer).

4217

# Authorized Buyers account ID.

4218

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4223

"description": "A String", # Publisher provided description for the terms.

4224

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4225

# time zone used to mark the boundaries of a day. It should be an

4226

# IANA TZ name, such as "America/Los_Angeles". For more information,

4227

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4228

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4229

# Can be set by buyer or seller.

4230

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4231

# by the seller, but they can be returned in a get or list request.

4232

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

4233

# in this private auction.

4234

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4235

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4236

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4237

# a particular buyer or buyer/advertiser pair, we look for the most specific

4238

# matching rule - we first look for a rule matching the buyer and advertiser,

4239

# next a rule with the buyer but an empty advertiser list, and otherwise look

4240

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4241

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4242

# If empty, all advertisers with this buyer pay this price.

4243

"A String",

4244

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4245

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4246

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4247

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4248

"units": "A String", # The whole units of the amount.

4249

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4250

"nanos": 42, # Number of nano (10^-9) units of the amount.

4251

# The value must be between -999,999,999 and +999,999,999 inclusive.

4252

# If `units` is positive, `nanos` must be positive or zero.

4253

# If `units` is zero, `nanos` can be positive, zero, or negative.

4254

# If `units` is negative, `nanos` must be negative or zero.

4255

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4256

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4257

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4258

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4259

"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

4260

# (if the

4261

# advertisers match, and there's no more specific rule matching the buyer).

4262

# Authorized Buyers account ID.

4263

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4269

# the API at this time, but can be returned in a get or list request.

4270

"fixedPrices": [ # Fixed price for the specified buyer.

4271

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4272

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4273

# a particular buyer or buyer/advertiser pair, we look for the most specific

4274

# matching rule - we first look for a rule matching the buyer and advertiser,

4275

# next a rule with the buyer but an empty advertiser list, and otherwise look

4276

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4277

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4278

# If empty, all advertisers with this buyer pay this price.

4279

"A String",

4280

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4281

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4282

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4283

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4284

"units": "A String", # The whole units of the amount.

4285

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4286

"nanos": 42, # Number of nano (10^-9) units of the amount.

4287

# The value must be between -999,999,999 and +999,999,999 inclusive.

4288

# If `units` is positive, `nanos` must be positive or zero.

4289

# If `units` is zero, `nanos` can be positive, zero, or negative.

4290

# If `units` is negative, `nanos` must be negative or zero.

4291

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4292

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4293

},

4294

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4295

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price

4296

# (if the

4297

# advertisers match, and there's no more specific rule matching the buyer).

4298

# Authorized Buyers account ID.

4299

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

4305

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4306

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4307

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4308

"units": "A String", # The whole units of the amount.

4309

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4310

"nanos": 42, # Number of nano (10^-9) units of the amount.

4311

# The value must be between -999,999,999 and +999,999,999 inclusive.

4312

# If `units` is positive, `nanos` must be positive or zero.

4313

# If `units` is zero, `nanos` can be positive, zero, or negative.

4314

# If `units` is negative, `nanos` must be negative or zero.

4315

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4316

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4317

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4318

},

4319

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4320

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4321

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4322

# finalized. This is the deal ID that shows up in serving/reporting etc.

4323

"createProductId": "A String", # The product ID from which this deal was created.

4324

#

4325

# Note: This field may be set only when creating the resource. Modifying

4326

# this field while updating the resource will result in an error.

4327

"updateTime": "A String", # Output only. The time when the deal was last updated.

4328

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4329

"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]

4330

# target ad inventory. For example, they can choose to target ad requests only

4331

# if the user is in the US.

4332

# Multiple types of targeting are always applied as a logical AND, unless noted

4333

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4334

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

4335

# mobile applications.

4336

# Different placement targeting types will be logically OR'ed.

4337

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4338

# For Private Auction and AdX Preferred Deals, URLs are either included or

4339

# excluded.

4340

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4341

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4342

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4343

"A String",

4344

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4345

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

4350

# This doesn't apply to Auction Packages.

4351

"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]

4352

# display the ads in.

4353

# publishers own.

4354

# Mobile application IDs are from App Store and Google Play Store.

4355

# Android App ID, for example, com.google.android.apps.maps, can be found in

4356

# Google Play Store URL.

4357

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

4358

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4359

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4360

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4361

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4362

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4363

"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]

4368

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

4369

# request. It only applies to Private Auction, AdX Preferred Deals and

4370

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

4371

# and Preferred Deals in Ad Manager.

4372

"targetedInventorySizes": [ # A list of inventory sizes to be included.

4373

{ # Represents size of a single ad slot, or a creative.

4374

"width": "A String", # The width of the ad slot in pixels.

4375

# This field will be present only when size type is `PIXEL`.

4376

"height": "A String", # The height of the ad slot in pixels.

4377

# This field will be present only when size type is `PIXEL`.

4378

"sizeType": "A String", # The size type of the ad slot.

4379

},

4380

],

4381

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

4382

{ # Represents size of a single ad slot, or a creative.

4383

"width": "A String", # The width of the ad slot in pixels.

4384

# This field will be present only when size type is `PIXEL`.

4385

"height": "A String", # The height of the ad slot in pixels.

4386

# This field will be present only when size type is `PIXEL`.

4387

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

4392

# included and excluded numeric IDs.

4393

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4394

"A String",

4395

],

4396

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

4401

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

4402

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

4403

# included and excluded numeric IDs.

4404

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4405

"A String",

4406

],

4407

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

4412

# included and excluded numeric IDs.

4413

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4414

"A String",

4415

],

4416

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

4422

# included and excluded numeric IDs.

4423

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4424

"A String",

4425

],

4426

"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.

4431

# included and excluded numeric IDs.

4432

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

4433

"A String",

4434

],

4435

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

4441

"targetedPositionTypes": [ # A list of video positions to be included.

4442

# When the included list is present, the excluded list must be empty.

4443

# When the excluded list is present, the included list must be empty.

4444

"A String",

4445

],

4446

"excludedPositionTypes": [ # A list of video positions to be excluded.

4447

# Position types can either be included or excluded (XOR).

4448

"A String",

4449

],

4450

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4451

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4452

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

4453

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4454

# operations (max-length: 1024 unicode code units).

4455

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4456

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4457

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4458

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4459

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4460

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4461

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4462

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

4463

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4464

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

4465

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4466

},

4467

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4468

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4469

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4470

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4471

"availableEndTime": "A String", # Proposed flight end time of the deal.

4472

# This will generally be stored in a granularity of a second.

4473

# A value is not required for Private Auction deals or Preferred Deals.

4474

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

4475

# This will generally be stored in the granularity of one second since deal

4476

# serving starts at seconds boundary. Any time specified with more

4477

# granularity (e.g., in milliseconds) will be truncated towards the start of

4478

# time in seconds.

4479

"displayName": "A String", # The name of the deal.

4480

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

4481

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

4482

# If present on create, and the server `product_revision` has advanced sinced

4483

# the passed-in `create_product_revision`, an `ABORTED` error will be

4484

# returned.

4485

#

4486

# Note: This field may be set only when creating the resource. Modifying

4487

# this field while updating the resource will result in an error.

4488

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

4489

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

4490

"sellerContacts": [ # Output only. Seller contact information for the deal.

4491

{ # Contains information on how a buyer or seller can be reached.

4492

"name": "A String", # The name of the contact.

4493

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4494

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4495

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4496

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4497

"syndicationProduct": "A String", # The syndication product associated with the deal.

4498

#

4499

# Note: This field may be set only when creating the resource. Modifying

4500

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4501

},

4502

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4503

"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.

4504

# Authorized Buyers account ID.

4505

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4506

},

4507

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4508

"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]

4509

#

4510

# Note: This field may be set only when creating the resource. Modifying

4511

# this field while updating the resource will result in an error.

4512

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4513

"subAccountId": "A String", # Optional sub-account ID for the seller.

4514

"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]

4515

# The seller account ID is then available to buyer in the product.

4516

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4517

"updateTime": "A String", # Output only. The time when the proposal was last revised.

4518

"proposalId": "A String", # Output only. The unique ID of the proposal.

4519

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

4520

"proposalState": "A String", # Output only. The current state of the proposal.

4521

"notes": [ # Output only. The notes associated with this proposal.

4522

{ # A proposal may be associated to several notes.

4523

"noteId": "A String", # Output only. The unique ID for the note.

4524

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

4525

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

4526

"createTime": "A String", # Output only. The timestamp for when this note was created.

4527

"note": "A String", # The actual note to attach.

4528

# (max-length: 1024 unicode code units)

4529

#

4530

# Note: This field may be set only when creating the resource. Modifying

4531

# this field while updating the resource will result in an error.

4532

},

4533

],

4534

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

4540

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

4541

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

4542

# operations (max-length: 1024 unicode code units).

4543

},

4544

"buyerContacts": [ # Contact information for the buyer.

4545

{ # Contains information on how a buyer or seller can be reached.

4546

"name": "A String", # The name of the contact.

4547

"email": "A String", # Email address for the contact.

4548

},

4549

],

4550

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

4551

# proposal.

4552

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4553

# proposal.

4554

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

4555

#

4556

# Note: This field may be set only when creating the resource. Modifying

4557

# this field while updating the resource will result in an error.

4558

# Authorized Buyers account ID.

4559

"accountId": "A String", # Authorized Buyers account ID of the buyer.

4560

},

4561

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

4562

# left a comment.

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-05-27 12:20:54 -0700

[diff] [blame]

4625

"proposalRevision": "A String", # Output only. The revision number for the proposal.

4626

# Each update to the proposal or the deal causes the proposal revision number

4627

# to auto-increment. The buyer keeps track of the last revision number they

4628

# know of and pass it in when making an update. If the head revision number

4629

# on the server has since incremented, then an ABORTED error is returned

4630

# during the update operation to let the buyer know that a subsequent update

4631

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4632

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4633

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4634

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

4635

{ # A deal represents a segment of inventory for displaying ads on.

4636

# A proposal can contain multiple deals. A deal contains the terms and

4637

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4638

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

4639

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

4640

# deal.

4641

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4642

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

4643

# PUBLISHER means creative is provided by seller and ADVERTISER means

4644

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4645

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

4646

# targeting entity is AND'd together.

4647

{ # Advertisers can target different attributes of an ad slot. For example,

4648

# they can choose to show ads only if the user is in the U.S. Such

4649

# targeting criteria can be specified as part of Shared Targeting.

4650

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

4651

# together.

4652

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4653

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4654

# Filled in when the key is GOOG_DAYPART_TARGETING.

4655

# The definition of this targeting is derived from the structure

4656

# used by Ad Manager.

4657

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4658

"dayParts": [ # A list of day part targeting criterion.

4659

{ # Daypart targeting message that specifies if the ad can be shown

4660

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4661

"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

4662

# granularity). The end time is exclusive. This field is not available

4663

# for filtering in PQL queries.

4664

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4665

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4666

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4667

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4668

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4669

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4670

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4671

# allow the value 60 if it allows leap-seconds.

4672

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4673

"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).

4674

# The start time is inclusive.

4675

# This field is not available for filtering in PQL queries.

4676

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4677

# types are google.type.Date and `google.protobuf.Timestamp`.

4678

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4679

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4680

# to allow the value "24:00:00" for scenarios like business closing time.

4681

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4682

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4683

# allow the value 60 if it allows leap-seconds.

4684

},

4685

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4686

},

4687

],

4688

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4689

"longValue": "A String", # The long value to include/exclude.

4690

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4691

# Filled in when key = GOOG_CREATIVE_SIZE

4692

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4693

# only if creative_size_type = CreativeSizeType.NATIVE.

4694

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4695

# of the creative

4696

# height depend on the type of the targeting.

4697

"width": 42, # The width of the creative

4698

"height": 42, # The height of the creative.

4699

},

4700

"creativeSizeType": "A String", # The creative size type.

4701

"allowedFormats": [ # What formats are allowed by the publisher.

4702

# If this repeated field is empty then all formats are allowed.

4703

# For example, if this field contains AllowedFormatType.AUDIO then the

4704

# publisher only allows an audio ad (without any video).

4705

"A String",

4706

],

4707

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4708

# creative_size_type = CreativeSizeType.VIDEO.

4709

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4710

# Companion sizes may be filled in only when creative_size_type = VIDEO

4711

{ # Message depicting the size of the creative. The units of width and

4712

# height depend on the type of the targeting.

4713

"width": 42, # The width of the creative

4714

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

4719

},

4720

],

4721

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

4722

# together.

4723

{ # A polymorphic targeting value used as part of Shared Targeting.

4724

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

4725

# Filled in when the key is GOOG_DAYPART_TARGETING.

4726

# The definition of this targeting is derived from the structure

4727

# used by Ad Manager.

4728

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

4729

"dayParts": [ # A list of day part targeting criterion.

4730

{ # Daypart targeting message that specifies if the ad can be shown

4731

# only during certain parts of a day/week.

4732

"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

4733

# granularity). The end time is exclusive. This field is not available

4734

# for filtering in PQL queries.

4735

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4736

# types are google.type.Date and `google.protobuf.Timestamp`.

4737

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4738

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4739

# to allow the value "24:00:00" for scenarios like business closing time.

4740

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4741

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4742

# allow the value 60 if it allows leap-seconds.

4743

},

4744

"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).

4745

# The start time is inclusive.

4746

# This field is not available for filtering in PQL queries.

4747

# or are specified elsewhere. An API may choose to allow leap seconds. Related

4748

# types are google.type.Date and `google.protobuf.Timestamp`.

4749

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

4750

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

4751

# to allow the value "24:00:00" for scenarios like business closing time.

4752

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

4753

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

4754

# allow the value 60 if it allows leap-seconds.

4755

},

4756

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

4761

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

4762

# Filled in when key = GOOG_CREATIVE_SIZE

4763

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

4764

# only if creative_size_type = CreativeSizeType.NATIVE.

4765

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

4766

# of the creative

4767

# height depend on the type of the targeting.

4768

"width": 42, # The width of the creative

4769

"height": 42, # The height of the creative.

4770

},

4771

"creativeSizeType": "A String", # The creative size type.

4772

"allowedFormats": [ # What formats are allowed by the publisher.

4773

# If this repeated field is empty then all formats are allowed.

4774

# For example, if this field contains AllowedFormatType.AUDIO then the

4775

# publisher only allows an audio ad (without any video).

4776

"A String",

4777

],

4778

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

4779

# creative_size_type = CreativeSizeType.VIDEO.

4780

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

4781

# Companion sizes may be filled in only when creative_size_type = VIDEO

4782

{ # Message depicting the size of the creative. The units of width and

4783

# height depend on the type of the targeting.

4784

"width": 42, # The width of the creative

4785

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4790

},

4791

],

4792

"key": "A String", # The key representing the shared targeting criterion.

4793

# Targeting criteria defined by Google ad servers will begin with GOOG_.

4794

# Third parties may define their own keys.

4795

# A list of permissible keys along with the acceptable values will be

4796

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4797

},

4798

],

4799

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

4800

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

4801

# in Ad Manager.

4802

# Preferred Deal in Ad Manager.

4803

# This doesn't apply to Private Auction and AdX Preferred Deals.

4804

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

4805

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

4806

"creativeSpecifications": [

4807

{ # Represents information for a creative that is associated with a Programmatic

4808

# Guaranteed/Preferred Deal in Ad Manager.

4809

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

4810

"width": "A String", # The width of the ad slot in pixels.

4811

# This field will be present only when size type is `PIXEL`.

4812

"height": "A String", # The height of the ad slot in pixels.

4813

# This field will be present only when size type is `PIXEL`.

4814

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4815

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4816

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

4817

{ # Represents size of a single ad slot, or a creative.

4818

"width": "A String", # The width of the ad slot in pixels.

4819

# This field will be present only when size type is `PIXEL`.

4820

"height": "A String", # The height of the ad slot in pixels.

4821

# This field will be present only when size type is `PIXEL`.

4822

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

4829

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

4830

# The deal is considered paused if either hasBuyerPaused or

4831

# hasSellPaused is true.

4832

"firstPausedBy": "A String", # The role of the person who first paused this deal.

4833

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

4834

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

4835

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

4836

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4837

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4838

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4839

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

4840

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

4841

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4842

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

4843

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

4844

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

4845

# of guaranteed looks that the buyer is guaranteeing to buy.

4846

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4847

"fixedPrices": [ # Fixed price for the specified buyer.

4848

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4849

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4850

# a particular buyer or buyer/advertiser pair, we look for the most specific

4851

# matching rule - we first look for a rule matching the buyer and advertiser,

4852

# next a rule with the buyer but an empty advertiser list, and otherwise look

4853

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4854

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4855

# If empty, all advertisers with this buyer pay this price.

4856

"A String",

4857

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4858

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4859

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4860

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4861

"units": "A String", # The whole units of the amount.

4862

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4863

"nanos": 42, # Number of nano (10^-9) units of the amount.

4864

# The value must be between -999,999,999 and +999,999,999 inclusive.

4865

# If `units` is positive, `nanos` must be positive or zero.

4866

# If `units` is zero, `nanos` can be positive, zero, or negative.

4867

# If `units` is negative, `nanos` must be negative or zero.

4868

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4869

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4870

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4871

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4872

"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

4873

# (if the

4874

# advertisers match, and there's no more specific rule matching the buyer).

4875

# Authorized Buyers account ID.

4876

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4881

"description": "A String", # Publisher provided description for the terms.

4882

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

4883

# time zone used to mark the boundaries of a day. It should be an

4884

# IANA TZ name, such as "America/Los_Angeles". For more information,

4885

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4886

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

4887

# Can be set by buyer or seller.

4888

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

4889

# by the seller, but they can be returned in a get or list request.

4890

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

4891

# in this private auction.

4892

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

4893

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4894

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4895

# a particular buyer or buyer/advertiser pair, we look for the most specific

4896

# matching rule - we first look for a rule matching the buyer and advertiser,

4897

# next a rule with the buyer but an empty advertiser list, and otherwise look

4898

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4899

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4900

# If empty, all advertisers with this buyer pay this price.

4901

"A String",

4902

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4903

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4904

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4905

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4906

"units": "A String", # The whole units of the amount.

4907

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4908

"nanos": 42, # Number of nano (10^-9) units of the amount.

4909

# The value must be between -999,999,999 and +999,999,999 inclusive.

4910

# If `units` is positive, `nanos` must be positive or zero.

4911

# If `units` is zero, `nanos` can be positive, zero, or negative.

4912

# If `units` is negative, `nanos` must be negative or zero.

4913

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4914

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4915

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4916

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4917

"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

4918

# (if the

4919

# advertisers match, and there's no more specific rule matching the buyer).

4920

# Authorized Buyers account ID.

4921

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

4927

# the API at this time, but can be returned in a get or list request.

4928

"fixedPrices": [ # Fixed price for the specified buyer.

4929

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

4930

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

4931

# a particular buyer or buyer/advertiser pair, we look for the most specific

4932

# matching rule - we first look for a rule matching the buyer and advertiser,

4933

# next a rule with the buyer but an empty advertiser list, and otherwise look

4934

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4935

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

4936

# If empty, all advertisers with this buyer pay this price.

4937

"A String",

4938

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4939

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

4940

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

4941

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

4942

"units": "A String", # The whole units of the amount.

4943

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

4944

"nanos": 42, # Number of nano (10^-9) units of the amount.

4945

# The value must be between -999,999,999 and +999,999,999 inclusive.

4946

# If `units` is positive, `nanos` must be positive or zero.

4947

# If `units` is zero, `nanos` can be positive, zero, or negative.

4948

# If `units` is negative, `nanos` must be negative or zero.

4949

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

4950

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

4951

},

4952

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4953

"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

4954

# (if the

4955

# advertisers match, and there's no more specific rule matching the buyer).

4956

# Authorized Buyers account ID.

4957

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

4963

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4964

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4965

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4966

"units": "A String", # The whole units of the amount.

4967

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4968

"nanos": 42, # Number of nano (10^-9) units of the amount.

4969

# The value must be between -999,999,999 and +999,999,999 inclusive.

4970

# If `units` is positive, `nanos` must be positive or zero.

4971

# If `units` is zero, `nanos` can be positive, zero, or negative.

4972

# If `units` is negative, `nanos` must be negative or zero.

4973

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4974

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4975

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4976

},

4977

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4978

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4979

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

4980

# finalized. This is the deal ID that shows up in serving/reporting etc.

4981

"createProductId": "A String", # The product ID from which this deal was created.

4982

#

4983

# Note: This field may be set only when creating the resource. Modifying

4984

# this field while updating the resource will result in an error.

4985

"updateTime": "A String", # Output only. The time when the deal was last updated.

4986

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4987

"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]

4988

# target ad inventory. For example, they can choose to target ad requests only

4989

# if the user is in the US.

4990

# Multiple types of targeting are always applied as a logical AND, unless noted

4991

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4992

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

4993

# mobile applications.

4994

# Different placement targeting types will be logically OR'ed.

4995

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

4996

# For Private Auction and AdX Preferred Deals, URLs are either included or

4997

# excluded.

4998

# For Programmatic Guaranteed and Preferred Deals, this doesn't

4999

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5000

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5001

"A String",

5002

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5003

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5008

# This doesn't apply to Auction Packages.

5009

"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]

5010

# display the ads in.

5011

# publishers own.

5012

# Mobile application IDs are from App Store and Google Play Store.

5013

# Android App ID, for example, com.google.android.apps.maps, can be found in

5014

# Google Play Store URL.

5015

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5016

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5017

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5018

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5019

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5020

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5021

"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]

5026

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

5027

# request. It only applies to Private Auction, AdX Preferred Deals and

5028

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5029

# and Preferred Deals in Ad Manager.

5030

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5031

{ # Represents size of a single ad slot, or a creative.

5032

"width": "A String", # The width of the ad slot in pixels.

5033

# This field will be present only when size type is `PIXEL`.

5034

"height": "A String", # The height of the ad slot in pixels.

5035

# This field will be present only when size type is `PIXEL`.

5036

"sizeType": "A String", # The size type of the ad slot.

5037

},

5038

],

5039

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5040

{ # Represents size of a single ad slot, or a creative.

5041

"width": "A String", # The width of the ad slot in pixels.

5042

# This field will be present only when size type is `PIXEL`.

5043

"height": "A String", # The height of the ad slot in pixels.

5044

# This field will be present only when size type is `PIXEL`.

5045

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5050

# included and excluded numeric IDs.

5051

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5052

"A String",

5053

],

5054

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

5059

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5060

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

5061

# included and excluded numeric IDs.

5062

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5063

"A String",

5064

],

5065

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5070

# included and excluded numeric IDs.

5071

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5072

"A String",

5073

],

5074

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5080

# included and excluded numeric IDs.

5081

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5082

"A String",

5083

],

5084

"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.

5089

# included and excluded numeric IDs.

5090

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5091

"A String",

5092

],

5093

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5099

"targetedPositionTypes": [ # A list of video positions to be included.

5100

# When the included list is present, the excluded list must be empty.

5101

# When the excluded list is present, the included list must be empty.

5102

"A String",

5103

],

5104

"excludedPositionTypes": [ # A list of video positions to be excluded.

5105

# Position types can either be included or excluded (XOR).

5106

"A String",

5107

],

5108

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5109

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5110

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5111

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5112

# operations (max-length: 1024 unicode code units).

5113

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5114

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5115

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5116

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5117

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5118

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5119

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5120

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5121

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5122

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

5123

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5124

},

5125

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5126

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5127

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5128

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5129

"availableEndTime": "A String", # Proposed flight end time of the deal.

5130

# This will generally be stored in a granularity of a second.

5131

# A value is not required for Private Auction deals or Preferred Deals.

5132

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

5133

# This will generally be stored in the granularity of one second since deal

5134

# serving starts at seconds boundary. Any time specified with more

5135

# granularity (e.g., in milliseconds) will be truncated towards the start of

5136

# time in seconds.

5137

"displayName": "A String", # The name of the deal.

5138

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5139

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

5140

# If present on create, and the server `product_revision` has advanced sinced

5141

# the passed-in `create_product_revision`, an `ABORTED` error will be

5142

# returned.

5143

#

5144

# Note: This field may be set only when creating the resource. Modifying

5145

# this field while updating the resource will result in an error.

5146

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5147

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

5148

"sellerContacts": [ # Output only. Seller contact information for the deal.

5149

{ # Contains information on how a buyer or seller can be reached.

5150

"name": "A String", # The name of the contact.

5151

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5152

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5153

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5154

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5155

"syndicationProduct": "A String", # The syndication product associated with the deal.

5156

#

5157

# Note: This field may be set only when creating the resource. Modifying

5158

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5159

},

5160

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5161

"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.

5162

# Authorized Buyers account ID.

5163

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5164

},

5165

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5166

"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]

5167

#

5168

# Note: This field may be set only when creating the resource. Modifying

5169

# this field while updating the resource will result in an error.

5170

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5171

"subAccountId": "A String", # Optional sub-account ID for the seller.

5172

"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]

5173

# The seller account ID is then available to buyer in the product.

5174

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5175

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5176

"proposalId": "A String", # Output only. The unique ID of the proposal.

5177

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5178

"proposalState": "A String", # Output only. The current state of the proposal.

5179

"notes": [ # Output only. The notes associated with this proposal.

5180

{ # A proposal may be associated to several notes.

5181

"noteId": "A String", # Output only. The unique ID for the note.

5182

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5183

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5184

"createTime": "A String", # Output only. The timestamp for when this note was created.

5185

"note": "A String", # The actual note to attach.

5186

# (max-length: 1024 unicode code units)

5187

#

5188

# Note: This field may be set only when creating the resource. Modifying

5189

# this field while updating the resource will result in an error.

5190

},

5191

],

5192

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

5198

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5199

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5200

# operations (max-length: 1024 unicode code units).

5201

},

5202

"buyerContacts": [ # Contact information for the buyer.

5203

{ # Contains information on how a buyer or seller can be reached.

5204

"name": "A String", # The name of the contact.

5205

"email": "A String", # Email address for the contact.

5206

},

5207

],

5208

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5209

# proposal.

5210

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5211

# proposal.

5212

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5213

#

5214

# Note: This field may be set only when creating the resource. Modifying

5215

# this field while updating the resource will result in an error.

5216

# Authorized Buyers account ID.

5217

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5218

},

5219

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5220

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="resume">resume(accountId, proposalId, body=None, x__xgafv=None)</code>

5226

<pre>Update the given proposal to resume serving.

5227

This method will set the

5228

`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all

5229

deals in the proposal.

5230

5231

Note that if the `has_seller_paused` bit is also set, serving will not

5232

resume until the seller also resumes.

5233

5234

It is a no-op to resume an already-running proposal.

5235

It is an error to call ResumeProposal for a proposal that is not

5236

finalized or renegotiating.

5237

5238

Args:

5239

accountId: string, Account ID of the buyer. (required)

5240

proposalId: string, The ID of the proposal to resume. (required)

5241

body: object, The request body.

5242

The object takes the form of:

5243

5244

{ # Request message to resume (unpause) serving for an already-finalized

# proposal.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5255

5256

{ # Note: this resource requires whitelisting for access. Please contact your

5257

# account manager for access to Marketplace resources.

5258

#

5259

# Represents a proposal in the Marketplace. A proposal is the unit of

5260

# negotiation between a seller and a buyer and contains deals which

5261

# are served.

5262

#

5263

# Note: you can not update, create, or otherwise modify Private

5264

# Auction or Preferred Deals deals through the API.

5265

#

5266

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5267

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5268

# Each update to the proposal or the deal causes the proposal revision number

5269

# to auto-increment. The buyer keeps track of the last revision number they

5270

# know of and pass it in when making an update. If the head revision number

5271

# on the server has since incremented, then an ABORTED error is returned

5272

# during the update operation to let the buyer know that a subsequent update

5273

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5274

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5275

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5276

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5277

{ # A deal represents a segment of inventory for displaying ads on.

5278

# A proposal can contain multiple deals. A deal contains the terms and

5279

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5280

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

5281

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5282

# deal.

5283

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5284

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5285

# PUBLISHER means creative is provided by seller and ADVERTISER means

5286

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5287

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5288

# targeting entity is AND'd together.

5289

{ # Advertisers can target different attributes of an ad slot. For example,

5290

# they can choose to show ads only if the user is in the U.S. Such

5291

# targeting criteria can be specified as part of Shared Targeting.

5292

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5293

# together.

5294

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5295

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5296

# Filled in when the key is GOOG_DAYPART_TARGETING.

5297

# The definition of this targeting is derived from the structure

5298

# used by Ad Manager.

5299

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5300

"dayParts": [ # A list of day part targeting criterion.

5301

{ # Daypart targeting message that specifies if the ad can be shown

5302

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5303

"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

5304

# granularity). The end time is exclusive. This field is not available

5305

# for filtering in PQL queries.

5306

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5307

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5308

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5309

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5310

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5311

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5312

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5313

# allow the value 60 if it allows leap-seconds.

5314

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5315

"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).

5316

# The start time is inclusive.

5317

# This field is not available for filtering in PQL queries.

5318

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5319

# types are google.type.Date and `google.protobuf.Timestamp`.

5320

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5321

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5322

# to allow the value "24:00:00" for scenarios like business closing time.

5323

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5324

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5325

# allow the value 60 if it allows leap-seconds.

5326

},

5327

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5328

},

5329

],

5330

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5331

"longValue": "A String", # The long value to include/exclude.

5332

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5333

# Filled in when key = GOOG_CREATIVE_SIZE

5334

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5335

# only if creative_size_type = CreativeSizeType.NATIVE.

5336

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5337

# of the creative

5338

# height depend on the type of the targeting.

5339

"width": 42, # The width of the creative

5340

"height": 42, # The height of the creative.

5341

},

5342

"creativeSizeType": "A String", # The creative size type.

5343

"allowedFormats": [ # What formats are allowed by the publisher.

5344

# If this repeated field is empty then all formats are allowed.

5345

# For example, if this field contains AllowedFormatType.AUDIO then the

5346

# publisher only allows an audio ad (without any video).

5347

"A String",

5348

],

5349

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5350

# creative_size_type = CreativeSizeType.VIDEO.

5351

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5352

# Companion sizes may be filled in only when creative_size_type = VIDEO

5353

{ # Message depicting the size of the creative. The units of width and

5354

# height depend on the type of the targeting.

5355

"width": 42, # The width of the creative

5356

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

5361

},

5362

],

5363

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5364

# together.

5365

{ # A polymorphic targeting value used as part of Shared Targeting.

5366

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5367

# Filled in when the key is GOOG_DAYPART_TARGETING.

5368

# The definition of this targeting is derived from the structure

5369

# used by Ad Manager.

5370

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5371

"dayParts": [ # A list of day part targeting criterion.

5372

{ # Daypart targeting message that specifies if the ad can be shown

5373

# only during certain parts of a day/week.

5374

"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

5375

# granularity). The end time is exclusive. This field is not available

5376

# for filtering in PQL queries.

5377

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5378

# types are google.type.Date and `google.protobuf.Timestamp`.

5379

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5380

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5381

# to allow the value "24:00:00" for scenarios like business closing time.

5382

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5383

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5384

# allow the value 60 if it allows leap-seconds.

5385

},

5386

"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).

5387

# The start time is inclusive.

5388

# This field is not available for filtering in PQL queries.

5389

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5390

# types are google.type.Date and `google.protobuf.Timestamp`.

5391

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5392

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5393

# to allow the value "24:00:00" for scenarios like business closing time.

5394

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5395

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5396

# allow the value 60 if it allows leap-seconds.

5397

},

5398

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

5403

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5404

# Filled in when key = GOOG_CREATIVE_SIZE

5405

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5406

# only if creative_size_type = CreativeSizeType.NATIVE.

5407

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5408

# of the creative

5409

# height depend on the type of the targeting.

5410

"width": 42, # The width of the creative

5411

"height": 42, # The height of the creative.

5412

},

5413

"creativeSizeType": "A String", # The creative size type.

5414

"allowedFormats": [ # What formats are allowed by the publisher.

5415

# If this repeated field is empty then all formats are allowed.

5416

# For example, if this field contains AllowedFormatType.AUDIO then the

5417

# publisher only allows an audio ad (without any video).

5418

"A String",

5419

],

5420

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5421

# creative_size_type = CreativeSizeType.VIDEO.

5422

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5423

# Companion sizes may be filled in only when creative_size_type = VIDEO

5424

{ # Message depicting the size of the creative. The units of width and

5425

# height depend on the type of the targeting.

5426

"width": 42, # The width of the creative

5427

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5432

},

5433

],

5434

"key": "A String", # The key representing the shared targeting criterion.

5435

# Targeting criteria defined by Google ad servers will begin with GOOG_.

5436

# Third parties may define their own keys.

5437

# A list of permissible keys along with the acceptable values will be

5438

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5439

},

5440

],

5441

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

5442

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

5443

# in Ad Manager.

5444

# Preferred Deal in Ad Manager.

5445

# This doesn't apply to Private Auction and AdX Preferred Deals.

5446

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

5447

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

5448

"creativeSpecifications": [

5449

{ # Represents information for a creative that is associated with a Programmatic

5450

# Guaranteed/Preferred Deal in Ad Manager.

5451

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

5452

"width": "A String", # The width of the ad slot in pixels.

5453

# This field will be present only when size type is `PIXEL`.

5454

"height": "A String", # The height of the ad slot in pixels.

5455

# This field will be present only when size type is `PIXEL`.

5456

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5457

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5458

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

5459

{ # Represents size of a single ad slot, or a creative.

5460

"width": "A String", # The width of the ad slot in pixels.

5461

# This field will be present only when size type is `PIXEL`.

5462

"height": "A String", # The height of the ad slot in pixels.

5463

# This field will be present only when size type is `PIXEL`.

5464

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

5471

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

5472

# The deal is considered paused if either hasBuyerPaused or

5473

# hasSellPaused is true.

5474

"firstPausedBy": "A String", # The role of the person who first paused this deal.

5475

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

5476

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

5477

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

5478

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5479

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5480

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5481

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

5482

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

5483

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5484

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

5485

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

5486

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

5487

# of guaranteed looks that the buyer is guaranteeing to buy.

5488

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5489

"fixedPrices": [ # Fixed price for the specified buyer.

5490

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5491

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5492

# a particular buyer or buyer/advertiser pair, we look for the most specific

5493

# matching rule - we first look for a rule matching the buyer and advertiser,

5494

# next a rule with the buyer but an empty advertiser list, and otherwise look

5495

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5496

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5497

# If empty, all advertisers with this buyer pay this price.

5498

"A String",

5499

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5500

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5501

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5502

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5503

"units": "A String", # The whole units of the amount.

5504

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5505

"nanos": 42, # Number of nano (10^-9) units of the amount.

5506

# The value must be between -999,999,999 and +999,999,999 inclusive.

5507

# If `units` is positive, `nanos` must be positive or zero.

5508

# If `units` is zero, `nanos` can be positive, zero, or negative.

5509

# If `units` is negative, `nanos` must be negative or zero.

5510

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5511

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5512

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5513

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5514

"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

5515

# (if the

5516

# advertisers match, and there's no more specific rule matching the buyer).

5517

# Authorized Buyers account ID.

5518

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5523

"description": "A String", # Publisher provided description for the terms.

5524

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

5525

# time zone used to mark the boundaries of a day. It should be an

5526

# IANA TZ name, such as "America/Los_Angeles". For more information,

5527

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5528

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

5529

# Can be set by buyer or seller.

5530

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

5531

# by the seller, but they can be returned in a get or list request.

5532

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

5533

# in this private auction.

5534

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

5535

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5536

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5537

# a particular buyer or buyer/advertiser pair, we look for the most specific

5538

# matching rule - we first look for a rule matching the buyer and advertiser,

5539

# next a rule with the buyer but an empty advertiser list, and otherwise look

5540

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5541

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5542

# If empty, all advertisers with this buyer pay this price.

5543

"A String",

5544

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5545

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5546

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5547

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5548

"units": "A String", # The whole units of the amount.

5549

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5550

"nanos": 42, # Number of nano (10^-9) units of the amount.

5551

# The value must be between -999,999,999 and +999,999,999 inclusive.

5552

# If `units` is positive, `nanos` must be positive or zero.

5553

# If `units` is zero, `nanos` can be positive, zero, or negative.

5554

# If `units` is negative, `nanos` must be negative or zero.

5555

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5556

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5557

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5558

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5559

"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

5560

# (if the

5561

# advertisers match, and there's no more specific rule matching the buyer).

5562

# Authorized Buyers account ID.

5563

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

5569

# the API at this time, but can be returned in a get or list request.

5570

"fixedPrices": [ # Fixed price for the specified buyer.

5571

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

5572

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

5573

# a particular buyer or buyer/advertiser pair, we look for the most specific

5574

# matching rule - we first look for a rule matching the buyer and advertiser,

5575

# next a rule with the buyer but an empty advertiser list, and otherwise look

5576

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5577

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

5578

# If empty, all advertisers with this buyer pay this price.

5579

"A String",

5580

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5581

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

5582

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

5583

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

5584

"units": "A String", # The whole units of the amount.

5585

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

5586

"nanos": 42, # Number of nano (10^-9) units of the amount.

5587

# The value must be between -999,999,999 and +999,999,999 inclusive.

5588

# If `units` is positive, `nanos` must be positive or zero.

5589

# If `units` is zero, `nanos` can be positive, zero, or negative.

5590

# If `units` is negative, `nanos` must be negative or zero.

5591

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

5592

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

5593

},

5594

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5595

"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

5596

# (if the

5597

# advertisers match, and there's no more specific rule matching the buyer).

5598

# Authorized Buyers account ID.

5599

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

5605

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5606

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5607

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5608

"units": "A String", # The whole units of the amount.

5609

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5610

"nanos": 42, # Number of nano (10^-9) units of the amount.

5611

# The value must be between -999,999,999 and +999,999,999 inclusive.

5612

# If `units` is positive, `nanos` must be positive or zero.

5613

# If `units` is zero, `nanos` can be positive, zero, or negative.

5614

# If `units` is negative, `nanos` must be negative or zero.

5615

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5616

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5617

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5618

},

5619

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5620

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5621

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

5622

# finalized. This is the deal ID that shows up in serving/reporting etc.

5623

"createProductId": "A String", # The product ID from which this deal was created.

5624

#

5625

# Note: This field may be set only when creating the resource. Modifying

5626

# this field while updating the resource will result in an error.

5627

"updateTime": "A String", # Output only. The time when the deal was last updated.

5628

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5629

"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]

5630

# target ad inventory. For example, they can choose to target ad requests only

5631

# if the user is in the US.

5632

# Multiple types of targeting are always applied as a logical AND, unless noted

5633

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5634

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

5635

# mobile applications.

5636

# Different placement targeting types will be logically OR'ed.

5637

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

5638

# For Private Auction and AdX Preferred Deals, URLs are either included or

5639

# excluded.

5640

# For Programmatic Guaranteed and Preferred Deals, this doesn't

5641

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5642

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5643

"A String",

5644

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5645

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

5650

# This doesn't apply to Auction Packages.

5651

"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]

5652

# display the ads in.

5653

# publishers own.

5654

# Mobile application IDs are from App Store and Google Play Store.

5655

# Android App ID, for example, com.google.android.apps.maps, can be found in

5656

# Google Play Store URL.

5657

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

5658

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5659

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5660

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5661

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5662

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5663

"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]

5668

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

5669

# request. It only applies to Private Auction, AdX Preferred Deals and

5670

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

5671

# and Preferred Deals in Ad Manager.

5672

"targetedInventorySizes": [ # A list of inventory sizes to be included.

5673

{ # Represents size of a single ad slot, or a creative.

5674

"width": "A String", # The width of the ad slot in pixels.

5675

# This field will be present only when size type is `PIXEL`.

5676

"height": "A String", # The height of the ad slot in pixels.

5677

# This field will be present only when size type is `PIXEL`.

5678

"sizeType": "A String", # The size type of the ad slot.

5679

},

5680

],

5681

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

5682

{ # Represents size of a single ad slot, or a creative.

5683

"width": "A String", # The width of the ad slot in pixels.

5684

# This field will be present only when size type is `PIXEL`.

5685

"height": "A String", # The height of the ad slot in pixels.

5686

# This field will be present only when size type is `PIXEL`.

5687

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

5692

# included and excluded numeric IDs.

5693

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5694

"A String",

5695

],

5696

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

5701

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

5702

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

5703

# included and excluded numeric IDs.

5704

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5705

"A String",

5706

],

5707

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

5712

# included and excluded numeric IDs.

5713

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5714

"A String",

5715

],

5716

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

5722

# included and excluded numeric IDs.

5723

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5724

"A String",

5725

],

5726

"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.

5731

# included and excluded numeric IDs.

5732

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

5733

"A String",

5734

],

5735

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

5741

"targetedPositionTypes": [ # A list of video positions to be included.

5742

# When the included list is present, the excluded list must be empty.

5743

# When the excluded list is present, the included list must be empty.

5744

"A String",

5745

],

5746

"excludedPositionTypes": [ # A list of video positions to be excluded.

5747

# Position types can either be included or excluded (XOR).

5748

"A String",

5749

],

5750

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5751

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5752

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

5753

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5754

# operations (max-length: 1024 unicode code units).

5755

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5756

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5757

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5758

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5759

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5760

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5761

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5762

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

5763

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5764

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

5765

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5766

},

5767

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5768

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5769

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5770

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5771

"availableEndTime": "A String", # Proposed flight end time of the deal.

5772

# This will generally be stored in a granularity of a second.

5773

# A value is not required for Private Auction deals or Preferred Deals.

5774

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

5775

# This will generally be stored in the granularity of one second since deal

5776

# serving starts at seconds boundary. Any time specified with more

5777

# granularity (e.g., in milliseconds) will be truncated towards the start of

5778

# time in seconds.

5779

"displayName": "A String", # The name of the deal.

5780

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

5781

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

5782

# If present on create, and the server `product_revision` has advanced sinced

5783

# the passed-in `create_product_revision`, an `ABORTED` error will be

5784

# returned.

5785

#

5786

# Note: This field may be set only when creating the resource. Modifying

5787

# this field while updating the resource will result in an error.

5788

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

5789

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

5790

"sellerContacts": [ # Output only. Seller contact information for the deal.

5791

{ # Contains information on how a buyer or seller can be reached.

5792

"name": "A String", # The name of the contact.

5793

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5794

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5795

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5796

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5797

"syndicationProduct": "A String", # The syndication product associated with the deal.

5798

#

5799

# Note: This field may be set only when creating the resource. Modifying

5800

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5801

},

5802

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5803

"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.

5804

# Authorized Buyers account ID.

5805

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5806

},

5807

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5808

"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]

5809

#

5810

# Note: This field may be set only when creating the resource. Modifying

5811

# this field while updating the resource will result in an error.

5812

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5813

"subAccountId": "A String", # Optional sub-account ID for the seller.

5814

"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]

5815

# The seller account ID is then available to buyer in the product.

5816

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5817

"updateTime": "A String", # Output only. The time when the proposal was last revised.

5818

"proposalId": "A String", # Output only. The unique ID of the proposal.

5819

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

5820

"proposalState": "A String", # Output only. The current state of the proposal.

5821

"notes": [ # Output only. The notes associated with this proposal.

5822

{ # A proposal may be associated to several notes.

5823

"noteId": "A String", # Output only. The unique ID for the note.

5824

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

5825

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

5826

"createTime": "A String", # Output only. The timestamp for when this note was created.

5827

"note": "A String", # The actual note to attach.

5828

# (max-length: 1024 unicode code units)

5829

#

5830

# Note: This field may be set only when creating the resource. Modifying

5831

# this field while updating the resource will result in an error.

5832

},

5833

],

5834

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

5840

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

5841

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

5842

# operations (max-length: 1024 unicode code units).

5843

},

5844

"buyerContacts": [ # Contact information for the buyer.

5845

{ # Contains information on how a buyer or seller can be reached.

5846

"name": "A String", # The name of the contact.

5847

"email": "A String", # Email address for the contact.

5848

},

5849

],

5850

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

5851

# proposal.

5852

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5853

# proposal.

5854

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

5855

#

5856

# Note: This field may be set only when creating the resource. Modifying

5857

# this field while updating the resource will result in an error.

5858

# Authorized Buyers account ID.

5859

"accountId": "A String", # Authorized Buyers account ID of the buyer.

5860

},

5861

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

5862

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5867

<code class="details" id="update">update(accountId, proposalId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5868

<pre>Update the given proposal at the client known revision number. If the

5869

server revision has advanced since the passed-in

5870

`proposal.proposal_revision`, an `ABORTED` error message will be returned.

5871

Only the buyer-modifiable fields of the proposal will be updated.

5872

5873

Note that the deals in the proposal will be updated to match the passed-in

5874

copy.

5875

If a passed-in deal does not have a `deal_id`, the server will assign a new

5876

unique ID and create the deal.

5877

If passed-in deal has a `deal_id`, it will be updated to match the

5878

passed-in copy.

5879

Any existing deals not present in the passed-in proposal will be deleted.

5880

It is an error to pass in a deal with a `deal_id` not present at head.

5881

5882

Args:

5883

accountId: string, Account ID of the buyer. (required)

5884

proposalId: string, The unique ID of the proposal. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5885

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5886

The object takes the form of:

5887

5888

{ # Note: this resource requires whitelisting for access. Please contact your

5889

# account manager for access to Marketplace resources.

5890

#

5891

# Represents a proposal in the Marketplace. A proposal is the unit of

5892

# negotiation between a seller and a buyer and contains deals which

5893

# are served.

5894

#

5895

# Note: you can not update, create, or otherwise modify Private

5896

# Auction or Preferred Deals deals through the API.

5897

#

5898

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5899

"proposalRevision": "A String", # Output only. The revision number for the proposal.

5900

# Each update to the proposal or the deal causes the proposal revision number

5901

# to auto-increment. The buyer keeps track of the last revision number they

5902

# know of and pass it in when making an update. If the head revision number

5903

# on the server has since incremented, then an ABORTED error is returned

5904

# during the update operation to let the buyer know that a subsequent update

5905

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5906

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5907

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5908

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

5909

{ # A deal represents a segment of inventory for displaying ads on.

5910

# A proposal can contain multiple deals. A deal contains the terms and

5911

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5912

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

5913

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

5914

# deal.

5915

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5916

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

5917

# PUBLISHER means creative is provided by seller and ADVERTISER means

5918

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5919

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

5920

# targeting entity is AND'd together.

5921

{ # Advertisers can target different attributes of an ad slot. For example,

5922

# they can choose to show ads only if the user is in the U.S. Such

5923

# targeting criteria can be specified as part of Shared Targeting.

5924

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

5925

# together.

5926

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5927

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5928

# Filled in when the key is GOOG_DAYPART_TARGETING.

5929

# The definition of this targeting is derived from the structure

5930

# used by Ad Manager.

5931

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

5932

"dayParts": [ # A list of day part targeting criterion.

5933

{ # Daypart targeting message that specifies if the ad can be shown

5934

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5935

"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

5936

# granularity). The end time is exclusive. This field is not available

5937

# for filtering in PQL queries.

5938

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5939

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5940

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5941

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5942

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5943

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5944

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5945

# allow the value 60 if it allows leap-seconds.

5946

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5947

"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).

5948

# The start time is inclusive.

5949

# This field is not available for filtering in PQL queries.

5950

# or are specified elsewhere. An API may choose to allow leap seconds. Related

5951

# types are google.type.Date and `google.protobuf.Timestamp`.

5952

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

5953

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

5954

# to allow the value "24:00:00" for scenarios like business closing time.

5955

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

5956

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

5957

# allow the value 60 if it allows leap-seconds.

5958

},

5959

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5960

},

5961

],

5962

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5963

"longValue": "A String", # The long value to include/exclude.

5964

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

5965

# Filled in when key = GOOG_CREATIVE_SIZE

5966

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

5967

# only if creative_size_type = CreativeSizeType.NATIVE.

5968

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

5969

# of the creative

5970

# height depend on the type of the targeting.

5971

"width": 42, # The width of the creative

5972

"height": 42, # The height of the creative.

5973

},

5974

"creativeSizeType": "A String", # The creative size type.

5975

"allowedFormats": [ # What formats are allowed by the publisher.

5976

# If this repeated field is empty then all formats are allowed.

5977

# For example, if this field contains AllowedFormatType.AUDIO then the

5978

# publisher only allows an audio ad (without any video).

5979

"A String",

5980

],

5981

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

5982

# creative_size_type = CreativeSizeType.VIDEO.

5983

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

5984

# Companion sizes may be filled in only when creative_size_type = VIDEO

5985

{ # Message depicting the size of the creative. The units of width and

5986

# height depend on the type of the targeting.

5987

"width": 42, # The width of the creative

5988

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

5993

},

5994

],

5995

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

5996

# together.

5997

{ # A polymorphic targeting value used as part of Shared Targeting.

5998

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

5999

# Filled in when the key is GOOG_DAYPART_TARGETING.

6000

# The definition of this targeting is derived from the structure

6001

# used by Ad Manager.

6002

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6003

"dayParts": [ # A list of day part targeting criterion.

6004

{ # Daypart targeting message that specifies if the ad can be shown

6005

# only during certain parts of a day/week.

6006

"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

6007

# granularity). The end time is exclusive. This field is not available

6008

# for filtering in PQL queries.

6009

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6010

# types are google.type.Date and `google.protobuf.Timestamp`.

6011

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6012

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6013

# to allow the value "24:00:00" for scenarios like business closing time.

6014

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6015

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6016

# allow the value 60 if it allows leap-seconds.

6017

},

6018

"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).

6019

# The start time is inclusive.

6020

# This field is not available for filtering in PQL queries.

6021

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6022

# types are google.type.Date and `google.protobuf.Timestamp`.

6023

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6024

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6025

# to allow the value "24:00:00" for scenarios like business closing time.

6026

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6027

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6028

# allow the value 60 if it allows leap-seconds.

6029

},

6030

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

6035

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6036

# Filled in when key = GOOG_CREATIVE_SIZE

6037

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6038

# only if creative_size_type = CreativeSizeType.NATIVE.

6039

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6040

# of the creative

6041

# height depend on the type of the targeting.

6042

"width": 42, # The width of the creative

6043

"height": 42, # The height of the creative.

6044

},

6045

"creativeSizeType": "A String", # The creative size type.

6046

"allowedFormats": [ # What formats are allowed by the publisher.

6047

# If this repeated field is empty then all formats are allowed.

6048

# For example, if this field contains AllowedFormatType.AUDIO then the

6049

# publisher only allows an audio ad (without any video).

6050

"A String",

6051

],

6052

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6053

# creative_size_type = CreativeSizeType.VIDEO.

6054

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6055

# Companion sizes may be filled in only when creative_size_type = VIDEO

6056

{ # Message depicting the size of the creative. The units of width and

6057

# height depend on the type of the targeting.

6058

"width": 42, # The width of the creative

6059

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6064

},

6065

],

6066

"key": "A String", # The key representing the shared targeting criterion.

6067

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6068

# Third parties may define their own keys.

6069

# A list of permissible keys along with the acceptable values will be

6070

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6071

},

6072

],

6073

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

6074

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6075

# in Ad Manager.

6076

# Preferred Deal in Ad Manager.

6077

# This doesn't apply to Private Auction and AdX Preferred Deals.

6078

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

6079

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

6080

"creativeSpecifications": [

6081

{ # Represents information for a creative that is associated with a Programmatic

6082

# Guaranteed/Preferred Deal in Ad Manager.

6083

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6084

"width": "A String", # The width of the ad slot in pixels.

6085

# This field will be present only when size type is `PIXEL`.

6086

"height": "A String", # The height of the ad slot in pixels.

6087

# This field will be present only when size type is `PIXEL`.

6088

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6089

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6090

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

6091

{ # Represents size of a single ad slot, or a creative.

6092

"width": "A String", # The width of the ad slot in pixels.

6093

# This field will be present only when size type is `PIXEL`.

6094

"height": "A String", # The height of the ad slot in pixels.

6095

# This field will be present only when size type is `PIXEL`.

6096

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6103

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

6104

# The deal is considered paused if either hasBuyerPaused or

6105

# hasSellPaused is true.

6106

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6107

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

6108

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6109

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6110

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6111

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6112

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6113

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6114

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6115

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6116

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6117

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6118

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6119

# of guaranteed looks that the buyer is guaranteeing to buy.

6120

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6121

"fixedPrices": [ # Fixed price for the specified buyer.

6122

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6123

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6124

# a particular buyer or buyer/advertiser pair, we look for the most specific

6125

# matching rule - we first look for a rule matching the buyer and advertiser,

6126

# next a rule with the buyer but an empty advertiser list, and otherwise look

6127

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6128

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6129

# If empty, all advertisers with this buyer pay this price.

6130

"A String",

6131

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6132

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6133

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6134

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6135

"units": "A String", # The whole units of the amount.

6136

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6137

"nanos": 42, # Number of nano (10^-9) units of the amount.

6138

# The value must be between -999,999,999 and +999,999,999 inclusive.

6139

# If `units` is positive, `nanos` must be positive or zero.

6140

# If `units` is zero, `nanos` can be positive, zero, or negative.

6141

# If `units` is negative, `nanos` must be negative or zero.

6142

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6143

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6144

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6145

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6146

"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

6147

# (if the

6148

# advertisers match, and there's no more specific rule matching the buyer).

6149

# Authorized Buyers account ID.

6150

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6155

"description": "A String", # Publisher provided description for the terms.

6156

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6157

# time zone used to mark the boundaries of a day. It should be an

6158

# IANA TZ name, such as "America/Los_Angeles". For more information,

6159

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6160

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6161

# Can be set by buyer or seller.

6162

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6163

# by the seller, but they can be returned in a get or list request.

6164

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6165

# in this private auction.

6166

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6167

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6168

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6169

# a particular buyer or buyer/advertiser pair, we look for the most specific

6170

# matching rule - we first look for a rule matching the buyer and advertiser,

6171

# next a rule with the buyer but an empty advertiser list, and otherwise look

6172

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6173

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6174

# If empty, all advertisers with this buyer pay this price.

6175

"A String",

6176

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6177

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6178

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6179

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6180

"units": "A String", # The whole units of the amount.

6181

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6182

"nanos": 42, # Number of nano (10^-9) units of the amount.

6183

# The value must be between -999,999,999 and +999,999,999 inclusive.

6184

# If `units` is positive, `nanos` must be positive or zero.

6185

# If `units` is zero, `nanos` can be positive, zero, or negative.

6186

# If `units` is negative, `nanos` must be negative or zero.

6187

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6188

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6190

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6191

"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

6192

# (if the

6193

# advertisers match, and there's no more specific rule matching the buyer).

6194

# Authorized Buyers account ID.

6195

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6201

# the API at this time, but can be returned in a get or list request.

6202

"fixedPrices": [ # Fixed price for the specified buyer.

6203

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6204

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6205

# a particular buyer or buyer/advertiser pair, we look for the most specific

6206

# matching rule - we first look for a rule matching the buyer and advertiser,

6207

# next a rule with the buyer but an empty advertiser list, and otherwise look

6208

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6209

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6210

# If empty, all advertisers with this buyer pay this price.

6211

"A String",

6212

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6213

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6214

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6215

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6216

"units": "A String", # The whole units of the amount.

6217

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6218

"nanos": 42, # Number of nano (10^-9) units of the amount.

6219

# The value must be between -999,999,999 and +999,999,999 inclusive.

6220

# If `units` is positive, `nanos` must be positive or zero.

6221

# If `units` is zero, `nanos` can be positive, zero, or negative.

6222

# If `units` is negative, `nanos` must be negative or zero.

6223

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6224

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6225

},

6226

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6227

"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

6228

# (if the

6229

# advertisers match, and there's no more specific rule matching the buyer).

6230

# Authorized Buyers account ID.

6231

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

6237

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6238

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6239

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6240

"units": "A String", # The whole units of the amount.

6241

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6242

"nanos": 42, # Number of nano (10^-9) units of the amount.

6243

# The value must be between -999,999,999 and +999,999,999 inclusive.

6244

# If `units` is positive, `nanos` must be positive or zero.

6245

# If `units` is zero, `nanos` can be positive, zero, or negative.

6246

# If `units` is negative, `nanos` must be negative or zero.

6247

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6248

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6249

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6250

},

6251

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6252

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6253

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6254

# finalized. This is the deal ID that shows up in serving/reporting etc.

6255

"createProductId": "A String", # The product ID from which this deal was created.

6256

#

6257

# Note: This field may be set only when creating the resource. Modifying

6258

# this field while updating the resource will result in an error.

6259

"updateTime": "A String", # Output only. The time when the deal was last updated.

6260

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6261

"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]

6262

# target ad inventory. For example, they can choose to target ad requests only

6263

# if the user is in the US.

6264

# Multiple types of targeting are always applied as a logical AND, unless noted

6265

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6266

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

6267

# mobile applications.

6268

# Different placement targeting types will be logically OR'ed.

6269

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6270

# For Private Auction and AdX Preferred Deals, URLs are either included or

6271

# excluded.

6272

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6273

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6274

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6275

"A String",

6276

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6277

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6282

# This doesn't apply to Auction Packages.

6283

"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]

6284

# display the ads in.

6285

# publishers own.

6286

# Mobile application IDs are from App Store and Google Play Store.

6287

# Android App ID, for example, com.google.android.apps.maps, can be found in

6288

# Google Play Store URL.

6289

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6290

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6291

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6292

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6293

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6294

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6295

"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]

6300

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

6301

# request. It only applies to Private Auction, AdX Preferred Deals and

6302

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6303

# and Preferred Deals in Ad Manager.

6304

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6305

{ # Represents size of a single ad slot, or a creative.

6306

"width": "A String", # The width of the ad slot in pixels.

6307

# This field will be present only when size type is `PIXEL`.

6308

"height": "A String", # The height of the ad slot in pixels.

6309

# This field will be present only when size type is `PIXEL`.

6310

"sizeType": "A String", # The size type of the ad slot.

6311

},

6312

],

6313

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6314

{ # Represents size of a single ad slot, or a creative.

6315

"width": "A String", # The width of the ad slot in pixels.

6316

# This field will be present only when size type is `PIXEL`.

6317

"height": "A String", # The height of the ad slot in pixels.

6318

# This field will be present only when size type is `PIXEL`.

6319

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6324

# included and excluded numeric IDs.

6325

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6326

"A String",

6327

],

6328

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

6333

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6334

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

6335

# included and excluded numeric IDs.

6336

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6337

"A String",

6338

],

6339

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6344

# included and excluded numeric IDs.

6345

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6346

"A String",

6347

],

6348

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6354

# included and excluded numeric IDs.

6355

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6356

"A String",

6357

],

6358

"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.

6363

# included and excluded numeric IDs.

6364

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6365

"A String",

6366

],

6367

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6373

"targetedPositionTypes": [ # A list of video positions to be included.

6374

# When the included list is present, the excluded list must be empty.

6375

# When the excluded list is present, the included list must be empty.

6376

"A String",

6377

],

6378

"excludedPositionTypes": [ # A list of video positions to be excluded.

6379

# Position types can either be included or excluded (XOR).

6380

"A String",

6381

],

6382

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6383

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6384

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

6385

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6386

# operations (max-length: 1024 unicode code units).

6387

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6388

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6389

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6390

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6391

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6392

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6393

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6394

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

6395

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6396

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

6397

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6398

},

6399

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6400

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6401

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6402

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6403

"availableEndTime": "A String", # Proposed flight end time of the deal.

6404

# This will generally be stored in a granularity of a second.

6405

# A value is not required for Private Auction deals or Preferred Deals.

6406

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

6407

# This will generally be stored in the granularity of one second since deal

6408

# serving starts at seconds boundary. Any time specified with more

6409

# granularity (e.g., in milliseconds) will be truncated towards the start of

6410

# time in seconds.

6411

"displayName": "A String", # The name of the deal.

6412

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

6413

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

6414

# If present on create, and the server `product_revision` has advanced sinced

6415

# the passed-in `create_product_revision`, an `ABORTED` error will be

6416

# returned.

6417

#

6418

# Note: This field may be set only when creating the resource. Modifying

6419

# this field while updating the resource will result in an error.

6420

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

6421

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

6422

"sellerContacts": [ # Output only. Seller contact information for the deal.

6423

{ # Contains information on how a buyer or seller can be reached.

6424

"name": "A String", # The name of the contact.

6425

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6426

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6427

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6428

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6429

"syndicationProduct": "A String", # The syndication product associated with the deal.

6430

#

6431

# Note: This field may be set only when creating the resource. Modifying

6432

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6433

},

6434

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6435

"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.

6436

# Authorized Buyers account ID.

6437

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6438

},

6439

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6440

"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]

6441

#

6442

# Note: This field may be set only when creating the resource. Modifying

6443

# this field while updating the resource will result in an error.

6444

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6445

"subAccountId": "A String", # Optional sub-account ID for the seller.

6446

"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]

6447

# The seller account ID is then available to buyer in the product.

6448

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6449

"updateTime": "A String", # Output only. The time when the proposal was last revised.

6450

"proposalId": "A String", # Output only. The unique ID of the proposal.

6451

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

6452

"proposalState": "A String", # Output only. The current state of the proposal.

6453

"notes": [ # Output only. The notes associated with this proposal.

6454

{ # A proposal may be associated to several notes.

6455

"noteId": "A String", # Output only. The unique ID for the note.

6456

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

6457

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

6458

"createTime": "A String", # Output only. The timestamp for when this note was created.

6459

"note": "A String", # The actual note to attach.

6460

# (max-length: 1024 unicode code units)

6461

#

6462

# Note: This field may be set only when creating the resource. Modifying

6463

# this field while updating the resource will result in an error.

6464

},

6465

],

6466

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

6472

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

6473

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

6474

# operations (max-length: 1024 unicode code units).

6475

},

6476

"buyerContacts": [ # Contact information for the buyer.

6477

{ # Contains information on how a buyer or seller can be reached.

6478

"name": "A String", # The name of the contact.

6479

"email": "A String", # Email address for the contact.

6480

},

6481

],

6482

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

6483

# proposal.

6484

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6485

# proposal.

6486

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

6487

#

6488

# Note: This field may be set only when creating the resource. Modifying

6489

# this field while updating the resource will result in an error.

6490

# Authorized Buyers account ID.

6491

"accountId": "A String", # Authorized Buyers account ID of the buyer.

6492

},

6493

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

6494

# left a comment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6495

}

6496

6497

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

6504

6505

{ # Note: this resource requires whitelisting for access. Please contact your

6506

# account manager for access to Marketplace resources.

6507

#

6508

# Represents a proposal in the Marketplace. A proposal is the unit of

6509

# negotiation between a seller and a buyer and contains deals which

6510

# are served.

6511

#

6512

# Note: you can not update, create, or otherwise modify Private

6513

# Auction or Preferred Deals deals through the API.

6514

#

6515

# Fields are updatable unless noted otherwise.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6516

"proposalRevision": "A String", # Output only. The revision number for the proposal.

6517

# Each update to the proposal or the deal causes the proposal revision number

6518

# to auto-increment. The buyer keeps track of the last revision number they

6519

# know of and pass it in when making an update. If the head revision number

6520

# on the server has since incremented, then an ABORTED error is returned

6521

# during the update operation to let the buyer know that a subsequent update

6522

# was made.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6523

"originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6524

"deals": [ # The deals associated with this proposal. For Private Auction proposals

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6525

# (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.

6526

{ # A deal represents a segment of inventory for displaying ads on.

6527

# A proposal can contain multiple deals. A deal contains the terms and

6528

# targeting information that is used for serving.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6529

"dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).

6530

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

6531

# deal.

6532

"createTime": "A String", # Output only. The time of the deal creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6533

"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.

6534

# PUBLISHER means creative is provided by seller and ADVERTISER means

6535

# creative is provided by buyer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6536

"targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared

6537

# targeting entity is AND'd together.

6538

{ # Advertisers can target different attributes of an ad slot. For example,

6539

# they can choose to show ads only if the user is in the U.S. Such

6540

# targeting criteria can be specified as part of Shared Targeting.

6541

"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd

6542

# together.

6543

{ # A polymorphic targeting value used as part of Shared Targeting.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6544

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6545

# Filled in when the key is GOOG_DAYPART_TARGETING.

6546

# The definition of this targeting is derived from the structure

6547

# used by Ad Manager.

6548

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6549

"dayParts": [ # A list of day part targeting criterion.

6550

{ # Daypart targeting message that specifies if the ad can be shown

6551

# only during certain parts of a day/week.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6552

"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

6553

# granularity). The end time is exclusive. This field is not available

6554

# for filtering in PQL queries.

6555

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6556

# types are google.type.Date and `google.protobuf.Timestamp`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6557

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6558

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6559

# to allow the value "24:00:00" for scenarios like business closing time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6560

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6561

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6562

# allow the value 60 if it allows leap-seconds.

6563

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6564

"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).

6565

# The start time is inclusive.

6566

# This field is not available for filtering in PQL queries.

6567

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6568

# types are google.type.Date and `google.protobuf.Timestamp`.

6569

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6570

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6571

# to allow the value "24:00:00" for scenarios like business closing time.

6572

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6573

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6574

# allow the value 60 if it allows leap-seconds.

6575

},

6576

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6577

},

6578

],

6579

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6580

"longValue": "A String", # The long value to include/exclude.

6581

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6582

# Filled in when key = GOOG_CREATIVE_SIZE

6583

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6584

# only if creative_size_type = CreativeSizeType.NATIVE.

6585

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6586

# of the creative

6587

# height depend on the type of the targeting.

6588

"width": 42, # The width of the creative

6589

"height": 42, # The height of the creative.

6590

},

6591

"creativeSizeType": "A String", # The creative size type.

6592

"allowedFormats": [ # What formats are allowed by the publisher.

6593

# If this repeated field is empty then all formats are allowed.

6594

# For example, if this field contains AllowedFormatType.AUDIO then the

6595

# publisher only allows an audio ad (without any video).

6596

"A String",

6597

],

6598

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6599

# creative_size_type = CreativeSizeType.VIDEO.

6600

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6601

# Companion sizes may be filled in only when creative_size_type = VIDEO

6602

{ # Message depicting the size of the creative. The units of width and

6603

# height depend on the type of the targeting.

6604

"width": 42, # The width of the creative

6605

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

6610

},

6611

],

6612

"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd

6613

# together.

6614

{ # A polymorphic targeting value used as part of Shared Targeting.

6615

"dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.

6616

# Filled in when the key is GOOG_DAYPART_TARGETING.

6617

# The definition of this targeting is derived from the structure

6618

# used by Ad Manager.

6619

"timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.

6620

"dayParts": [ # A list of day part targeting criterion.

6621

{ # Daypart targeting message that specifies if the ad can be shown

6622

# only during certain parts of a day/week.

6623

"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

6624

# granularity). The end time is exclusive. This field is not available

6625

# for filtering in PQL queries.

6626

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6627

# types are google.type.Date and `google.protobuf.Timestamp`.

6628

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6629

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6630

# to allow the value "24:00:00" for scenarios like business closing time.

6631

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6632

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6633

# allow the value 60 if it allows leap-seconds.

6634

},

6635

"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).

6636

# The start time is inclusive.

6637

# This field is not available for filtering in PQL queries.

6638

# or are specified elsewhere. An API may choose to allow leap seconds. Related

6639

# types are google.type.Date and `google.protobuf.Timestamp`.

6640

"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

6641

"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose

6642

# to allow the value "24:00:00" for scenarios like business closing time.

6643

"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.

6644

"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may

6645

# allow the value 60 if it allows leap-seconds.

6646

},

6647

"dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.

},

],

},

"longValue": "A String", # The long value to include/exclude.

6652

"creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.

6653

# Filled in when key = GOOG_CREATIVE_SIZE

6654

"nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value

6655

# only if creative_size_type = CreativeSizeType.NATIVE.

6656

"size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size

6657

# of the creative

6658

# height depend on the type of the targeting.

6659

"width": 42, # The width of the creative

6660

"height": 42, # The height of the creative.

6661

},

6662

"creativeSizeType": "A String", # The creative size type.

6663

"allowedFormats": [ # What formats are allowed by the publisher.

6664

# If this repeated field is empty then all formats are allowed.

6665

# For example, if this field contains AllowedFormatType.AUDIO then the

6666

# publisher only allows an audio ad (without any video).

6667

"A String",

6668

],

6669

"skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if

6670

# creative_size_type = CreativeSizeType.VIDEO.

6671

"companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).

6672

# Companion sizes may be filled in only when creative_size_type = VIDEO

6673

{ # Message depicting the size of the creative. The units of width and

6674

# height depend on the type of the targeting.

6675

"width": 42, # The width of the creative

6676

"height": 42, # The height of the creative.

},

],

},

"stringValue": "A String", # The string value to include/exclude.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6681

},

6682

],

6683

"key": "A String", # The key representing the shared targeting criterion.

6684

# Targeting criteria defined by Google ad servers will begin with GOOG_.

6685

# Third parties may define their own keys.

6686

# A list of permissible keys along with the acceptable values will be

6687

# provided as part of the external documentation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6688

},

6689

],

6690

"creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal

6691

# (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals

6692

# in Ad Manager.

6693

# Preferred Deal in Ad Manager.

6694

# This doesn't apply to Private Auction and AdX Preferred Deals.

6695

"skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.

6696

"creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.

6697

"creativeSpecifications": [

6698

{ # Represents information for a creative that is associated with a Programmatic

6699

# Guaranteed/Preferred Deal in Ad Manager.

6700

"creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.

6701

"width": "A String", # The width of the ad slot in pixels.

6702

# This field will be present only when size type is `PIXEL`.

6703

"height": "A String", # The height of the ad slot in pixels.

6704

# This field will be present only when size type is `PIXEL`.

6705

"sizeType": "A String", # The size type of the ad slot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6706

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6707

"creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.

6708

{ # Represents size of a single ad slot, or a creative.

6709

"width": "A String", # The width of the ad slot in pixels.

6710

# This field will be present only when size type is `PIXEL`.

6711

"height": "A String", # The height of the ad slot in pixels.

6712

# This field will be present only when size type is `PIXEL`.

6713

"sizeType": "A String", # The size type of the ad slot.

},

],

},

],

},

"dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.

6720

"dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.

6721

# The deal is considered paused if either hasBuyerPaused or

6722

# hasSellPaused is true.

6723

"firstPausedBy": "A String", # The role of the person who first paused this deal.

6724

"hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.

6725

"buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.

6726

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.

6727

"hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6728

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6729

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6730

"dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.

6731

# like price per buyer, the type of pricing model (e.g., fixed price, auction)

6732

# and expected impressions from the publisher.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6733

"guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.

6734

"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.

6735

"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage

6736

# of guaranteed looks that the buyer is guaranteeing to buy.

6737

"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6738

"fixedPrices": [ # Fixed price for the specified buyer.

6739

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6740

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6741

# a particular buyer or buyer/advertiser pair, we look for the most specific

6742

# matching rule - we first look for a rule matching the buyer and advertiser,

6743

# next a rule with the buyer but an empty advertiser list, and otherwise look

6744

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6745

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6746

# If empty, all advertisers with this buyer pay this price.

6747

"A String",

6748

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6749

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6750

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6751

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6752

"units": "A String", # The whole units of the amount.

6753

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6754

"nanos": 42, # Number of nano (10^-9) units of the amount.

6755

# The value must be between -999,999,999 and +999,999,999 inclusive.

6756

# If `units` is positive, `nanos` must be positive or zero.

6757

# If `units` is zero, `nanos` can be positive, zero, or negative.

6758

# If `units` is negative, `nanos` must be negative or zero.

6759

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6760

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6761

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6762

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6763

"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

6764

# (if the

6765

# advertisers match, and there's no more specific rule matching the buyer).

6766

# Authorized Buyers account ID.

6767

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6772

"description": "A String", # Publisher provided description for the terms.

6773

"sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the

6774

# time zone used to mark the boundaries of a day. It should be an

6775

# IANA TZ name, such as "America/Los_Angeles". For more information,

6776

# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6777

"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.

6778

# Can be set by buyer or seller.

6779

"nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.

6780

# by the seller, but they can be returned in a get or list request.

6781

"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers

6782

# in this private auction.

6783

"reservePricesPerBuyer": [ # Reserve price for the specified buyer.

6784

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6785

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6786

# a particular buyer or buyer/advertiser pair, we look for the most specific

6787

# matching rule - we first look for a rule matching the buyer and advertiser,

6788

# next a rule with the buyer but an empty advertiser list, and otherwise look

6789

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6790

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6791

# If empty, all advertisers with this buyer pay this price.

6792

"A String",

6793

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6794

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6795

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6796

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6797

"units": "A String", # The whole units of the amount.

6798

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6799

"nanos": 42, # Number of nano (10^-9) units of the amount.

6800

# The value must be between -999,999,999 and +999,999,999 inclusive.

6801

# If `units` is positive, `nanos` must be positive or zero.

6802

# If `units` is zero, `nanos` can be positive, zero, or negative.

6803

# If `units` is negative, `nanos` must be negative or zero.

6804

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6805

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6806

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6807

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6808

"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

6809

# (if the

6810

# advertisers match, and there's no more specific rule matching the buyer).

6811

# Authorized Buyers account ID.

6812

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.

6818

# the API at this time, but can be returned in a get or list request.

6819

"fixedPrices": [ # Fixed price for the specified buyer.

6820

{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in

6821

# a product can become 0 or 1 deals. To check if there is a PricePerBuyer for

6822

# a particular buyer or buyer/advertiser pair, we look for the most specific

6823

# matching rule - we first look for a rule matching the buyer and advertiser,

6824

# next a rule with the buyer but an empty advertiser list, and otherwise look

6825

# for a matching rule where no buyer is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6826

"advertiserIds": [ # The list of advertisers for this price when associated with this buyer.

6827

# If empty, all advertisers with this buyer pay this price.

6828

"A String",

6829

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6830

"price": { # Represents a price and a pricing type for a product / deal. # The specified price.

6831

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

6832

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

6833

"units": "A String", # The whole units of the amount.

6834

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

6835

"nanos": 42, # Number of nano (10^-9) units of the amount.

6836

# The value must be between -999,999,999 and +999,999,999 inclusive.

6837

# If `units` is positive, `nanos` must be positive or zero.

6838

# If `units` is zero, `nanos` can be positive, zero, or negative.

6839

# If `units` is negative, `nanos` must be negative or zero.

6840

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

6841

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

6842

},

6843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6844

"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

6845

# (if the

6846

# advertisers match, and there's no more specific rule matching the buyer).

6847

# Authorized Buyers account ID.

6848

"accountId": "A String", # Authorized Buyers account ID of the buyer.

},

},

],

},

"estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.

6854

# Can be set by buyer or seller.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6855

"pricingType": "A String", # The pricing type for the deal/product. (default: CPM)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6856

"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6857

"units": "A String", # The whole units of the amount.

6858

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6859

"nanos": 42, # Number of nano (10^-9) units of the amount.

6860

# The value must be between -999,999,999 and +999,999,999 inclusive.

6861

# If `units` is positive, `nanos` must be positive or zero.

6862

# If `units` is zero, `nanos` can be positive, zero, or negative.

6863

# If `units` is negative, `nanos` must be negative or zero.

6864

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6865

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6866

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6867

},

6868

"brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6869

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6870

"externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is

6871

# finalized. This is the deal ID that shows up in serving/reporting etc.

6872

"createProductId": "A String", # The product ID from which this deal was created.

6873

#

6874

# Note: This field may be set only when creating the resource. Modifying

6875

# this field while updating the resource will result in an error.

6876

"updateTime": "A String", # Output only. The time when the deal was last updated.

6877

"proposalId": "A String", # Output only. ID of the proposal that this deal is part of.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6878

"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]

6879

# target ad inventory. For example, they can choose to target ad requests only

6880

# if the user is in the US.

6881

# Multiple types of targeting are always applied as a logical AND, unless noted

6882

# otherwise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6883

"placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.

6884

# mobile applications.

6885

# Different placement targeting types will be logically OR'ed.

6886

"urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.

6887

# For Private Auction and AdX Preferred Deals, URLs are either included or

6888

# excluded.

6889

# For Programmatic Guaranteed and Preferred Deals, this doesn't

6890

# apply.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6891

"excludedUrls": [ # A list of URLs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6892

"A String",

6893

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6894

"targetedUrls": [ # A list of URLs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.

6899

# This doesn't apply to Auction Packages.

6900

"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]

6901

# display the ads in.

6902

# publishers own.

6903

# Mobile application IDs are from App Store and Google Play Store.

6904

# Android App ID, for example, com.google.android.apps.maps, can be found in

6905

# Google Play Store URL.

6906

# iOS App ID (which is a number) can be found at the end of iTunes store URL.

6907

# First party mobile applications is either included or excluded.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6908

"excludedAppIds": [ # A list of application IDs to be excluded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6909

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6910

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

6911

"targetedAppIds": [ # A list of application IDs to be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6912

"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]

6917

"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.

6918

# request. It only applies to Private Auction, AdX Preferred Deals and

6919

# Auction Packages. This targeting does not apply to Programmatic Guaranteed

6920

# and Preferred Deals in Ad Manager.

6921

"targetedInventorySizes": [ # A list of inventory sizes to be included.

6922

{ # Represents size of a single ad slot, or a creative.

6923

"width": "A String", # The width of the ad slot in pixels.

6924

# This field will be present only when size type is `PIXEL`.

6925

"height": "A String", # The height of the ad slot in pixels.

6926

# This field will be present only when size type is `PIXEL`.

6927

"sizeType": "A String", # The size type of the ad slot.

6928

},

6929

],

6930

"excludedInventorySizes": [ # A list of inventory sizes to be excluded.

6931

{ # Represents size of a single ad slot, or a creative.

6932

"width": "A String", # The width of the ad slot in pixels.

6933

# This field will be present only when size type is `PIXEL`.

6934

"height": "A String", # The height of the ad slot in pixels.

6935

# This field will be present only when size type is `PIXEL`.

6936

"sizeType": "A String", # The size type of the ad slot.

},

],

},

"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.

6941

# included and excluded numeric IDs.

6942

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6943

"A String",

6944

],

6945

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.

6950

"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.

6951

"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.

6952

# included and excluded numeric IDs.

6953

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6954

"A String",

6955

],

6956

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.

6961

# included and excluded numeric IDs.

6962

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6963

"A String",

6964

],

6965

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.

6971

# included and excluded numeric IDs.

6972

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6973

"A String",

6974

],

6975

"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.

6980

# included and excluded numeric IDs.

6981

"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.

6982

"A String",

6983

],

6984

"targetedCriteriaIds": [ # A list of numeric IDs to be included.

"A String",

],

},

},

"videoTargeting": { # Represents targeting information about video. # Video targeting information.

6990

"targetedPositionTypes": [ # A list of video positions to be included.

6991

# When the included list is present, the excluded list must be empty.

6992

# When the excluded list is present, the included list must be empty.

6993

"A String",

6994

],

6995

"excludedPositionTypes": [ # A list of video positions to be excluded.

6996

# Position types can either be included or excluded (XOR).

6997

"A String",

6998

],

6999

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7000

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7001

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).

7002

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

7003

# operations (max-length: 1024 unicode code units).

7004

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7005

"deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7006

# to see but are non-negotiable. These are set by the publisher.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7007

"frequencyCaps": [ # Output only. Specifies any frequency caps.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7008

{ # Frequency cap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7009

"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7010

# specified time period.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7011

"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over

7012

# which impressions per user are counted and capped.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7013

"numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the

7014

# amount of time over which impressions per user are counted and capped.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7015

},

7016

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7017

"creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7018

"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7019

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7020

"availableEndTime": "A String", # Proposed flight end time of the deal.

7021

# This will generally be stored in a granularity of a second.

7022

# A value is not required for Private Auction deals or Preferred Deals.

7023

"availableStartTime": "A String", # Optional proposed flight start time of the deal.

7024

# This will generally be stored in the granularity of one second since deal

7025

# serving starts at seconds boundary. Any time specified with more

7026

# granularity (e.g., in milliseconds) will be truncated towards the start of

7027

# time in seconds.

7028

"displayName": "A String", # The name of the deal.

7029

"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.

7030

"createProductRevision": "A String", # Optional revision number of the product that the deal was created from.

7031

# If present on create, and the server `product_revision` has advanced sinced

7032

# the passed-in `create_product_revision`, an `ABORTED` error will be

7033

# returned.

7034

#

7035

# Note: This field may be set only when creating the resource. Modifying

7036

# this field while updating the resource will result in an error.

7037

"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.

7038

"webPropertyCode": "A String", # The web property code for the seller copied over from the product.

7039

"sellerContacts": [ # Output only. Seller contact information for the deal.

7040

{ # Contains information on how a buyer or seller can be reached.

7041

"name": "A String", # The name of the contact.

7042

"email": "A String", # Email address for the contact.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7043

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7044

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7045

"description": "A String", # Description for the deal terms.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7046

"syndicationProduct": "A String", # The syndication product associated with the deal.

7047

#

7048

# Note: This field may be set only when creating the resource. Modifying

7049

# this field while updating the resource will result in an error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7050

},

7051

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7052

"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.

7053

# Authorized Buyers account ID.

7054

"accountId": "A String", # Authorized Buyers account ID of the buyer.

7055

},

7056

"displayName": "A String", # The name for the proposal.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7057

"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]

7058

#

7059

# Note: This field may be set only when creating the resource. Modifying

7060

# this field while updating the resource will result in an error.

7061

# Ad Manager account ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7062

"subAccountId": "A String", # Optional sub-account ID for the seller.

7063

"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]

7064

# The seller account ID is then available to buyer in the product.

7065

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

7066

"updateTime": "A String", # Output only. The time when the proposal was last revised.

7067

"proposalId": "A String", # Output only. The unique ID of the proposal.

7068

"isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.

7069

"proposalState": "A String", # Output only. The current state of the proposal.

7070

"notes": [ # Output only. The notes associated with this proposal.

7071

{ # A proposal may be associated to several notes.

7072

"noteId": "A String", # Output only. The unique ID for the note.

7073

"creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.

7074

"proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.

7075

"createTime": "A String", # Output only. The timestamp for when this note was created.

7076

"note": "A String", # The actual note to attach.

7077

# (max-length: 1024 unicode code units)

7078

#

7079

# Note: This field may be set only when creating the resource. Modifying

7080

# this field while updating the resource will result in an error.

7081

},

7082

],

7083

"sellerContacts": [ # Output only. Contact information for the seller.

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

],

7089

"buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).

7090

"referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list

7091

# operations (max-length: 1024 unicode code units).

7092

},

7093

"buyerContacts": [ # Contact information for the buyer.

7094

{ # Contains information on how a buyer or seller can be reached.

7095

"name": "A String", # The name of the contact.

7096

"email": "A String", # Email address for the contact.

7097

},

7098

],

7099

"privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction

7100

# proposal.

7101

"isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this

7102

# proposal.

7103

"buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.

7104

#

7105

# Note: This field may be set only when creating the resource. Modifying

7106

# this field while updating the resource will result in an error.

7107

# Authorized Buyers account ID.

7108

"accountId": "A String", # Authorized Buyers account ID of the buyer.

7109

},

7110

"lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or

7111

# left a comment.

Bu Sun Kim