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

Commit b0c85a1

Browse files
authored
Merge pull request magento-commerce/devdocs/pull#2612 from magento-devdocs/em_prex-eventsdk
Cleaning up PREX events topic
2 parents 0c09f4c + 7a5a920 commit b0c85a1

File tree

6 files changed

+27
-33
lines changed

6 files changed

+27
-33
lines changed

src/_data/toc/product-recommendations.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pages:
1212
url: /recommendations/install-configure.html
1313
versionless: true
1414

15-
- label: Recommendation Events
15+
- label: Data Collection for Recommendations
1616
url: /recommendations/events.html
1717
versionless: true
1818

src/recommendations/events.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
---
22
group: product-recommendations
3-
title: Recommendation Events
3+
title: Data Collection for Recommendations
44
ee_only: True
55
---
66

7-
When you deploy the `magento/product-recommendations` module, the module tracks the following user events. These events enable behavioral data collection.
7+
When you install and configure SaaS-based Adobe Commerce features such as [Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) or [Live Search]({{ page.baseurl }}/live-search/install.html), the modules deploy behavioral data collection to your storefront. This mechanism collects anonymized behavioral data from your shoppers and powers product recommendations. For example, the `view` event is used to compute the `Viewed this, viewed that` recommendation type, and the `place-order` event is used to compute the `Bought this, bought that` recommendation type.
88

