Class: Google::Shopping::Merchant::Promotions::V1::Attributes

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb

Overview

Attributes.

Instance Attribute Summary collapse

Instance Attribute Details

#brand_exclusion ⇒ ::Array<::String>

Returns Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#brand_inclusion ⇒ ::Array<::String>

Returns Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#coupon_value_type ⇒ ::Google::Shopping::Merchant::Promotions::V1::CouponValueType

Returns Required. The coupon value type attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value some attributes are required.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#free_gift_description ⇒ ::String

Returns Optional. Free gift description for the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#free_gift_item_id ⇒ ::String

Returns Optional. Free gift item ID for the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#free_gift_value ⇒ ::Google::Shopping::Type::Price

Returns Optional. Free gift value for the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#generic_redemption_code ⇒ ::String

Returns Optional. Generic redemption code for the promotion. To be used with the offerType field and must meet the minimum requirements.

Returns:

  • (::String) —

    Optional. Generic redemption code for the promotion. To be used with the offerType field and must meet the minimum requirements.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#get_this_quantity_discounted ⇒ ::Integer

Returns Optional. The number of items discounted in the promotion. The attribute is set when couponValueType is equal to buy_m_get_n_money_off or buy_m_get_n_percent_off.

Returns:

  • (::Integer) —

    Optional. The number of items discounted in the promotion. The attribute is set when couponValueType is equal to buy_m_get_n_money_off or buy_m_get_n_percent_off.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#item_group_id_exclusion ⇒ ::Array<::String>

Returns Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#item_group_id_inclusion ⇒ ::Array<::String>

Returns Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#item_id_exclusion ⇒ ::Array<::String>

Returns Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#item_id_inclusion ⇒ ::Array<::String>

Returns Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#limit_quantity ⇒ ::Integer

Returns Optional. Maximum purchase quantity for the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#limit_value ⇒ ::Google::Shopping::Type::Price

Returns Optional. Maximum product price for promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#long_title ⇒ ::String

Returns Required. Long title for the promotion.

Returns:

  • (::String) —

    Required. Long title for the promotion.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#minimum_purchase_amount ⇒ ::Google::Shopping::Type::Price

Returns Optional. Minimum purchase amount for the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#minimum_purchase_quantity ⇒ ::Integer

Returns:

  • (::Integer) 


221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#money_off_amount ⇒ ::Google::Shopping::Type::Price

Returns Optional. The money off amount offered in the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#offer_type ⇒ ::Google::Shopping::Merchant::Promotions::V1::OfferType

Returns Required. Type of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#percent_off ⇒ ::Integer

Returns Optional. The percentage discount offered in the promotion.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_applicability ⇒ ::Google::Shopping::Merchant::Promotions::V1::ProductApplicability

Returns Required. Applicability of the promotion to either all products or only specific products.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_exclusion ⇒ ::Array<::String>

Returns Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_type_inclusion ⇒ ::Array<::String>

Returns Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

Returns:

  • (::Array<::String>) —

    Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_destinations ⇒ ::Array<::Google::Shopping::Type::Destination::DestinationEnum>

Returns Required. The list of destinations (also known as Marketing methods) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination.

Returns:

  • (::Array<::Google::Shopping::Type::Destination::DestinationEnum>) —

    Required. The list of destinations (also known as Marketing methods) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

    You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_display_time_period ⇒ ::Google::Type::Interval

Returns Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.

Returns:

  • (::Google::Type::Interval) —

    Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_effective_time_period ⇒ ::Google::Type::Interval

Returns Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.

Returns:

  • (::Google::Type::Interval) —

    Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_url ⇒ ::String

Returns Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promotion_url is included. URL is used to confirm that the promotion is valid and can be redeemed.

Returns:

  • (::String) —

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



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#store_applicability ⇒ ::Google::Shopping::Merchant::Promotions::V1::StoreApplicability

Returns Optional. 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_codes_inclusion or score_code_exclusion is set to a value.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#store_codes_exclusion ⇒ ::Array<::String>

Returns Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#store_codes_inclusion ⇒ ::Array<::String>

Returns Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

Returns:



221
222
223
224
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 221

class Attributes
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end