Class: Google::Apis::ContentV2::OrderPromotionBenefit

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/google/apis/content_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrderPromotionBenefit

Returns a new instance of OrderPromotionBenefit



2981
2982
2983
 
# File 'generated/google/apis/content_v2/classes.rb', line 2981

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

Instance Attribute Details

#discount ⇒ Google::Apis::ContentV2::Price

The discount in the order price when the promotion is applied. Corresponds to the JSON property discount

Returns:



2956
2957
2958
 
# File 'generated/google/apis/content_v2/classes.rb', line 2956

def discount
  @discount
end

#offer_ids ⇒ Array<String>

The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. Corresponds to the JSON property offerIds

Returns:

  • (Array<String>) 


2962
2963
2964
 
# File 'generated/google/apis/content_v2/classes.rb', line 2962

def offer_ids
  @offer_ids
end

#sub_type ⇒ String

Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Corresponds to the JSON property subType

Returns:

  • (String) 


2968
2969
2970
 
# File 'generated/google/apis/content_v2/classes.rb', line 2968

def sub_type
  @sub_type
end

#tax_impact ⇒ Google::Apis::ContentV2::Price

The impact on tax when the promotion is applied. Corresponds to the JSON property taxImpact

Returns:



2973
2974
2975
 
# File 'generated/google/apis/content_v2/classes.rb', line 2973

def tax_impact
  @tax_impact
end

#type ⇒ String

Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2986
2987
2988
2989
2990
2991
2992
 
# File 'generated/google/apis/content_v2/classes.rb', line 2986

def update!(**args)
  @discount = args[:discount] if args.key?(:discount)
  @offer_ids = args[:offer_ids] if args.key?(:offer_ids)
  @sub_type = args[:sub_type] if args.key?(:sub_type)
  @tax_impact = args[:tax_impact] if args.key?(:tax_impact)
  @type = args[:type] if args.key?(:type)
end