9-
If shoppers use ad blockers or enable privacy settings that prevent the `magento/product-recommendations` module from capturing events, the metrics reflected in the [Product Recommendations dashboard](https://docs.magento.com/user-guide/marketing/product-recommendations.html#dashboard) will not be accurate. Most likely, the engagement and revenue numbers will be underrepresented.
9+
The following events are not specific to Product Recommendations, but are required to return results:
1010

11-
{:.bs-callout-info}
12-
If [Cookie Restriction Mode](https://docs.magento.com/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.
11+
- `view`
12+
- `add-to-cart`
13+
- `place-order`
14+
15+
The [Storefront Events Collector]({{ site.baseurl }}/shared-services/storefront-event-collector.html#quick-start) lists all the events deployed to your storefront. From that list, however, there is a subset of events specific to Product Recommendations. These events collect data when shoppers interact with recommendation units on the storefront and power the metrics used to help you analyze how well your recommendations are performing.
1316

14-
Event | Category | Description
17+
Event | Description | [Used for metrics?](https://docs.magento.com/user-guide/marketing/recommendation-metrics.html)
1518
--- | --- | ---
16-
`add-to-cart` | product | A product is added to the cart
17-
`impression-render` | recommendation-unit | The recommendation unit is rendered on the page.
18-
`instant-purchase` | checkout | The customer completes an instant purchase
19-
`place-order` | checkout | The customer's order is submitted
20-
`rec-add-to-cart-click` | recommendation-unit | The customer clicks the **Add to cart** button for an item in the recommendation unit.
21-
`rec-click` | recommendation-unit | The customer clicks a product in the recommendation unit.
22-
`remove-discount-action` | shopping-cart | A discount code is removed from a cart
23-
`remove-from-cart` | product | A product is removed from a cart
24-
`view` | product | The customer views a product details page (PDP)
25-
`view` | recommendation-unit | The recommendation unit becomes viewable on the page, such as by scrolling into view
19+
`impression-render` | The recommendation unit is rendered on the page. | Yes
20+
`rec-add-to-cart-click` | The customer clicks the **Add to cart** button for an item in the recommendation unit. | Yes, when an **Add to cart** button is present in the recommendations template.
21+
`rec-click` | The customer clicks a product in the recommendation unit. | Yes
22+
`view` | The recommendation unit becomes viewable on the page, such as by scrolling into view. | Yes
23+
24+
If you are using the default Adobe Commerce storefront or [PWA](https://magento.github.io/pwa-studio/product-recs/), handling these events is done for you. If you are writing your own custom storefront, learn how you can [integrate Product Recommendations]({{ site.baseurl }}/recommendations/headless.html) into your storefront.
25+
26+
Many shoppers use ad blockers or enable privacy settings. These configurations prevent the `magento/product-recommendations` module from capturing events, which might cause the metrics in the [Product Recommendations dashboard](https://docs.magento.com/user-guide/marketing/product-recommendations.html#dashboard) to underreport engagement and revenue numbers.
27+
28+
{:.bs-callout-info}
29+
If [Cookie Restriction Mode](https://docs.magento.com/user-guide/stores/compliance-cookie-restriction-mode.html) is enabled, Adobe Commerce does not collect behavioral data until the shopper consents to using cookies. If Cookie Restriction Mode is disabled, Adobe Commerce collects behavioral data by default.

src/recommendations/headless.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,13 @@ To integrate Product Recommendations in a headless storefront you must:
1414

1515
1. Fetch product recommendation results and render those results on the page.
1616

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.
17+
You can perform both of these actions using the available SDKs as described in the following workflow.
2018

2119
1. [Install the Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) module.
2220

2321
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).
2422

25-
The minimum required events to enable Product Recommendations are:
23+
The minimum required events to return Product Recommendations results:
2624

2725
Event | Category
2826
--- | ---
-14.7 KB
Binary file not shown.

src/recommendations/test.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,7 @@ ee_only: True
66

77
Before you deploy recommendations to your production environment, you should test on a non-production environment to ensure everything is working as expected.
88

9-
Product Recommendations return products based on shopper [behavioral data]({{ page.baseurl }}/recommendations/product-recs.html#types-of-data) collected from your storefront. In a non-production environment, however, it is likely you will not have any behavioral data from shoppers. The only recommendation type you can test without behavioral data is **More like this**. This recommendation type does not require any input data, as it uses a direct content similarity match.
10-
11-
The following recommendation types require behavioral data:
12-
13-
- **Most Viewed**
14-
- **Viewed this, viewed that**
15-
- **Bought this, bought that**
9+
Product Recommendations return products based on shopper [behavioral data]({{ page.baseurl }}/recommendations/product-recs.html#types-of-data) collected from your storefront. In a non-production environment, however, it is likely you will not have any behavioral data from shoppers. The only recommendation types you can test without behavioral data are **More like this** and **Visual Similarity**. These recommendation types do not require any input data, as they use a direct content similarity match.
1610

1711
How can you test your recommendations in a non-production environment using behavioral data? There are a couple of options.
1812

@@ -41,6 +35,6 @@ See the [user guide](https://docs.magento.com/user-guide/marketing/recommendatio
4135

4236
### Caveats
4337

44-
- The non-production SaaS Data Space behavioral and catalog data identifies an isolated environment in which the resulting product recommendations will be based entirely on the behavioral data generated on the associated storefront.
38+
- The behavioral and catalog data associated with your non-production SaaS Data Space identifies an isolated environment. This results in Product Recommendations based entirely on the behavioral data generated on the associated storefront.
4539

46-
- Because you will not have large amounts of behavioral data, input data for computing product associations is sparse. However, that data is still sent to Sensei to compute the machine learning models and provide recommendations based on data you generated within this environment.
40+
- Because you will not have large amounts of behavioral data, input data for computing product associations is sparse. However, that data is still sent to Adobe Sensei to compute the machine learning models and provide recommendations based on data you generated within this environment.

src/recommendations/verify.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ A value of `Data validity : NOT FOUND` in the debugger indicates an internal sch
5555

5656
## Verify events are firing correctly
5757

58-
To verify that the events used for metrics are firing correctly, look for the `impression-render`, `view`, and `rec-click` events in the Snowplow Analytics Debugger. See the [full list of events](https://devdocs.magento.com/recommendations/events.html).
59-
60-
![Events for metrics]({{ page.baseurl }}/recommendations/images/event-metric.png)
58+
To verify that the events used for metrics are firing correctly, look for the `impression-render`, `view`, and `rec-click` events in the Snowplow Analytics Debugger. See the [full list](https://devdocs.magento.com/recommendations/events.html) of events specific to Product Recommendations.
6159

6260
{:.bs-callout-info}
6361
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.

0 commit comments

Comments
 (0)