Class: Google::Apis::ContentV2::OrderPromotion

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) ⇒ OrderPromotion

Returns a new instance of OrderPromotion



3862
3863
3864
 
# File 'generated/google/apis/content_v2/classes.rb', line 3862

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

Instance Attribute Details

#benefits ⇒ Array<Google::Apis::ContentV2::OrderPromotionBenefit>

Corresponds to the JSON property benefits

Returns:



3823
3824
3825
 
# File 'generated/google/apis/content_v2/classes.rb', line 3823

def benefits
  @benefits
end

#effective_dates ⇒ String

The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. Corresponds to the JSON property effectiveDates

Returns:

  • (String) 


3834
3835
3836
 
# File 'generated/google/apis/content_v2/classes.rb', line 3834

def effective_dates
  @effective_dates
end

#generic_redemption_code ⇒ String

Optional. The text code that corresponds to the promotion when applied on the retailer?s website. Corresponds to the JSON property genericRedemptionCode

Returns:

  • (String) 


3840
3841
3842
 
# File 'generated/google/apis/content_v2/classes.rb', line 3840

def generic_redemption_code
  @generic_redemption_code
end

#id ⇒ String

The unique ID of the promotion. Corresponds to the JSON property id

Returns:

  • (String) 


3845
3846
3847
 
# File 'generated/google/apis/content_v2/classes.rb', line 3845

def id
  @id
end

#long_title ⇒ String

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

Returns:

  • (String) 


3850
3851
3852
 
# File 'generated/google/apis/content_v2/classes.rb', line 3850

def long_title
  @long_title
end

#product_applicability ⇒ String

Whether the promotion is applicable to all products or only specific products. Corresponds to the JSON property productApplicability

Returns:

  • (String) 


3855
3856
3857
 
# File 'generated/google/apis/content_v2/classes.rb', line 3855

def product_applicability
  @product_applicability
end

#redemption_channel ⇒ String

Indicates that the promotion is valid online. Corresponds to the JSON property redemptionChannel

Returns:

  • (String) 


3860
3861
3862
 
# File 'generated/google/apis/content_v2/classes.rb', line 3860

def redemption_channel
  @redemption_channel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3867
3868
3869
3870
3871
3872
3873
3874
3875
 
# File 'generated/google/apis/content_v2/classes.rb', line 3867

def update!(**args)
  @benefits = args[:benefits] if args.key?(:benefits)
  @effective_dates = args[:effective_dates] if args.key?(:effective_dates)
  @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code)
  @id = args[:id] if args.key?(:id)
  @long_title = args[:long_title] if args.key?(:long_title)
  @product_applicability = args[:product_applicability] if args.key?(:product_applicability)
  @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel)
end