Class: Google::Apis::ContentV2_1::Promotion

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

Overview

Represents a promotion. (1) https://support.google.com/merchants/answer/ 2906014 (2) https://support.google.com/merchants/answer/10146130 (3) https:// support.google.com/merchants/answer/9173673

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Promotion

Returns a new instance of Promotion.



11775
11776
11777
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11775

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

Instance Attribute Details

#brand ⇒ Array<String>

Product filter by brand for the promotion. Corresponds to the JSON property brand

Returns:

  • (Array<String>) 


11604
11605
11606
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11604

def brand
  @brand
end

#brand_exclusion ⇒ Array<String>

Product filter by brand exclusion for the promotion. Corresponds to the JSON property brandExclusion

Returns:

  • (Array<String>) 


11609
11610
11611
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11609

def brand_exclusion
  @brand_exclusion
end

#content_language ⇒ String

Required. The content language used as part of the unique identifier. Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


11614
11615
11616
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11614

def content_language
  @content_language
end

#coupon_value_type ⇒ String

Required. Coupon value type for the promotion. Corresponds to the JSON property couponValueType

Returns:

  • (String) 


11619
11620
11621
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11619

def coupon_value_type
  @coupon_value_type
end

#free_gift_description ⇒ String

Free gift description for the promotion. Corresponds to the JSON property freeGiftDescription

Returns:

  • (String) 


11624
11625
11626
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11624

def free_gift_description
  @free_gift_description
end

#free_gift_item_id ⇒ String

Free gift item id for the promotion. Corresponds to the JSON property freeGiftItemId

Returns:

  • (String) 


11629
11630
11631
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11629

def free_gift_item_id
  @free_gift_item_id
end

#free_gift_value ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property freeGiftValue

Returns:



11634
11635
11636
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11634

def free_gift_value
  @free_gift_value
end

#generic_redemption_code ⇒ String

Generic redemption code for the promotion. To be used with the above field. Corresponds to the JSON property genericRedemptionCode

Returns:

  • (String) 


11639
11640
11641
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11639

def generic_redemption_code
  @generic_redemption_code
end

#get_this_quantity_discounted ⇒ Fixnum

The number of items discounted in the promotion. Corresponds to the JSON property getThisQuantityDiscounted

Returns:

  • (Fixnum) 


11644
11645
11646
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11644

def get_this_quantity_discounted
  @get_this_quantity_discounted
end

#id ⇒ String

Required. Output only. The REST promotion id to uniquely identify the promotion. Content API methods that operate on promotions take this as their promotionId parameter. Corresponds to the JSON property id

Returns:

  • (String) 


11651
11652
11653
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11651

def id
  @id
end

#item_group_id ⇒ Array<String>

Product filter by item group id for the promotion. Corresponds to the JSON property itemGroupId

Returns:

  • (Array<String>) 


11656
11657
11658
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11656

def item_group_id
  @item_group_id
end

#item_group_id_exclusion ⇒ Array<String>

Product filter by item group id exclusion for the promotion. Corresponds to the JSON property itemGroupIdExclusion

Returns:

  • (Array<String>) 


11661
11662
11663
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11661

def item_group_id_exclusion
  @item_group_id_exclusion
end

#item_id ⇒ Array<String>

Product filter by item id for the promotion. Corresponds to the JSON property itemId

Returns:

  • (Array<String>) 


11666
11667
11668
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11666

def item_id
  @item_id
end

#item_id_exclusion ⇒ Array<String>

Product filter by item id exclusion for the promotion. Corresponds to the JSON property itemIdExclusion

Returns:

  • (Array<String>) 


11671
11672
11673
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11671

def item_id_exclusion
  @item_id_exclusion
end

#limit_quantity ⇒ Fixnum

Maximum purchase quantity for the promotion. Corresponds to the JSON property limitQuantity

Returns:

  • (Fixnum) 


11676
11677
11678
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11676

def limit_quantity
  @limit_quantity
end

#limit_value ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property limitValue

Returns:



11681
11682
11683
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11681

def limit_value
  @limit_value
end

#long_title ⇒ String

Long title for the promotion. Corresponds to the JSON property longTitle

Returns:

  • (String) 


11686
11687
11688
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11686

def long_title
  @long_title
end

#minimum_purchase_amount ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property minimumPurchaseAmount

Returns:



11691
11692
11693
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11691

def minimum_purchase_amount
  @minimum_purchase_amount
end

#minimum_purchase_quantity ⇒ Fixnum

Minimum purchase quantity for the promotion. Corresponds to the JSON property minimumPurchaseQuantity

Returns:

  • (Fixnum) 


11696
11697
11698
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11696

def minimum_purchase_quantity
  @minimum_purchase_quantity
end

#money_budget ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property moneyBudget

Returns:



11701
11702
11703
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11701

def money_budget
  @money_budget
end

#money_off_amount ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property moneyOffAmount

Returns:



11706
11707
11708
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11706

def money_off_amount
  @money_off_amount
end

#offer_type ⇒ String

Required. Type of the promotion. Corresponds to the JSON property offerType

Returns:

  • (String) 


11711
11712
11713
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11711

def offer_type
  @offer_type
end

#order_limit ⇒ Fixnum

Order limit for the promotion. Corresponds to the JSON property orderLimit

Returns:

  • (Fixnum) 


11716
11717
11718
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11716

def order_limit
  @order_limit
end

