Class: Google::Apis::ContentV2sandbox::OrderPromotion

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



831
832
833
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 831

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

Instance Attribute Details

#benefitsArray<Google::Apis::ContentV2sandbox::OrderPromotionBenefit>

Corresponds to the JSON property benefits



792
793
794
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 792

def benefits
  @benefits
end

#effective_datesString

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)


803
804
805
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 803

def effective_dates
  @effective_dates
end

#generic_redemption_codeString

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

Returns:

  • (String)


809
810
811
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 809

def generic_redemption_code
  @generic_redemption_code
end

#idString

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

Returns:

  • (String)


814
815
816
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 814

def id
  @id
end

#long_titleString

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

Returns:

  • (String)


819
820
821
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 819

def long_title
  @long_title
end

#product_applicabilityString

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

Returns:

  • (String)


824
825
826
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 824

def product_applicability
  @product_applicability
end

#redemption_channelString

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

Returns:

  • (String)


829
830
831
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 829

def redemption_channel
  @redemption_channel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



836
837
838
839
840
841
842
843
844
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 836

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