202406 update viewed product

CHANGELOG.md

@@ -12,6 +12,10 @@ bumped for multiple releases during one month.
 
 #### Added
 - Added `siteID` key/value to client-side events
+- New `ProductID` field to Viewed Product events
+
+### Changed
+- Excludes Viewed Product and Add/Added to Cart events from optional event branded available in site configuration. This is to make sure that Klaviyo's internal recommendation engine will pick up these events for Recommendation product feeds.
 
 ### [24.1.0] - 2024-01-18
 

cartridges/int_klaviyo_core/cartridge/scripts/klaviyo/eventData/viewedProduct.js

@@ -26,6 +26,7 @@ function getData(productID) {
 
         data['SiteID'] = siteId;
         data['Product ID'] = product.ID;
+        data['ProductID'] = product.ID; // additive field to allow compatability with Viewed Product Recommendations
         data['Product Name'] = product.name;
         data['Product Page URL'] = URLUtils.https('Product-Show', 'pid', product.ID).toString();
         data['Product Image URL'] = product.getImage(KLImageSize).getAbsURL().toString();

cartridges/int_klaviyo_core/cartridge/scripts/klaviyo/utils.js

@@ -27,6 +27,13 @@ var EVENT_NAMES = {
 if (Site.getCurrent().getCustomPreferenceValue('klaviyo_atc_override')) {
     EVENT_NAMES.addedToCart = 'Add To Cart';
 }
+// events that can be branded if the klaviyo_sendEventsAsSFCC site preference is set
+var BRANDED_EVENTS_NAMES = [
+    EVENT_NAMES.viewedCategory,
+    EVENT_NAMES.searchedSite,
+    EVENT_NAMES.startedCheckout,
+    EVENT_NAMES.orderConfirmation
+];
 
 var klaviyoEnabled = Site.getCurrent().getCustomPreferenceValue('klaviyo_enabled') || false;
 var KLImageSize = Site.getCurrent().getCustomPreferenceValue('klaviyo_image_size') || 'large';
@@ -186,7 +193,7 @@ function trackEvent(exchangeID, data, event, customerEmail) {
         this site that did not label events with SFCC as provider there will be a break in reporting and functionality between past events that were not
         labelled with SFCC as provider and the new events that are.  If in doubt, leave the site preference set to No and contact Klaviyo technical support.
     */
-    if (Site.getCurrent().getCustomPreferenceValue('klaviyo_sendEventsAsSFCC')) {
+    if (Site.getCurrent().getCustomPreferenceValue('klaviyo_sendEventsAsSFCC') && BRANDED_EVENTS_NAMES.includes(event)) {
         metricObj.service = 'demandware';
     }
 

test/src/tests/unit/viewed-product.test.js

@@ -99,6 +99,7 @@ describe('int_klaviyo_core/cartridge/scripts/klaviyo/eventData => viewedProduct'
             {
                 "SiteID": "KlaviyoSFRA",
                 "Product ID": 'NG3614270264405',
+                "ProductID": 'NG3614270264405',
                 "Product Name": 'Belle de Teint',
                 "Product Page URL": "https://production-sitegenesis-dw.demandware.net/s/RefArch/home?lang=en_US",
                 "Product Image URL": "https://sforce.co/43Pig4s",

test/src/utils/v3-api-helper.mjs

@@ -1,12 +1,15 @@
 import fetch from 'node-fetch'
 import * as dotenv from 'dotenv'
+import { should } from 'chai'
 
 dotenv.config()
 
 const { KLAVIYO_SFRA_PRIVATE_KEY, KLAVIYO_SITEGEN_PRIVATE_KEY, KLAVIYO_V3_URL } = process.env
 
 const apiEndpoint = `https://${KLAVIYO_V3_URL}`
 const metricsEndpoint = '/metrics/'
+const eventsEndpoint = '/events/'
+const sortFilter = '?sort=-datetime'
 
 const sfraOpts = {
   method: 'GET',
@@ -26,37 +29,25 @@ const sgOpts = {
   },
 }
 
-let sfIntegrations
+let integrationData
 
 const getLatestMetricId = async () => {
-  const metricsFilter = '?fields[metric]=integration'
-  const integrationName = 'Salesforce Commerce Cloud'
-  const endpoint = `${apiEndpoint}${metricsEndpoint}${metricsFilter}`
+  let endpoint = `${apiEndpoint}${eventsEndpoint}${sortFilter}`
 
   try {
     const response = await fetch(endpoint, sfraOpts)
     const body = await response.json()
-    const data = body.data
-    sfIntegrations = data.filter(
-      (integration) => integration.attributes.integration.name === integrationName
-    )
+    integrationData = body.data
+
   } catch {
     const response = await fetch(endpoint, sgOpts)
     const body = await response.json()
-    const data = body.data
-    sfIntegrations = data.filter(
-      (integration) => integration.attributes.integration.name === integrationName
-    )
+    integrationData = body.data
   }
+    const firstMetric = integrationData[0]
+    const metricData = firstMetric.relationships.metrics.data[0]
 
-  const mostRecentMetric = await sfIntegrations.reduce((latest, current) => {
-      const latestDate = new Date(latest.attributes.created)
-      const currentDate = new Date(current.attributes.created)
-
-      return latestDate > currentDate ? latest : current
-  })
-
-  return mostRecentMetric.id
+  return metricData.id
 }
 
 const getLatestMetricData = async (id) => {