Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 352c252

Browse files
authored
Merge pull request magento-commerce/devdocs/pull#2532 from magento-devdocs/em_prex-headless
Adding topic about headless implementation
2 parents 99cb151 + bdd3b5b commit 352c252

File tree

3 files changed

+51
-1
lines changed

3 files changed

+51
-1
lines changed

src/_data/toc/product-recommendations.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ pages:
3232
url: /recommendations/customize.html
3333
versionless: true
3434

35+
- label: Integrate Product Recommendations into your Headless Storefront
36+
url: /recommendations/headless.html
37+
versionless: true
38+
3539
- label: Recommendations SDK
3640
url: /recommendations/recs-api.html
3741
versionless: true

src/recommendations/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If shoppers use ad blockers or enable privacy settings that prevent the `magento
1212
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.
1313

1414
Event | Category | Description
15-
--- | ---
15+
--- | --- | ---
1616
`add-to-cart` | product | A product is added to the cart
1717
`add-to-wishlist` | product | A product is added to the wishlist
1818
`apply-discount-action` | shopping-cart | A discount code is applied to the cart

src/recommendations/headless.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
group: product-recommendations
3+
title: Integrate Product Recommendations into your Headless Storefront
4+
ee_only: True
5+
---
6+
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+
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+
11+
To integrate Product Recommendations in a headless storefront you must:
12+
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).
14+
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.
20+
21+
1. [Install the Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) module.
22+
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
32+
33+
To enable [metrics reporting](https://docs.magento.com/user-guide/marketing/recommendation-metrics.html), the following additional events are required:
34+
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)
41+
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.
43+
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.
45+
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

Comments
 (0)