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



3120
3121
3122
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3120

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:



2996
2997
2998
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2996

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:



3001
3002
3003
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3001

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:



3006
3007
3008
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3006

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:



3011
3012
3013
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3011

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


3016
3017
3018
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3016

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) 


3023
3024
3025
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3023

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) 


3031
3032
3033
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3031

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) 


3037
3038
3039
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3037

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) 


3042
3043
3044
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3042

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) 


3050
3051
3052
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3050

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) 


3057
3058
3059
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3057

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:



3062
3063
3064
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3062

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) 


3068
3069
3070
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3068

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) 


3073
3074
3075
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3073

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) 


3078
3079
3080
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3078

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) 


3083
3084
3085
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3083

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) 


3088
3089
3090
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3088

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) 


3093
3094
3095
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3093

def proposal_id
  @proposal_id
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


3098
3099
3100
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3098

def proposal_state
  @proposal_state
end

#revision_number ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


3108
3109
3110
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3108

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:



3113
3114
3115
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3113

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:



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

def seller_contacts
  @seller_contacts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3125

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