Class: Google::Cloud::RecommendationEngine::V1beta1::ProductDetail

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb

Overview

Detailed product information associated with a user event.

Instance Attribute Summary collapse

Instance Attribute Details

#available_quantity ⇒ ::Integer

Returns Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if stock_status is set to IN_STOCK.

Note that if an item is out of stock, you must set the stock_state field to be OUT_OF_STOCK. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock.

Returns:

  • (::Integer) —

    Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if stock_status is set to IN_STOCK.

    Note that if an item is out of stock, you must set the stock_state field to be OUT_OF_STOCK. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#currency_code ⇒ ::String

Returns Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.

Returns:

  • (::String) —

    Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#display_price ⇒ ::Float

Returns Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.

Returns:

  • (::Float) —

    Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#id ⇒ ::String

Returns Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.

Returns:

  • (::String) —

    Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#item_attributes ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap

Returns Optional. Extra features associated with a product in the user event.

Returns:



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#original_price ⇒ ::Float

Returns Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.

Returns:

  • (::Float) —

    Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#quantity ⇒ ::Integer

Returns Optional. Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for add-to-cart event. Required for add-to-cart, add-to-list, remove-from-cart, checkout-start, purchase-complete, refund event types.

Returns:

  • (::Integer) —

    Optional. Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for add-to-cart event. Required for add-to-cart, add-to-list, remove-from-cart, checkout-start, purchase-complete, refund event types.



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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

#stock_state ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem::StockState

Returns Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.

Returns:



360
361
362
363
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 360

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