You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: src/recommendations/events.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ If shoppers use ad blockers or enable privacy settings that prevent the `magento
12
12
If [Cookie Restriction Mode](https://docs.magento.com/m2/ce/user_guide/stores/compliance-cookie-restriction-mode.html) is enabled, Magento does not collect behavioral data until the shopper consents. If Cookie Restriction Mode is disabled, Magento collects behavioral data by default.
13
13
14
14
Event | Category | Description
15
-
--- | ---
15
+
--- | --- | ---
16
16
`add-to-cart` | product | A product is added to the cart
17
17
`add-to-wishlist` | product | A product is added to the wishlist
18
18
`apply-discount-action` | shopping-cart | A discount code is applied to the cart
Copy file name to clipboardExpand all lines: src/recommendations/headless.md
+27-18Lines changed: 27 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -6,32 +6,41 @@ ee_only: True
6
6
7
7
You can integrate Product Recommendations in a headless storefront using either [PWA Studio](https://magento.github.io/pwa-studio/) or a custom frontend technology, such as React or Vue JS.
8
8
9
-
Product Recommendations require [behavioral and catalog data](https://devdocs.magento.com/recommendations/product-recs.html#types-of-data)to operate. The catalog data sync process remains unchanged in a headless implementation, but changes are needed for behavioral data collection.
9
+
Product Recommendations require [behavioral and catalog data]({{ page.baseurl }}recommendations/product-recs.html#types-of-data)to operate. The catalog data sync process remains unchanged in a headless implementation, but changes are needed for behavioral data collection.
10
10
11
-
The roles of the custom storefront using Product Recommendations are two-fold:
12
-
1. send behavioral data to Adobe Sensei so that these events can be analyzed to compute Product Recommendation results; additional data can be sent to enable product recommendation [metrics reporting](https://docs.magento.com/user-guide/marketing/recommendation-metrics.html)
13
-
2. fetch product recommendation results and render them on the page
11
+
To integrate Product Recommendations in a headless storefront you must:
14
12
15
-
Both of these actions can be performed using available SDKs as described below.
13
+
1. Send behavioral data to Adobe Sensei to analyze and compute Product Recommendation results. You also can send additional data to enable product recommendation [metrics reporting](https://docs.magento.com/user-guide/marketing/recommendation-metrics.html).
16
14
17
-
Use the following workflow to integrate your headless storefront with Product Recommendations.
15
+
1. Fetch product recommendation results and render those results on the page.
16
+
17
+
You can perform both of these actions using the available SDKs as described below.
18
+
19
+
The following workflow describes how to integrate Product Recommendation in a headless storefront.
18
20
19
21
1.[Install the Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) module.
20
22
21
-
1. Install and use the [Storefront Events SDK]({{ page.baseurl }}/shared-services/storefront-events-sdk.html) to fire the [behavioral events](https://devdocs.magento.com/recommendations/events.html).
22
-
The minimum required events to enable product recommendations are product view, add-to-cart, and place-order.
23
-
To enable metrics reporting (link), the following additional events are required:
24
-
recommendation-unit impression-render
25
-
recommendation-unit view
26
-
recommendation-unit rec-click
27
-
recommendation-unit rec-add-to-cart-click (if an add-to-cart button is present in the Recs template)
28
-
--
23
+
1. Install and use the [Storefront Events SDK]({{ page.baseurl }}/shared-services/storefront-events-sdk.html) to fire the [behavioral events]({{ page.baseurl }}/recommendations/events.html).
24
+
25
+
The minimum required events to enable Product Recommendations are:
26
+
27
+
Event | Category
28
+
--- | ---
29
+
`view` | product
30
+
`add-to-cart` | product
31
+
`place-order` | checkout
29
32
33
+
To enable [metrics reporting](https://docs.magento.com/user-guide/marketing/recommendation-metrics.html), the following additional events are required:
30
34
31
-
<brclass="Apple-interchange-newline">
35
+
Event | Category
36
+
--- | ---
37
+
`impression-render` | recommendation-unit
38
+
`view` | recommendation-unit
39
+
`rec-click` | recommendation-unit
40
+
`rec-add-to-cart-click` | recommendation-unit (if an add to cart button is present in the recommendations template)
32
41
33
-
1. When the events are fired, use the [Storefront Events Collector]({{ page.baseurl }}/shared-services/storefront-event-collector.html) as a handler to send them to Adobe Sensei.
42
+
1. When the events are fired, use the [Storefront Events Collector]({{ page.baseurl }}/shared-services/storefront-event-collector.html) to handle the events and send them to Adobe Sensei.
34
43
35
-
1.Once behavioral data collection is orchestrated using above steps, the business user can [create Product Recommendations](https://docs.magento.com/user-guide/marketing/create-new-rec.html) in the Commerce Admin.
44
+
1.After the behavioral data is collected, you can [create Product Recommendations](https://docs.magento.com/user-guide/marketing/create-new-rec.html) in the Admin.
36
45
37
-
1. Use the [Recommendations SDK]({{ page.baseurl }}/recommendations/recs-api.html) to fetch the recommendation units on the storefront. It returns necessary product data to render recommendation units on a page.
46
+
1. Use the [Recommendations SDK]({{ page.baseurl }}/recommendations/recs-api.html) to fetch the recommendation units on the storefront. The SDK returns necessary product data to render recommendation units on a page.
0 commit comments