updates POC, adds integration_key

Author: cykolln

Block/Catalog/Product/ViewedProduct.php

@@ -2,8 +2,8 @@
 
 namespace Klaviyo\Reclaim\Block\Catalog\Product;
 
-use Klaviyo\Reclaim\Helper\Logger;
 use Klaviyo\Reclaim\Helper\ScopeSetting;
+use Klaviyo\Reclaim\Helper\Data;
 use Magento\Catalog\Helper\Image;
 use Magento\Framework\Registry;
 use Magento\Framework\View\Element\Template;
@@ -16,12 +16,7 @@ class ViewedProduct extends Template
     protected $imageUrl = null;
     protected $categories = [];
     protected $price = 0;
-
-    /**
-     * Klaviyo Logger
-     * @var Logger
-     */
-    protected $_klaviyoLogger;
+    const INTEGRATION_KEY = 'magento_two';
 
     /**
      * @var Magento\Catalog\Helper\Image
@@ -32,25 +27,24 @@ class ViewedProduct extends Template
      * ViewedProduct constructor.
      * @param Context $context
      * @param ScopeSetting $klaviyoScopeSetting
-     * @param Logger $klaviyoLogger
      * @param Registry $registry
      * @param Image $imageHelper
+     * @param Data $dataHelper
      * @param array $data
      */
     public function __construct(
         Context $context,
         ScopeSetting $klaviyoScopeSetting,
-        Logger $klaviyoLogger,
         Registry $registry,
         Image $imageHelper,
+        Data $dataHelper,
         array $data = []
     ) {
-//        $this->_storeManager = $context->getStoreManager();
         parent::__construct($context, $data);
-        $this->_klaviyoLogger = $klaviyoLogger;
         $this->_klaviyoScopeSetting = $klaviyoScopeSetting;
         $this->_registry = $registry;
         $this->imageHelper = $imageHelper;
+        $this->_dataHelper = $dataHelper;
     }
 
     /**
@@ -202,11 +196,16 @@ protected function _toHtml()
      */
     public function getViewedProductJson()
     {
-        $external_catalog_id = $this->_storeManager->getStore()->getWebsiteId() . '-' . $this->_storeManager->getStore()->getId();
+        $external_catalog_id = $this->_dataHelper->getExternalCatalogIdForEvent(
+            $this->_storeManager->getStore()->getWebsiteId(),
+            $this->_storeManager->getStore()->getId()
+        );
+
         $_product = $this->getProduct();
 
         $result = [
             'external_catalog_id' => $external_catalog_id,
+            'integration_key' => self::INTEGRATION_KEY,
             'ProductID' => $_product->getId(),
             'Name' => $_product->getName(),
             'SKU' => $_product->getSku(),

Helper/Data.php

@@ -185,4 +185,17 @@ public function klaviyoTrackEvent($event, $customer_properties = [], $properties
         $api = new KlaviyoV3Api($this->_klaviyoScopeSetting->getPublicApiKey($storeId), $this->_klaviyoScopeSetting->getPrivateApiKey($storeId), $this->_klaviyoScopeSetting, $this->_klaviyoLogger);
         return $api->track($params);
     }
+
+    /**
+     * Get the external catalog ID for an event. This is used to link events to a specific scoped catalog in Klaviyo, so that
+     * profile interest events can be connected to a specific scoped product when building flow audiences.
+     *
+     * @param int $website_id
+     * @param int $store_id
+     * @return string
+     */
+    public function getExternalCatalogIdForEvent($website_id, $store_id)
+    {
+        return $website_id . '-' . $store_id;
+    }
 }

KlaviyoV3Sdk/KlaviyoV3Api.php

@@ -68,8 +68,6 @@ class KlaviyoV3Api
     const PROFILES_PAYLOAD_KEY = 'profiles';
     const CUSTOM_SOURCE_PAYLOAD_KEY = 'custom_source';
     const MAGENTO_TWO_PAYLOAD_VALUE = 'Magento Two';
-    const MAGENTO_TWO_INTEGRATION_SERVICE_KEY = 'magentotwo';
-    const SERVICE_PAYLOAD_KEY = 'service';
 
     /**
      * @var string
@@ -396,8 +394,7 @@ public function buildEventProperties($eventProperties, $time, $metric)
                 self::DATA_KEY_PAYLOAD => array(
                     self::TYPE_KEY_PAYLOAD => self::METRIC_KEY_PAYLOAD,
                     self::ATTRIBUTE_KEY_PAYLOAD => array(
-                        self::NAME_KEY_PAYLOAD => $metric,
-                        self::SERVICE_PAYLOAD_KEY => self::MAGENTO_TWO_INTEGRATION_SERVICE_KEY
+                        self::NAME_KEY_PAYLOAD => $metric
                     )
                 )
             )

Observer/SalesQuoteSaveAfter.php

@@ -14,6 +14,7 @@ class SalesQuoteSaveAfter implements ObserverInterface
 {
     // Character limit for a TEXT datatype field
     const PAYLOAD_CHARACTER_LIMIT = 65535;
+    const INTEGRATION_KEY = 'magento_two';
 
     /**
      * Klaviyo Scope setting Helper
@@ -100,8 +101,10 @@ public function execute(Observer $observer)
         // Setting StoreId in payload
         $klAddedToCartPayload['StoreId'] = $quote->getStoreId();
 
-        // Setting external_catalog_id in payload - this connects the event to the right localized product in the klaviyo catalog and should not be changed
-        $klAddedToCartPayload['external_catalog_id'] =  $quote->getStore()->getWebsiteId() . '-' . $quote->getStoreId();
+        // Setting external_catalog_id in payload - this connects the event to the right localized product in the klaviyo catalog.
+        $klAddedToCartPayload['external_catalog_id'] = $this->_dataHelper->getExternalCatalogIdForEvent($quote->getStore()->getWebsiteId(), $quote->getStoreId());
+
+        $klAddedToCartPayload['integration_key'] = self::INTEGRATION_KEY;
 
         $stringifiedPayload = json_encode($klAddedToCartPayload);