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



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

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:



2959
2960
2961
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2959

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:



2964
2965
2966
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2964

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:



2969
2970
2971
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2969

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:



2974
2975
2976
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2974

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


2979
2980
2981
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2979

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) 


2986
2987
2988
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2986

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) 


2994
2995
2996
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2994

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) 


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

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) 


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

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) Corresponds to the JSON property isSetupComplete

Returns:

  • (Boolean) 


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

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) 


3019
3020
3021
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3019

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:



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

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) 


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

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) 


3035
3036
3037
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3035

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) 


3040
3041
3042
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3040

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) 


3045
3046
3047
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3045

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) 


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

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) 


3055
3056
3057
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3055

def proposal_id
  @proposal_id
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


3060
3061
3062
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3060

def proposal_state
  @proposal_state
end

#revision_number ⇒ String

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

Returns:

  • (String) 


3065
3066
3067
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3065

def revision_number
  @revision_number
end

#revision_time_ms ⇒ String

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

Returns:

  • (String) 


3070
3071
3072
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3070

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:



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

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:



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

def seller_contacts
  @seller_contacts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3087

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