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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderPromotion

Returns a new instance of OrderPromotion.



5837
5838
5839
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5837

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

Instance Attribute Details

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

Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item. Corresponds to the JSON property applicableItems

Returns:



5765
5766
5767
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5765

def applicable_items
  @applicable_items
end

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

Items that this promotion have been applied to. Do not provide for orders. createtestorder. This field will be empty for shipping promotions because shipping is not tied to any specific item. Corresponds to the JSON property appliedItems

Returns:



5772
5773
5774
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5772

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) 


5778
5779
5780
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5778

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) 


5784
5785
5786
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5784

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) 


5790
5791
5792
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5790

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:



5796
5797
5798
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5796

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) 


5802
5803
5804
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5802

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) 


5808
5809
5810
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5808

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) 


5818
5819
5820
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5818

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:



5824
5825
5826
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5824

def tax_value
  @tax_value
end

#title ⇒ String

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

Returns:

  • (String) 


5829
5830
5831
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5829

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) 


5835
5836
5837
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5835

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5842

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