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.



2952
2953
2954
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2952

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:



2834
2835
2836
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2834

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:



2839
2840
2841
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2839

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:



2844
2845
2846
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2844

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:



2849
2850
2851
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2849

def buyer_private_data
  @buyer_private_data
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) 


2856
2857
2858
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2856

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) 


2864
2865
2866
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2864

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) 


2870
2871
2872
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2870

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) 


2875
2876
2877
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2875

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) 


2882
2883
2884
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2882

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) 


2889
2890
2891
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2889

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:



2894
2895
2896
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2894

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) 


2900
2901
2902
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2900

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) 


2905
2906
2907
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2905

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) 


2910
2911
2912
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2910

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) 


2915
2916
2917
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2915

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) 


2920
2921
2922
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2920

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) 


2925
2926
2927
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2925

def proposal_id
  @proposal_id
end

#proposal_state ⇒ String

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

Returns:

  • (String) 


2930
2931
2932
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2930

def proposal_state
  @proposal_state
end

#revision_number ⇒ String

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

Returns:

  • (String) 


2935
2936
2937
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2935

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) 


2940
2941
2942
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2940

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:



2945
2946
2947
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2945

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:



2950
2951
2952
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2950

def seller_contacts
  @seller_contacts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2957

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