Class: Google::Apis::AdexchangebuyerV1_4::Proposal

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer_v1_4/classes.rb,
generated/google/apis/adexchangebuyer_v1_4/representations.rb,
generated/google/apis/adexchangebuyer_v1_4/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. Each field in a proposal can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.

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.



3200
3201
3202
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3200

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

Instance Attribute Details

#billed_buyer ⇒ Google::Apis::AdexchangebuyerV1_4::Buyer

Reference to the buyer that will get billed for this proposal. (readonly) Corresponds to the JSON property billedBuyer

Returns:



3076
3077
3078
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3076

def billed_buyer
  @billed_buyer
end

#buyer ⇒ Google::Apis::AdexchangebuyerV1_4::Buyer

Reference to the buyer on the proposal. (readonly, except on create) Corresponds to the JSON property buyer

Returns:



3081
3082
3083
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3081

def buyer
  @buyer
end

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

Optional contact information of the buyer. (seller-readonly) Corresponds to the JSON property buyerContacts

Returns:



3086
3087
3088
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3086

def buyer_contacts
  @buyer_contacts
end

#buyer_private_data ⇒ Google::Apis::AdexchangebuyerV1_4::PrivateData

Private data for buyer. (hidden from seller). Corresponds to the JSON property buyerPrivateData

Returns:



3091
3092
3093
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3091

def buyer_private_data
  @buyer_private_data
end

#dbm_advertiser_ids ⇒ Array<String>

IDs of DBM advertisers permission to this proposal. Corresponds to the JSON property dbmAdvertiserIds

Returns:

  • (Array<String>) 


3096
3097
3098
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3096

def dbm_advertiser_ids
  @dbm_advertiser_ids
end

#has_buyer_signed_off ⇒ Boolean Also known as: has_buyer_signed_off?

When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) Corresponds to the JSON property hasBuyerSignedOff

Returns:

  • (Boolean) 


3103
3104
3105
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3103

def has_buyer_signed_off
  @has_buyer_signed_off
end

#has_seller_signed_off ⇒ Boolean Also known as: has_seller_signed_off?

When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) Corresponds to the JSON property hasSellerSignedOff

Returns:

  • (Boolean) 


3111
3112
3113
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3111

def has_seller_signed_off
  @has_seller_signed_off
end

#inventory_source ⇒ String

What exchange will provide this inventory (readonly, except on create). Corresponds to the JSON property inventorySource

Returns:

  • (String) 


3117
3118
3119
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3117

def inventory_source
  @inventory_source
end

#is_renegotiating ⇒ Boolean Also known as: is_renegotiating?

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

Returns:

  • (Boolean) 


3122
3123
3124
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3122

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. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag. Corresponds to the JSON property isSetupComplete

Returns:

  • (Boolean) 


3130
3131
3132
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3130

def is_setup_complete
  @is_setup_complete
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " adexchangebuyer#proposal". Corresponds to the JSON property kind

Returns:

  • (String) 


3137
3138
3139
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3137

def kind
  @kind
end

#labels ⇒ Array<Google::Apis::AdexchangebuyerV1_4::MarketplaceLabel>

List of labels associated with the proposal. (readonly) Corresponds to the JSON property labels

Returns:



3142
3143
3144
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3142

def labels
  @labels
end

#last_updater_or_commentor_role ⇒ String

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

Returns:

  • (String) 


3148
3149
3150
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3148

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

#name ⇒ String

The name for the proposal (updatable) Corresponds to the JSON property name

Returns:

  • (String) 


3153
3154
3155
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3153

def name
  @name
end

#negotiation_id ⇒ String

Optional negotiation id if this proposal is a preferred deal proposal. Corresponds to the JSON property negotiationId

Returns:

  • (String) 


3158
3159
3160
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3158

def negotiation_id
  @negotiation_id
end

#originator_role ⇒ String

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

Returns:

  • (String) 


3163
3164
3165
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3163

def originator_role
  @originator_role
end

#private_auction_id ⇒ String

Optional private auction id if this proposal is a private auction proposal. Corresponds to the JSON property privateAuctionId

Returns:

  • (String) 


3168
3169
3170
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3168

def private_auction_id
  @private_auction_id
end

#proposal_id ⇒ String

The unique id of the proposal. (readonly). Corresponds to the JSON property proposalId

Returns:

  • (String) 


3173
3174
3175
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3173

def proposal_id
  @proposal_id
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


3178
3179
3180
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3178

def proposal_state
  @proposal_state
end

#revision_number ⇒ Fixnum

The revision number for the proposal (readonly). Corresponds to the JSON property revisionNumber

Returns:

  • (Fixnum) 


3183
3184
3185
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3183

def revision_number
  @revision_number
end

#revision_time_ms ⇒ Fixnum

The time (ms since epoch) when the proposal was last revised (readonly). Corresponds to the JSON property revisionTimeMs

Returns:

  • (Fixnum) 


3188
3189
3190
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3188

def revision_time_ms
  @revision_time_ms
end

#seller ⇒ Google::Apis::AdexchangebuyerV1_4::Seller

Reference to the seller on the proposal. (readonly, except on create) Corresponds to the JSON property seller

Returns:



3193
3194
3195
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3193

def seller
  @seller
end

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

Optional contact information of the seller (buyer-readonly). Corresponds to the JSON property sellerContacts

Returns:



3198
3199
3200
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3198

def seller_contacts
  @seller_contacts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3205

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)
  @dbm_advertiser_ids = args[:dbm_advertiser_ids] if args.key?(:dbm_advertiser_ids)
  @has_buyer_signed_off = args[:has_buyer_signed_off] if args.key?(:has_buyer_signed_off)
  @has_seller_signed_off = args[:has_seller_signed_off] if args.key?(:has_seller_signed_off)
  @inventory_source = args[:inventory_source] if args.key?(:inventory_source)
  @is_renegotiating = args[:is_renegotiating] if args.key?(:is_renegotiating)
  @is_setup_complete = args[:is_setup_complete] if args.key?(:is_setup_complete)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @last_updater_or_commentor_role = args[:last_updater_or_commentor_role] if args.key?(:last_updater_or_commentor_role)
  @name = args[:name] if args.key?(:name)
  @negotiation_id = args[:negotiation_id] if args.key?(:negotiation_id)
  @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_state = args[:proposal_state] if args.key?(:proposal_state)
  @revision_number = args[:revision_number] if args.key?(:revision_number)
  @revision_time_ms = args[:revision_time_ms] if args.key?(:revision_time_ms)
  @seller = args[:seller] if args.key?(:seller)
  @seller_contacts = args[:seller_contacts] if args.key?(:seller_contacts)
end