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.



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

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:



9608
9609
9610
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9608

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) 


9613
9614
9615
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9613

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) 


9619
9620
9621
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9619

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) 


9624
9625
9626
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9624

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:



9629
9630
9631
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9629

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) 


9636
9637
9638
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9636

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:



9641
9642
9643
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9641

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) 


9647
9648
9649
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9647

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:



9652
9653
9654
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9652

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) 


9657
9658
9659
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9657

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:



9662
9663
9664
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9662

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) 


9667
9668
9669
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9667

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) 


9673
9674
9675
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9673

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) 


9679
9680
9681
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9679

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) 


9685
9686
9687
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9685

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) 


9690
9691
9692
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9690

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) 


9695
9696
9697
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9695

def terms_and_conditions_uri
  @terms_and_conditions_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 9702

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