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.



5079
5080
5081
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5079

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:



4991
4992
4993
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4991

def applicable_items
  @applicable_items
end

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

Items which this promotion have been applied to. Do not provide for orders. createtestorder. Corresponds to the JSON property appliedItems

Returns:



4997
4998
4999
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4997

def applied_items
  @applied_items
end

#end_time ⇒ String

Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., " 2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". Corresponds to the JSON property endTime

Returns:

  • (String) 


5003
5004
5005
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5003

def end_time
  @end_time
end

#funder ⇒ String

Required. The party funding the promotion. Only merchant is supported for orders.createtestorder. Acceptable values are:

  • "google"
  • "merchant" Corresponds to the JSON property funder

Returns:

  • (String) 


5012
5013
5014
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5012

def funder
  @funder
end

#merchant_promotion_id ⇒ String

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

Returns:

  • (String) 


5018
5019
5020
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5018

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:



5024
5025
5026
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5024

def price_value
  @price_value
end

#short_title ⇒ String

A short title of the promotion to be shown on the checkout page. Do not provide for orders.createtestorder. Corresponds to the JSON property shortTitle

Returns:

  • (String) 


5030
5031
5032
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5030

def short_title
  @short_title
end

#start_time ⇒ String

Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". Corresponds to the JSON property startTime

Returns:

  • (String) 


5036
5037
5038
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5036

def start_time
  @start_time
end

#subtype ⇒ String

Required. The category of the promotion. Only moneyOff is supported for orders.createtestorder. Acceptable values are:

  • "buyMGetMoneyOff"
  • "buyMGetNMoneyOff"
  • "buyMGetNPercentOff"
  • "buyMGetPercentOff"
  • "freeGift"
  • "freeGiftWithItemId"
  • "freeGiftWithValue"
  • "freeShippingOvernight"
  • "freeShippingStandard"
  • "freeShippingTwoDay"
  • "moneyOff"
  • "percentOff"
  • "rewardPoints"
  • "salePrice" Corresponds to the JSON property subtype

Returns:

  • (String) 


5057
5058
5059
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5057

def subtype
  @subtype
end

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

Estimated discount applied to tax (if allowed by law). Do not provide for orders.createtestorder. Corresponds to the JSON property taxValue

Returns:



5063
5064
5065
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5063

def tax_value
  @tax_value
end

#title ⇒ String

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

Returns:

  • (String) 


5068
5069
5070
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5068

def title
  @title
end

#type ⇒ String

Required. The scope of the promotion. Only product is supported for orders. createtestorder. Acceptable values are:

  • "product"
  • "shipping" Corresponds to the JSON property type

Returns:

  • (String) 


5077
5078
5079
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5077

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5084

def update!(**args)
  @applicable_items = args[:applicable_items] if args.key?(:applicable_items)
  @applied_items = args[:applied_items] if args.key?(:applied_items)
  @end_time = args[:end_time] if args.key?(:end_time)
  @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)
  @start_time = args[:start_time] if args.key?(:start_time)
  @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