Recommendations AI v1beta1 API - Class ProductEventDetail (2.0.0-beta02) 

public sealed class ProductEventDetail : IMessage<ProductEventDetail>, IEquatable<ProductEventDetail>, IDeepCloneable<ProductEventDetail>, IBufferMessage, IMessage

Reference documentation and code samples for the Recommendations AI v1beta1 API class ProductEventDetail.

ProductEventDetail captures user event information specific to retail products.

Inheritance

Object > ProductEventDetail

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

ProductEventDetail()

public ProductEventDetail()

ProductEventDetail(ProductEventDetail)

public ProductEventDetail(ProductEventDetail other)
Parameter
NameDescription
otherProductEventDetail

Properties

CartId

public string CartId { get; set; }

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.

Property Value
TypeDescription
String

ListId

public string ListId { get; set; }

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.

Property Value
TypeDescription
String

PageCategories

public RepeatedField<CatalogItem.Types.CategoryHierarchy> PageCategories { get; }

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"].

Property Value
TypeDescription
RepeatedField<CatalogItem.Types.CategoryHierarchy>

ProductDetails

public RepeatedField<ProductDetail> ProductDetails { get; }

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
Property Value
TypeDescription
RepeatedField<ProductDetail>

PurchaseTransaction

public PurchaseTransaction PurchaseTransaction { get; set; }

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.

Property Value
TypeDescription
PurchaseTransaction

SearchQuery

public string SearchQuery { get; set; }

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.

Property Value
TypeDescription
String