@adobe/commerce-events-collectors NPM

Magento Storefront Event Collector

Overview

This package listens for and handles events published by the Magento Storefront Events SDK to the adobeDataLayeracdl. It runs as a side effect and is meant to be a convenience for users who want to send event data to Adobe Commerce.

Installation

The collector can be used as a hosted script, or bundled in a JavaScript application. The script version is hosted on unpkg, and the bundled version is hosted on npm.

To load the SDK as a script, use the following snippet.

<script src="https://unpkg.com/@adobe/magento-storefront-event-collector/dist/index.js"></script>

To install the script as a dependency, run this command.

npm install @adobe/magento-storefront-event-collector

Quick start

After loading the collector script, or importing the package as shown below, there is nothing else that needs to be done.

import "@adobe/magento-storefront-event-collector";

Usage

The collector listens for the following events.

pageView
addToCart
productPageView
shoppingCartView
initiateCheckout
placeOrder
abandonCart
recsItemAddToCartClick
recsItemClick
recsRequestSent
recsResponseReceived
recsUnitRender
recsUnitView
searchCategoryClick
searchProductClick
searchRequestSent
searchResponseReceived
searchResultsView
searchSuggestionClick
createAccount
editAccount
signIn
signOut
custom

The handlers forward events to two edges:

Adobe Commerce Data Services (maintained by Adobe Engineering and used to power merchant performance dashboards)
Required contexts:
StorefrontInstance
Events not forwarded to Adobe Commerce:
createAccount
editAccount
signIn
signOut
custom
Adobe Experience Platform (AEP) (requires a subscription and additional merchant setup; data can be used by merchants inside the Adobe Experience Platform for detailed analytics, targeted merchandising, real time customer data profiles, and more)
Required contexts:
AEP
EventForwarding.aep: true
Events not forwarded to AEP Edge:
recsItemAddToCartClick
recsItemClick
recsRequestSent
searchResponseReceived
searchCategoryClick
searchProductClick
searchResultsView
searchSuggestionClick

Turning off collection per edge

Events are sent to Adobe Commerce Data Services by default. To turn collection off collection, set EventForwarding.commerce: false.

Events are not set to AEP Edge unless explicitly configured (EventForwarding.aep: true);

Handling custom events

Custom events are supported for the Adobe Experience Platform only. Custom data will not be forwarded to Adobe Commerce dashboards and metrics trackers.

For any custom event, the collector adds a personId (ecid) to customContext and wraps an xdm object around it before forwarding to the Edge.

Example:

Custom event published through MSE SDK:

mse.publish.custom({
    customContext: { customStrAttr: "cheetah", customNumAttr: 128 },
});

In AEP Edge:

{
    xdm: {
        personId: 'ecid1234',
        customStrAttr: 'cheetah',
        customNumAttr: 128
    }
}

note Using custom events may affect OOTB Adobe Analytics reports.

Handling event overrides (custom attributes)

Attribute overrides for standard events are supported for the Experience Platform only. Custom data will not be forwarded to Commerce dashboards and metrics trackers.

For any event with a set customContext, the collector overrides personId and Adobe Analytics counters, and forwards all other attributes set in customContext.

Examples:

Product view with overrides published though MSE SDK:

mse.publish.productPageView({
    customContext: { customCode: "okapi" },
});

In AEP Edge:

{
    xdm: {
        eventType: 'commerce.productViews',
        personId: 'ecid1234',
        customCode: 'okapi',
        commerce: {
            productViews: {
                value : 1
            }
        }
    }
}

Product view with Adobe Commerce overrides published though MSE SDK:

mse.publish.productPageView({
    customContext: { commerce: { customCode: "mongoose" } },
});

In AEP Edge:

{
    xdm: {
        eventType: 'commerce.productViews',
        personId: 'ecid1234',
        commerce: {
            customCode: 'mongoose',
            productViews: {
                value : 1
            }
        }
    }
}

Note Overriding events with custom attributes may affect OOTB Adobe Analytics reports.

Shopper Consent and Data Collection Opt out

The "mg_dnt" cookie is used by Product Recommendations to restrict data collection.

when the cookie restriction mode is enabled, data services will set the "mg_dnt" cookie to true.

const listenForCookieEvents = $ => {
    const DNT_COOKIE = "mg_dnt";
    let userAllowedSaveCookie = !!$.mage.cookies.get(
        "user_allowed_save_cookie",
    );

    if (userAllowedSaveCookie) {
        $.mage.cookies.clear(DNT_COOKIE);
    } else {
        $.mage.cookies.set(DNT_COOKIE, true);
    }
};

By default, the user consent preference in AEP is set to "opt in", unless the cookie restriction mode is enabled and the "mg_dnt" cookie is present.

The script will keep polling to check for any changes and send the updated preference to AEP.

const doNotTrackCookie = document.cookie.indexOf("mg_dnt") !== -1;
alloy("setConsent", {
    consent: [
        {
            standard: "Adobe",
            version: "1.0",
            value: {
                general: doNotTrackCookie ? "out" : "in",
            },
        },
    ],
});
setInterval(setConsent, 1000);