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

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

Overview

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't update, create, or otherwise modify Private Auction deals through the API. Fields are updatable unless noted otherwise.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Proposal

Returns a new instance of Proposal.



3385
3386
3387
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3385

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:



3281
3282
3283
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3281

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:



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

def buyer
  @buyer
end

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

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

Returns:



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

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:



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

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:



3303
3304
3305
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3303

def deals
  @deals
end

#display_name ⇒ String

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

Returns:

  • (String) 


3308
3309
3310
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3308

def display_name
  @display_name
end

#is_renegotiating ⇒ Boolean Also known as: is_renegotiating?

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

Returns:

  • (Boolean) 


3313
3314
3315
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3313

def is_renegotiating
  @is_renegotiating
end

#is_setup_complete ⇒ Boolean 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) 


3320
3321
3322
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3320

def is_setup_complete
  @is_setup_complete
end

#last_updater_or_commentor_role ⇒ String

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) 


3327
3328
3329
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3327

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

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

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

Returns:



3332
3333
3334
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3332

def notes
  @notes
end

#originator_role ⇒ String

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

Returns:

  • (String) 


3337
3338
3339
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3337

def originator_role
  @originator_role
end

#private_auction_id ⇒ String

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

Returns:

  • (String) 


3342
3343
3344
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3342

def private_auction_id
  @private_auction_id
end

#proposal_id ⇒ String

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

Returns:

  • (String) 


3347
3348
3349
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3347

def proposal_id
  @proposal_id
end

#proposal_revision ⇒ Fixnum

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) 


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

def proposal_revision
  @proposal_revision
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


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

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:



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

def seller
  @seller
end

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

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

Returns:



3373
3374
3375
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3373

def seller_contacts
  @seller_contacts
end

#terms_and_conditions ⇒ String

Output only. The terms and conditions set by the publisher for this proposal. Corresponds to the JSON property termsAndConditions

Returns:

  • (String) 


3378
3379
3380
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3378

def terms_and_conditions
  @terms_and_conditions
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3390

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)
  @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions)
  @update_time = args[:update_time] if args.key?(:update_time)
end