Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonPromotionAsset

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

Overview

A Promotion asset.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23CommonPromotionAsset

Returns a new instance of GoogleAdsSearchads360V23CommonPromotionAsset.



9765
9766
9767
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9765

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

Instance Attribute Details

#ad_schedule_targets ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAdScheduleInfo>

List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total. Corresponds to the JSON property adScheduleTargets

Returns:



9676
9677
9678
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9676

def ad_schedule_targets
  @ad_schedule_targets
end

#discount_modifier ⇒ String

A modifier for qualification of the discount. Corresponds to the JSON property discountModifier

Returns:

  • (String) 


9681
9682
9683
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9681

def discount_modifier
  @discount_modifier
end

#end_date ⇒ String

Last date of when this asset is effective and still serving, in yyyy-MM-dd format. Corresponds to the JSON property endDate

Returns:

  • (String) 


9687
9688
9689
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9687

def end_date
  @end_date
end

#language_code ⇒ String

The language of the promotion. Represented as BCP 47 language tag. Corresponds to the JSON property languageCode

Returns:

  • (String) 


9692
9693
9694
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9692

def language_code
  @language_code
end

#money_amount_off ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonMoney

Represents a price in a particular currency. Corresponds to the JSON property moneyAmountOff

Returns:



9697
9698
9699
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9697

def money_amount_off
  @money_amount_off
end

#occasion ⇒ String

The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion. Corresponds to the JSON property occasion

Returns:

  • (String) 


9704
9705
9706
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9704

def occasion
  @occasion
end

#orders_over_amount ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonMoney

Represents a price in a particular currency. Corresponds to the JSON property ordersOverAmount

Returns:



9709
9710
9711
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9709

def orders_over_amount
  @orders_over_amount
end

#percent_off ⇒ Fixnum

Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required. Corresponds to the JSON property percentOff

Returns:

  • (Fixnum) 


9715
9716
9717
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9715

def percent_off
  @percent_off
end

#promotion_barcode_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonPromotionBarcodeInfo

Barcode info to generate promotion barcode. Corresponds to the JSON property promotionBarcodeInfo

Returns:



9720
9721
9722
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9720

def promotion_barcode_info
  @promotion_barcode_info
end

#promotion_code ⇒ String

A code the user should use in order to be eligible for the promotion. Corresponds to the JSON property promotionCode

Returns:

  • (String) 


9725
9726
9727
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9725

def promotion_code
  @promotion_code
end

#promotion_qr_code_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonPromotionQrCodeInfo

QR code info to generate promotion QR code. Corresponds to the JSON property promotionQrCodeInfo

Returns:



9730
9731
9732
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9730

def promotion_qr_code_info
  @promotion_qr_code_info
end

#promotion_target ⇒ String

Required. A freeform description of what the promotion is targeting. Corresponds to the JSON property promotionTarget

Returns:

  • (String) 


9735
9736
9737
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9735

def promotion_target
  @promotion_target
end

#redemption_end_date ⇒ String

Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format. Corresponds to the JSON property redemptionEndDate

Returns:

  • (String) 


9741
9742
9743
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9741

def redemption_end_date
  @redemption_end_date
end

#redemption_start_date ⇒ String

Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format. Corresponds to the JSON property redemptionStartDate

Returns:

  • (String) 


9747
9748
9749
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9747

def redemption_start_date
  @redemption_start_date
end

#start_date ⇒ String

Start date of when this asset is effective and can begin serving, in yyyy-MM- dd format. Corresponds to the JSON property startDate

Returns:

  • (String) 


9753
9754
9755
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9753

def start_date
  @start_date
end

#terms_and_conditions_text ⇒ String

Terms and conditions of the promotion. Corresponds to the JSON property termsAndConditionsText

Returns:

  • (String) 


9758
9759
9760
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9758

def terms_and_conditions_text
  @terms_and_conditions_text
end

#terms_and_conditions_uri ⇒ String

URI to the terms and conditions of the promotion. Corresponds to the JSON property termsAndConditionsUri

Returns:

  • (String) 


9763
9764
9765
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9763

def terms_and_conditions_uri
  @terms_and_conditions_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9770

def update!(**args)
  @ad_schedule_targets = args[:ad_schedule_targets] if args.key?(:ad_schedule_targets)
  @discount_modifier = args[:discount_modifier] if args.key?(:discount_modifier)
  @end_date = args[:end_date] if args.key?(:end_date)
  @language_code = args[:language_code] if args.key?(:language_code)
  @money_amount_off = args[:money_amount_off] if args.key?(:money_amount_off)
  @occasion = args[:occasion] if args.key?(:occasion)
  @orders_over_amount = args[:orders_over_amount] if args.key?(:orders_over_amount)
  @percent_off = args[:percent_off] if args.key?(:percent_off)
  @promotion_barcode_info = args[:promotion_barcode_info] if args.key?(:promotion_barcode_info)
  @promotion_code = args[:promotion_code] if args.key?(:promotion_code)
  @promotion_qr_code_info = args[:promotion_qr_code_info] if args.key?(:promotion_qr_code_info)
  @promotion_target = args[:promotion_target] if args.key?(:promotion_target)
  @redemption_end_date = args[:redemption_end_date] if args.key?(:redemption_end_date)
  @redemption_start_date = args[:redemption_start_date] if args.key?(:redemption_start_date)
  @start_date = args[:start_date] if args.key?(:start_date)
  @terms_and_conditions_text = args[:terms_and_conditions_text] if args.key?(:terms_and_conditions_text)
  @terms_and_conditions_uri = args[:terms_and_conditions_uri] if args.key?(:terms_and_conditions_uri)
end