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



4516
4517
4518
 
# File 'generated/google/apis/content_v2/classes.rb', line 4516

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

Instance Attribute Details

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

Corresponds to the JSON property benefits

Returns:



4477
4478
4479
 
# File 'generated/google/apis/content_v2/classes.rb', line 4477

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) 


4488
4489
4490
 
# File 'generated/google/apis/content_v2/classes.rb', line 4488

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) 


4494
4495
4496
 
# File 'generated/google/apis/content_v2/classes.rb', line 4494

def generic_redemption_code
  @generic_redemption_code
end

#id ⇒ String

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

Returns:

  • (String) 


4499
4500
4501
 
# File 'generated/google/apis/content_v2/classes.rb', line 4499

def id
  @id
end

#long_title ⇒ String

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

Returns:

  • (String) 


4504
4505
4506
 
# File 'generated/google/apis/content_v2/classes.rb', line 4504

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) 


4509
4510
4511
 
# File 'generated/google/apis/content_v2/classes.rb', line 4509

def product_applicability
  @product_applicability
end

#redemption_channel ⇒ String

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

Returns:

  • (String) 


4514
4515
4516
 
# File 'generated/google/apis/content_v2/classes.rb', line 4514

def redemption_channel
  @redemption_channel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4521
4522
4523
4524
4525
4526
4527
4528
4529
 
# File 'generated/google/apis/content_v2/classes.rb', line 4521

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