Class: Google::Apis::ContentV2_1::Promotion

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

Overview

Represents a promotion. See the following articles for more details. * Promotions feed specification * Local promotions feed specification * Promotions on Buy on Google product data specification

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Promotion

Returns a new instance of Promotion.



11235
11236
11237
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11235

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

Instance Attribute Details

#brand ⇒ Array<String>

Product filter by brand for the promotion. Corresponds to the JSON property brand

Returns:

  • (Array<String>) 


11011
11012
11013
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11011

def brand
  @brand
end

#brand_exclusion ⇒ Array<String>

Product filter by brand exclusion for the promotion. Corresponds to the JSON property brandExclusion

Returns:

  • (Array<String>) 


11016
11017
11018
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11016

def brand_exclusion
  @brand_exclusion
end

#content_language ⇒ String

Required. The content language used as part of the unique identifier. en content language is available for all target countries. fr content language is available for CA and FR target countries. de content language is available for DE target country. nl content language is available for NL target country. it content language is available for IT target country. pt content language is available for BR target country. ja content language is available for JP target country. ko content language is available for KR target country. Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


11028
11029
11030
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11028

def content_language
  @content_language
end

#coupon_value_type ⇒ String

Required. Coupon value type for the promotion. Corresponds to the JSON property couponValueType

Returns:

  • (String) 


11033
11034
11035
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11033

def coupon_value_type
  @coupon_value_type
end

#free_gift_description ⇒ String

Free gift description for the promotion. Corresponds to the JSON property freeGiftDescription

Returns:

  • (String) 


11038
11039
11040
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11038

def free_gift_description
  @free_gift_description
end

#free_gift_item_id ⇒ String

Free gift item ID for the promotion. Corresponds to the JSON property freeGiftItemId

Returns:

  • (String) 


11043
11044
11045
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11043

def free_gift_item_id
  @free_gift_item_id
end

#free_gift_value ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property freeGiftValue

Returns:



11048
11049
11050
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11048

def free_gift_value
  @free_gift_value
end

#generic_redemption_code ⇒ String

Generic redemption code for the promotion. To be used with the offerType field. Corresponds to the JSON property genericRedemptionCode

Returns:

  • (String) 


11054
11055
11056
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11054

def generic_redemption_code
  @generic_redemption_code
end

#get_this_quantity_discounted ⇒ Fixnum

The number of items discounted in the promotion. Corresponds to the JSON property getThisQuantityDiscounted

Returns:

  • (Fixnum) 


11059
11060
11061
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11059

def get_this_quantity_discounted
  @get_this_quantity_discounted
end

#id ⇒ String

Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their promotionId parameter. The REST ID for a promotion is of the form channel:contentLanguage: targetCountry:promotionId The channel field has a value of "online", " in_store", or "online_in_store". Corresponds to the JSON property id

Returns:

  • (String) 


11068
11069
11070
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11068

def id
  @id
end

#item_group_id ⇒ Array<String>

Product filter by item group ID for the promotion. Corresponds to the JSON property itemGroupId

Returns:

  • (Array<String>) 


11073
11074
11075
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11073

def item_group_id
  @item_group_id
end

#item_group_id_exclusion ⇒ Array<String>

Product filter by item group ID exclusion for the promotion. Corresponds to the JSON property itemGroupIdExclusion

Returns:

  • (Array<String>) 


11078
11079
11080
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11078

def item_group_id_exclusion
  @item_group_id_exclusion
end

#item_id ⇒ Array<String>

Product filter by item ID for the promotion. Corresponds to the JSON property itemId

Returns:

  • (Array<String>) 


11083
11084
11085
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11083

def item_id
  @item_id
end

#item_id_exclusion ⇒ Array<String>

Product filter by item ID exclusion for the promotion. Corresponds to the JSON property itemIdExclusion

Returns:

  • (Array<String>) 


11088
11089
11090
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11088

def item_id_exclusion
  @item_id_exclusion
end

#limit_quantity ⇒ Fixnum

Maximum purchase quantity for the promotion. Corresponds to the JSON property limitQuantity

Returns:

  • (Fixnum) 


11093
11094
11095
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11093

def limit_quantity
  @limit_quantity
end

#limit_value ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property limitValue

Returns:



11098
11099
11100
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11098

def limit_value
  @limit_value
end

#long_title ⇒ String

Required. Long title for the promotion. Corresponds to the JSON property longTitle

Returns:

  • (String) 


11103
11104
11105
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11103

def long_title
  @long_title
end

#minimum_purchase_amount ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property minimumPurchaseAmount

