Class: Google::Apis::Adexchangebuyer2V2beta1::Proposal

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer2_v2beta1/classes.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb

Overview

Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Proposal

Returns a new instance of Proposal.


3335
3336
3337
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3335

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#billed_buyerGoogle::Apis::Adexchangebuyer2V2beta1::Buyer

Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. Corresponds to the JSON property billedBuyer


3236
3237
3238
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3236

def billed_buyer
  @billed_buyer
end

#buyerGoogle::Apis::Adexchangebuyer2V2beta1::Buyer

Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. Corresponds to the JSON property buyer


3242
3243
3244
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3242

def buyer
  @buyer
end

#buyer_contactsArray<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

Contact information for the buyer. Corresponds to the JSON property buyerContacts


3247
3248
3249
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3247

def buyer_contacts
  @buyer_contacts
end

#buyer_private_dataGoogle::Apis::Adexchangebuyer2V2beta1::PrivateData

Buyers are allowed to store certain types of private data in a proposal/deal. Corresponds to the JSON property buyerPrivateData


3252
3253
3254
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3252

def buyer_private_data
  @buyer_private_data
end

#dealsArray<Google::Apis::Adexchangebuyer2V2beta1::Deal>

The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. Corresponds to the JSON property deals


3258
3259
3260
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3258

def deals
  @deals
end

#display_nameString

The name for the proposal. Corresponds to the JSON property displayName

Returns:

  • (String)

3263
3264
3265
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3263

def display_name
  @display_name
end

#is_renegotiatingBoolean Also known as: is_renegotiating?

Output only. True if the proposal is being renegotiated. Corresponds to the JSON property isRenegotiating

Returns:

  • (Boolean)

3268
3269
3270
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3268

def is_renegotiating
  @is_renegotiating
end

#is_setup_completeBoolean Also known as: is_setup_complete?

Output only. True, if the buyside inventory setup is complete for this proposal. Corresponds to the JSON property isSetupComplete

Returns:

  • (Boolean)

3275
3276
3277
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3275

def is_setup_complete
  @is_setup_complete
end

#last_updater_or_commentor_roleString

Output only. The role of the last user that either updated the proposal or left a comment. Corresponds to the JSON property lastUpdaterOrCommentorRole

Returns:

  • (String)

3282
3283
3284
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3282

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

#notesArray<Google::Apis::Adexchangebuyer2V2beta1::Note>

Output only. The notes associated with this proposal. Corresponds to the JSON property notes


3287
3288
3289
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3287

def notes
  @notes
end

#originator_roleString

Output only. Indicates whether the buyer/seller created the proposal. Corresponds to the JSON property originatorRole

Returns:

  • (String)

3292
3293
3294
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3292

def originator_role
  @originator_role
end

#private_auction_idString

Output only. Private auction ID if this proposal is a private auction proposal. Corresponds to the JSON property privateAuctionId

Returns:

  • (String)

3297
3298
3299
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3297

def private_auction_id
  @private_auction_id
end

#proposal_idString

Output only. The unique ID of the proposal. Corresponds to the JSON property proposalId

Returns:

  • (String)

3302
3303
3304
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3302

def proposal_id
  @proposal_id
end

#proposal_revisionFixnum

Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. Corresponds to the JSON property proposalRevision

Returns:

  • (Fixnum)

3312
3313
3314
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3312

def proposal_revision
  @proposal_revision
end

#proposal_stateString

Output only. The current state of the proposal. Corresponds to the JSON property proposalState

Returns:

  • (String)

3317
3318
3319
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3317

def proposal_state
  @proposal_state
end

#sellerGoogle::Apis::Adexchangebuyer2V2beta1::Seller

Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. Corresponds to the JSON property seller


3323
3324
3325
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3323

def seller
  @seller
end

#seller_contactsArray<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

Output only. Contact information for the seller. Corresponds to the JSON property sellerContacts


3328
3329
3330
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3328

def seller_contacts
  @seller_contacts
end

#update_timeString

Output only. The time when the proposal was last revised. Corresponds to the JSON property updateTime

Returns:

  • (String)

3333
3334
3335
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3333

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3340

def update!(**args)
  @billed_buyer = args[:billed_buyer] if args.key?(:billed_buyer)
  @buyer = args[:buyer] if args.key?(:buyer)
  @buyer_contacts = args[:buyer_contacts] if args.key?(:buyer_contacts)
  @buyer_private_data = args[:buyer_private_data] if args.key?(:buyer_private_data)
  @deals = args[:deals] if args.key?(:deals)
  @display_name = args[:display_name] if args.key?(:display_name)
  @is_renegotiating = args[:is_renegotiating] if args.key?(:is_renegotiating)
  @is_setup_complete = args[:is_setup_complete] if args.key?(:is_setup_complete)
  @last_updater_or_commentor_role = args[:last_updater_or_commentor_role] if args.key?(:last_updater_or_commentor_role)
  @notes = args[:notes] if args.key?(:notes)
  @originator_role = args[:originator_role] if args.key?(:originator_role)
  @private_auction_id = args[:private_auction_id] if args.key?(:private_auction_id)
  @proposal_id = args[:proposal_id] if args.key?(:proposal_id)
  @proposal_revision = args[:proposal_revision] if args.key?(:proposal_revision)
  @proposal_state = args[:proposal_state] if args.key?(:proposal_state)
  @seller = args[:seller] if args.key?(:seller)
  @seller_contacts = args[:seller_contacts] if args.key?(:seller_contacts)
  @update_time = args[:update_time] if args.key?(:update_time)
end