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.


3507
3508
3509
# File 'generated/google/apis/content_v2/classes.rb', line 3507

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

Instance Attribute Details

#discountGoogle::Apis::ContentV2::Price

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


3482
3483
3484
# File 'generated/google/apis/content_v2/classes.rb', line 3482

def discount
  @discount
end

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

3488
3489
3490
# File 'generated/google/apis/content_v2/classes.rb', line 3488

def offer_ids
  @offer_ids
end

#sub_typeString

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)

3494
3495
3496
# File 'generated/google/apis/content_v2/classes.rb', line 3494

def sub_type
  @sub_type
end

#tax_impactGoogle::Apis::ContentV2::Price

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


3499
3500
3501
# File 'generated/google/apis/content_v2/classes.rb', line 3499

def tax_impact
  @tax_impact
end

#typeString

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)

3505
3506
3507
# File 'generated/google/apis/content_v2/classes.rb', line 3505

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3512
3513
3514
3515
3516
3517
3518
# File 'generated/google/apis/content_v2/classes.rb', line 3512

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