#percent_off ⇒ Fixnum

The percentage discount offered in the promotion. Corresponds to the JSON property percentOff

Returns:

  • (Fixnum) 


11721
11722
11723
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11721

def percent_off
  @percent_off
end

#product_applicability ⇒ String

Required. Applicability of the promotion to either all products or only specific products. Corresponds to the JSON property productApplicability

Returns:

  • (String) 


11727
11728
11729
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11727

def product_applicability
  @product_applicability
end

#product_type ⇒ Array<String>

Product filter by product type for the promotion. Corresponds to the JSON property productType

Returns:

  • (Array<String>) 


11732
11733
11734
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11732

def product_type
  @product_type
end

#product_type_exclusion ⇒ Array<String>

Product filter by product type exclusion for the promotion. Corresponds to the JSON property productTypeExclusion

Returns:

  • (Array<String>) 


11737
11738
11739
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11737

def product_type_exclusion
  @product_type_exclusion
end

#promotion_destination_ids ⇒ Array<String>

Destination ID for the promotion. Corresponds to the JSON property promotionDestinationIds

Returns:

  • (Array<String>) 


11742
11743
11744
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11742

def promotion_destination_ids
  @promotion_destination_ids
end

#promotion_display_dates ⇒ String

String representation of the promotion display dates. Corresponds to the JSON property promotionDisplayDates

Returns:

  • (String) 


11747
11748
11749
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11747

def promotion_display_dates
  @promotion_display_dates
end

#promotion_effective_dates ⇒ String

Required. String representation of the promotion effective dates. Corresponds to the JSON property promotionEffectiveDates

Returns:

  • (String) 


11752
11753
11754
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11752

def promotion_effective_dates
  @promotion_effective_dates
end

#promotion_id ⇒ String

Required. The user provided promotion id to uniquely identify the promotion. Corresponds to the JSON property promotionId

Returns:

  • (String) 


11757
11758
11759
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11757

def promotion_id
  @promotion_id
end

#redemption_channel ⇒ Array<String>

Required. Redemption channel for the promotion. At least one channel is required. Corresponds to the JSON property redemptionChannel

Returns:

  • (Array<String>) 


11763
11764
11765
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11763

def redemption_channel
  @redemption_channel
end

#shipping_service_names ⇒ Array<String>

Shipping service names for thse promotion. Corresponds to the JSON property shippingServiceNames

Returns:

  • (Array<String>) 


11768
11769
11770
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11768

def shipping_service_names
  @shipping_service_names
end

#target_country ⇒ String

Required. The target country used as part of the unique identifier. Corresponds to the JSON property targetCountry

Returns:

  • (String) 


11773
11774
11775
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11773

def target_country
  @target_country
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11780

def update!(**args)
  @brand = args[:brand] if args.key?(:brand)
  @brand_exclusion = args[:brand_exclusion] if args.key?(:brand_exclusion)
  @content_language = args[:content_language] if args.key?(:content_language)
  @coupon_value_type = args[:coupon_value_type] if args.key?(:coupon_value_type)
  @free_gift_description = args[:free_gift_description] if args.key?(:free_gift_description)
  @free_gift_item_id = args[:free_gift_item_id] if args.key?(:free_gift_item_id)
  @free_gift_value = args[:free_gift_value] if args.key?(:free_gift_value)
  @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code)
  @get_this_quantity_discounted = args[:get_this_quantity_discounted] if args.key?(:get_this_quantity_discounted)
  @id = args[:id] if args.key?(:id)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @item_group_id_exclusion = args[:item_group_id_exclusion] if args.key?(:item_group_id_exclusion)
  @item_id = args[:item_id] if args.key?(:item_id)
  @item_id_exclusion = args[:item_id_exclusion] if args.key?(:item_id_exclusion)
  @limit_quantity = args[:limit_quantity] if args.key?(:limit_quantity)
  @limit_value = args[:limit_value] if args.key?(:limit_value)
  @long_title = args[:long_title] if args.key?(:long_title)
  @minimum_purchase_amount = args[:minimum_purchase_amount] if args.key?(:minimum_purchase_amount)
  @minimum_purchase_quantity = args[:minimum_purchase_quantity] if args.key?(:minimum_purchase_quantity)
  @money_budget = args[:money_budget] if args.key?(:money_budget)
  @money_off_amount = args[:money_off_amount] if args.key?(:money_off_amount)
  @offer_type = args[:offer_type] if args.key?(:offer_type)
  @order_limit = args[:order_limit] if args.key?(:order_limit)
  @percent_off = args[:percent_off] if args.key?(:percent_off)
  @product_applicability = args[:product_applicability] if args.key?(:product_applicability)
  @product_type = args[:product_type] if args.key?(:product_type)
  @product_type_exclusion = args[:product_type_exclusion] if args.key?(:product_type_exclusion)
  @promotion_destination_ids = args[:promotion_destination_ids] if args.key?(:promotion_destination_ids)
  @promotion_display_dates = args[:promotion_display_dates] if args.key?(:promotion_display_dates)
  @promotion_effective_dates = args[:promotion_effective_dates] if args.key?(:promotion_effective_dates)
  @promotion_id = args[:promotion_id] if args.key?(:promotion_id)
  @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel)
  @shipping_service_names = args[:shipping_service_names] if args.key?(:shipping_service_names)
  @target_country = args[:target_country] if args.key?(:target_country)
end