Returns:



11108
11109
11110
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11108

def minimum_purchase_amount
  @minimum_purchase_amount
end

#minimum_purchase_quantity ⇒ Fixnum

Minimum purchase quantity for the promotion. Corresponds to the JSON property minimumPurchaseQuantity

Returns:

  • (Fixnum) 


11113
11114
11115
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11113

def minimum_purchase_quantity
  @minimum_purchase_quantity
end

#money_budget ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property moneyBudget

Returns:



11118
11119
11120
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11118

def money_budget
  @money_budget
end

#money_off_amount ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property moneyOffAmount

Returns:



11123
11124
11125
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11123

def money_off_amount
  @money_off_amount
end

#offer_type ⇒ String

Required. Type of the promotion. Corresponds to the JSON property offerType

Returns:

  • (String) 


11128
11129
11130
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11128

def offer_type
  @offer_type
end

#order_limit ⇒ Fixnum

Order limit for the promotion. Corresponds to the JSON property orderLimit

Returns:

  • (Fixnum) 


11133
11134
11135
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11133

def order_limit
  @order_limit
end

#percent_off ⇒ Fixnum

The percentage discount offered in the promotion. Corresponds to the JSON property percentOff

Returns:

  • (Fixnum) 


11138
11139
11140
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11138

def percent_off
  @percent_off
end

#product_applicability ⇒ String

Required. Applicability of the promotion to either all products or only specific products. Corresponds to the JSON property productApplicability

Returns:

  • (String) 


11144
11145
11146
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11144

def product_applicability
  @product_applicability
end

#product_type ⇒ Array<String>

Product filter by product type for the promotion. Corresponds to the JSON property productType

Returns:

  • (Array<String>) 


11149
11150
11151
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11149

def product_type
  @product_type
end

#product_type_exclusion ⇒ Array<String>

Product filter by product type exclusion for the promotion. Corresponds to the JSON property productTypeExclusion

Returns:

  • (Array<String>) 


11154
11155
11156
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11154

def product_type_exclusion
  @product_type_exclusion
end

#promotion_destination_ids ⇒ Array<String>

Destination ID for the promotion. Corresponds to the JSON property promotionDestinationIds

Returns:

  • (Array<String>) 


11159
11160
11161
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11159

def promotion_destination_ids
  @promotion_destination_ids
end

#promotion_display_dates ⇒ String

String representation of the promotion display dates. Deprecated. Use promotion_display_time_period instead. Corresponds to the JSON property promotionDisplayDates

Returns:

  • (String) 


11165
11166
11167
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11165

def promotion_display_dates
  @promotion_display_dates
end

#promotion_display_time_period ⇒ Google::Apis::ContentV2_1::TimePeriod

A message that represents a time period. Corresponds to the JSON property promotionDisplayTimePeriod

Returns:



11170
11171
11172
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11170

def promotion_display_time_period
  @promotion_display_time_period
end

#promotion_effective_dates ⇒ String

String representation of the promotion effective dates. Deprecated. Use promotion_effective_time_period instead. Corresponds to the JSON property promotionEffectiveDates

Returns:

  • (String) 


11176
11177
11178
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11176

def promotion_effective_dates
  @promotion_effective_dates
end

#promotion_effective_time_period ⇒ Google::Apis::ContentV2_1::TimePeriod

A message that represents a time period. Corresponds to the JSON property promotionEffectiveTimePeriod

Returns:



11181
11182
11183
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11181

def promotion_effective_time_period
  @promotion_effective_time_period
end

#promotion_id ⇒ String

Required. The user provided promotion ID to uniquely identify the promotion. Corresponds to the JSON property promotionId

Returns:

  • (String) 


11186
11187
11188
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11186

def promotion_id
  @promotion_id
end

#promotion_status ⇒ Google::Apis::ContentV2_1::PromotionPromotionStatus

The status of the promotion. Corresponds to the JSON property promotionStatus

Returns:



11191
11192
11193
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11191

def promotion_status
  @promotion_status
end

#promotion_url ⇒ String

URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed. Corresponds to the JSON property promotionUrl

Returns:

  • (String) 


11198
11199
11200
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11198

def promotion_url
  @promotion_url
end

#redemption_channel ⇒ Array<String>

Required. Redemption channel for the promotion. At least one channel is required. Corresponds to the JSON property redemptionChannel

Returns:

  • (Array<String>) 


11204
11205
11206
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11204

def redemption_channel
  @redemption_channel
end

#shipping_service_names ⇒ Array<String>

