Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class ProductEventDetail.
ProductEventDetail captures user event information specific to retail products.
Generated from protobuf message google.cloud.recommendationengine.v1beta1.ProductEventDetail
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ search_query |
string
Required for |
↳ page_categories |
array<Google\Cloud\RecommendationEngine\V1beta1\CatalogItem\CategoryHierarchy>
Required for |
↳ product_details |
array<Google\Cloud\RecommendationEngine\V1beta1\ProductDetail>
The main product details related to the event. This field is required for the following event types: * |
↳ list_id |
string
Required for |
↳ cart_id |
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 |
↳ purchase_transaction |
Google\Cloud\RecommendationEngine\V1beta1\PurchaseTransaction
Optional. A transaction represents the entire purchase transaction. Required for |
getSearchQuery
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 | |
|---|---|
| Type | Description |
string | |
setSearchQuery
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageCategories
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPageCategories
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"].
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecommendationEngine\V1beta1\CatalogItem\CategoryHierarchy>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductDetails
The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:page-visitshopping-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-viewhome-page-viewsearch
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setProductDetails
The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:page-visitshopping-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-viewhome-page-viewsearch
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecommendationEngine\V1beta1\ProductDetail>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getListId
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 | |
|---|---|
| Type | Description |
string | |
setListId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCartId
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 | |
|---|---|
| Type | Description |
string | |
setCartId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPurchaseTransaction
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 | |
|---|---|
| Type | Description |
Google\Cloud\RecommendationEngine\V1beta1\PurchaseTransaction|null | |
hasPurchaseTransaction
clearPurchaseTransaction
setPurchaseTransaction
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\RecommendationEngine\V1beta1\PurchaseTransaction
|
| Returns | |
|---|---|
| Type | Description |
$this | |