Class: Google::Apis::ContentV2_1::OrderPromotion

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/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) ⇒ OrderPromotion

Returns a new instance of OrderPromotion



4203
4204
4205
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4203

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

Instance Attribute Details

#applicable_items ⇒ Array<Google::Apis::ContentV2_1::OrderPromotionItem>

Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. Corresponds to the JSON property applicableItems

Returns:



4155
4156
4157
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4155

def applicable_items
  @applicable_items
end

#applied_items ⇒ Array<Google::Apis::ContentV2_1::OrderPromotionItem>

Items which this promotion have been applied to. Corresponds to the JSON property appliedItems

Returns:



4160
4161
4162
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4160

def applied_items
  @applied_items
end

#funder ⇒ String

The party funding the promotion. Corresponds to the JSON property funder

Returns:

  • (String) 


4165
4166
4167
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4165

def funder
  @funder
end

#merchant_promotion_id ⇒ String

This field is used to identify promotions within merchants' own systems. Corresponds to the JSON property merchantPromotionId

Returns:

  • (String) 


4170
4171
4172
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4170

def merchant_promotion_id
  @merchant_promotion_id
end

#price_value ⇒ Google::Apis::ContentV2_1::Price

Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order. Corresponds to the JSON property priceValue

Returns:



4176
4177
4178
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4176

def price_value
  @price_value
end

#short_title ⇒ String

A short title of the promotion to be shown on the checkout page. Corresponds to the JSON property shortTitle

Returns:

  • (String) 


4181
4182
4183
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4181

def short_title
  @short_title
end

#subtype ⇒ String

The category of the promotion. Corresponds to the JSON property subtype

Returns:

  • (String) 


4186
4187
4188
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4186

def subtype
  @subtype
end

#tax_value ⇒ Google::Apis::ContentV2_1::Price

Estimated discount applied to tax (if allowed by law). Corresponds to the JSON property taxValue

Returns:



4191
4192
4193
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4191

def tax_value
  @tax_value
end

#title ⇒ String

The title of the promotion. Corresponds to the JSON property title

Returns:

  • (String) 


4196
4197
4198
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4196

def title
  @title
end

#type ⇒ String

The scope of the promotion. Corresponds to the JSON property type

Returns:

  • (String) 


4201
4202
4203
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4201

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4208

def update!(**args)
  @applicable_items = args[:applicable_items] if args.key?(:applicable_items)
  @applied_items = args[:applied_items] if args.key?(:applied_items)
  @funder = args[:funder] if args.key?(:funder)
  @merchant_promotion_id = args[:merchant_promotion_id] if args.key?(:merchant_promotion_id)
  @price_value = args[:price_value] if args.key?(:price_value)
  @short_title = args[:short_title] if args.key?(:short_title)
  @subtype = args[:subtype] if args.key?(:subtype)
  @tax_value = args[:tax_value] if args.key?(:tax_value)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end