ProductEventDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)ProductEventDetail captures user event information specific to retail products.
Attributes
| Name | Description |
| search_query |
str
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. |
| page_categories |
Sequence[google.cloud.recommendationengine_v1beta1.types.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"]. |
| product_details |
Sequence[google.cloud.recommendationengine_v1beta1.types.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`` |
| list_id |
str
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. |
| cart_id |
str
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. |
| purchase_transaction |
google.cloud.recommendationengine_v1beta1.types.PurchaseTransaction
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. |