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



3445
3446
3447
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3445

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

Instance Attribute Details

#billed_buyer ⇒ Google::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

Returns:



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

def billed_buyer
  @billed_buyer
end

#buyer ⇒ Google::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

Returns:



3340
3341
3342
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3340

def buyer
  @buyer
end

#buyer_contacts ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

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

Returns:



3345
3346
3347
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3345

def buyer_contacts
  @buyer_contacts
end

#buyer_private_data ⇒ Google::Apis::Adexchangebuyer2V2beta1::PrivateData

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

Returns:



3350
3351
3352
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3350

def buyer_private_data
  @buyer_private_data
end

#deals ⇒ Array<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

Returns:



3357
3358
3359
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3357

def deals
  @deals
end

#display_name ⇒ String

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

Returns:

  • (String) 


3362
3363
3364
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3362

def display_name
  @display_name
end

#is_renegotiating ⇒ Boolean Also known as: is_renegotiating?

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

Returns:

  • (Boolean) 


3368
3369
3370
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3368

def is_renegotiating
  @is_renegotiating
end

#is_setup_complete ⇒ Boolean Also known as: is_setup_complete?

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

Returns:

  • (Boolean) 


3375
3376
3377
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3375

def is_setup_complete
  @is_setup_complete
end

#last_updater_or_commentor_role ⇒ String

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

Returns:

  • (String) 


3383
3384
3385
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3383

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

#notes ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::Note>

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

Returns:



3389
3390
3391
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3389

def notes
  @notes
end

#originator_role ⇒ String

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

Returns:

  • (String) 


3395
3396
3397
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3395

def originator_role
  @originator_role
end

#private_auction_id ⇒ String

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

Returns:

  • (String) 


3401
3402
3403
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3401

def private_auction_id
  @private_auction_id
end

#proposal_id ⇒ String

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

Returns:

  • (String) 


3407
3408
3409
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3407

def proposal_id
  @proposal_id
end

#proposal_revision ⇒ Fixnum

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) 


3419
3420
3421
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3419

def proposal_revision
  @proposal_revision
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


3425
3426
3427
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3425

def proposal_state
  @proposal_state
end

#seller ⇒ Google::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

Returns:



3431
3432
3433
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3431

def seller
  @seller
end

#seller_contacts ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

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

Returns:



3437
3438
3439
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3437

def seller_contacts
  @seller_contacts
end

#update_time ⇒ String

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

Returns:

  • (String) 


3443
3444
3445
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3443

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3450

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