Shipping service names for the promotion. Corresponds to the JSON property shippingServiceNames

Returns:

  • (Array<String>) 


11209
11210
11211
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11209

def shipping_service_names
  @shipping_service_names
end

#store_applicability ⇒ String

Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value. Corresponds to the JSON property storeApplicability

Returns:

  • (String) 


11217
11218
11219
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11217

def store_applicability
  @store_applicability
end

#store_code ⇒ Array<String>

Store codes to include for the promotion. Corresponds to the JSON property storeCode

Returns:

  • (Array<String>) 


11222
11223
11224
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11222

def store_code
  @store_code
end

#store_code_exclusion ⇒ Array<String>

Store codes to exclude for the promotion. Corresponds to the JSON property storeCodeExclusion

Returns:

  • (Array<String>) 


11227
11228
11229
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11227

def store_code_exclusion
  @store_code_exclusion
end

#target_country ⇒ String

Required. The target country used as part of the unique identifier. Can be AU , CA, DE, FR, GB, IN, US, BR, ES, NL, JP, IT or KR. Corresponds to the JSON property targetCountry

Returns:

  • (String) 


11233
11234
11235
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11233

def target_country
  @target_country
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11240

def update!(**args)
  @brand = args[:brand] if args.key?(:brand)
  @brand_exclusion = args[:brand_exclusion] if args.key?(:brand_exclusion)
  @content_language = args[:content_language] if args.key?(:content_language)
  @coupon_value_type = args[:coupon_value_type] if args.key?(:coupon_value_type)
  @free_gift_description = args[:free_gift_description] if args.key?(:free_gift_description)
  @free_gift_item_id = args[:free_gift_item_id] if args.key?(:free_gift_item_id)
  @free_gift_value = args[:free_gift_value] if args.key?(:free_gift_value)
  @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code)
  @get_this_quantity_discounted = args[:get_this_quantity_discounted] if args.key?(:get_this_quantity_discounted)
  @id = args[:id] if args.key?(:id)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @item_group_id_exclusion = args[:item_group_id_exclusion] if args.key?(:item_group_id_exclusion)
  @item_id = args[:item_id] if args.key?(:item_id)
  @item_id_exclusion = args[:item_id_exclusion] if args.key?(:item_id_exclusion)
  @limit_quantity = args[:limit_quantity] if args.key?(:limit_quantity)
  @limit_value = args[:limit_value] if args.key?(:limit_value)
  @long_title = args[:long_title] if args.key?(:long_title)
  @minimum_purchase_amount = args[:minimum_purchase_amount] if args.key?(:minimum_purchase_amount)
  @minimum_purchase_quantity = args[:minimum_purchase_quantity] if args.key?(:minimum_purchase_quantity)
  @money_budget = args[:money_budget] if args.key?(:money_budget)
  @money_off_amount = args[:money_off_amount] if args.key?(:money_off_amount)
  @offer_type = args[:offer_type] if args.key?(:offer_type)
  @order_limit = args[:order_limit] if args.key?(:order_limit)
  @percent_off = args[:percent_off] if args.key?(:percent_off)
  @product_applicability = args[:product_applicability] if args.key?(:product_applicability)
  @product_type = args[:product_type] if args.key?(:product_type)
  @product_type_exclusion = args[:product_type_exclusion] if args.key?(:product_type_exclusion)
  @promotion_destination_ids = args[:promotion_destination_ids] if args.key?(:promotion_destination_ids)
  @promotion_display_dates = args[:promotion_display_dates] if args.key?(:promotion_display_dates)
  @promotion_display_time_period = args[:promotion_display_time_period] if args.key?(:promotion_display_time_period)
  @promotion_effective_dates = args[:promotion_effective_dates] if args.key?(:promotion_effective_dates)
  @promotion_effective_time_period = args[:promotion_effective_time_period] if args.key?(:promotion_effective_time_period)
  @promotion_id = args[:promotion_id] if args.key?(:promotion_id)
  @promotion_status = args[:promotion_status] if args.key?(:promotion_status)
  @promotion_url = args[:promotion_url] if args.key?(:promotion_url)
  @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel)
  @shipping_service_names = args[:shipping_service_names] if args.key?(:shipping_service_names)
  @store_applicability = args[:store_applicability] if args.key?(:store_applicability)
  @store_code = args[:store_code] if args.key?(:store_code)
  @store_code_exclusion = args[:store_code_exclusion] if args.key?(:store_code_exclusion)
  @target_country = args[:target_country] if args.key?(:target_country)
end