Class: Google::Cloud::RecommendationEngine::V1beta1::ProductEventDetail

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

ProductEventDetail captures user event information specific to retail products.

Instance Attribute Summary collapse

Instance Attribute Details

#cart_id ⇒ ::String

Returns Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.

This can only be set for add-to-cart, remove-from-cart, checkout-start, purchase-complete, or shopping-cart-page-view events.

Returns:

  • (::String) —

    Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.

    This can only be set for add-to-cart, remove-from-cart, checkout-start, purchase-complete, or shopping-cart-page-view events.



262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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

#list_id ⇒ ::String

Returns Required for add-to-list and remove-from-list events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.

Returns:

  • (::String) —

    Required for add-to-list and remove-from-list events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.



262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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

#page_categories ⇒ ::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem::CategoryHierarchy>

Returns Required for category-page-view events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : ["Sales", "2017 Black Friday Deals"].

Returns:

  • (::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem::CategoryHierarchy>) —

    Required for category-page-view events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : ["Sales", "2017 Black Friday Deals"].



262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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

#product_details ⇒ ::Array<::Google::Cloud::RecommendationEngine::V1beta1::ProductDetail>

Returns The main product details related to the event.

This field is required for the following event types:

  • add-to-cart
  • add-to-list
  • checkout-start
  • detail-page-view
  • purchase-complete
  • refund
  • remove-from-cart
  • remove-from-list

This field is optional for the following event types:

  • page-visit
  • shopping-cart-page-view - note that 'product_details' should be set for this unless the shopping cart is empty.

This field is not allowed for the following event types:

  • category-page-view
  • home-page-view
  • search.

Returns:

  • (::Array<::Google::Cloud::RecommendationEngine::V1beta1::ProductDetail>) —

    The main product details related to the event.

    This field is required for the following event types:

    • add-to-cart
    • add-to-list
    • checkout-start
    • detail-page-view
    • purchase-complete
    • refund
    • remove-from-cart
    • remove-from-list

    This field is optional for the following event types:

    • page-visit
    • shopping-cart-page-view - note that 'product_details' should be set for this unless the shopping cart is empty.

    This field is not allowed for the following event types:

    • category-page-view
    • home-page-view
    • search


262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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

#purchase_transaction ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::PurchaseTransaction

Returns Optional. A transaction represents the entire purchase transaction. Required for purchase-complete events. Optional for checkout-start events. Other event types should not set this field.

Returns:



262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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

#search_query ⇒ ::String

Returns Required for search events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.

Returns:

  • (::String) —

    Required for search events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.



262
263
264
265
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 262

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