From f7032115960539c50bf24be90073686fe00fb7b3 Mon Sep 17 00:00:00 2001 From: Tony Date: Thu, 15 Jun 2023 00:21:19 +0200 Subject: [PATCH] Enhanced Google Analytics 4 Integration and Ecommerce Tracking Improvements (#3305) Co-authored-by: Fabrizio Balliano --- .../core/Mage/GoogleAnalytics/Block/Ga.php | 342 ++++++++++++------ .../core/Mage/GoogleAnalytics/Helper/Data.php | 35 ++ .../Mage/GoogleAnalytics/Model/Observer.php | 14 +- .../core/Mage/GoogleAnalytics/etc/system.xml | 29 ++ .../default/template/googleanalytics/ga.phtml | 3 +- app/locale/en_US/Mage_GoogleAnalytics.csv | 2 + 6 files changed, 314 insertions(+), 111 deletions(-) diff --git a/app/code/core/Mage/GoogleAnalytics/Block/Ga.php b/app/code/core/Mage/GoogleAnalytics/Block/Ga.php index 581214a3543..8ff63df5a15 100644 --- a/app/code/core/Mage/GoogleAnalytics/Block/Ga.php +++ b/app/code/core/Mage/GoogleAnalytics/Block/Ga.php @@ -55,6 +55,7 @@ public function getAccount() * Get a specific page name (may be customized via layout) * * @return string + * @deprecated */ public function getPageName() { @@ -72,11 +73,50 @@ protected function _getPageTrackingCode($accountId) { /** @var Mage_GoogleAnalytics_Helper_Data $helper */ $helper = $this->helper('googleanalytics'); - if ($helper->isUseUniversalAnalytics()) { + if ($helper->isUseAnalytics4()) { + return $this->_getPageTrackingCodeAnalytics4($accountId); + } elseif ($helper->isUseUniversalAnalytics()) { return $this->_getPageTrackingCodeUniversal($accountId); + } else { + return $this->_getPageTrackingCodeAnalytics($accountId); + } + } + + /** + * Render regular page tracking javascript code + * + * @link https://developers.google.com/tag-platform/gtagjs/reference + * @param string $accountId + * @return string + */ + protected function _getPageTrackingCodeAnalytics4($accountId) + { + $trackingCode = " +gtag('js', new Date()); +"; + if (!$this->helper('googleanalytics')->isDebugModeEnabled()) { + $trackingCode .= " +gtag('config', '{$this->jsQuoteEscape($accountId)}'); +"; + } else { + $trackingCode .= " +gtag('config', '{$this->jsQuoteEscape($accountId)}', {'debug_mode':true}); +"; + } + + //add user_id + if ($this->helper('googleanalytics')->isUserIdEnabled() && Mage::getSingleton('customer/session')->isLoggedIn()) { + $customer = Mage::getSingleton('customer/session')->getCustomer(); + $trackingCode.= " +gtag('set', 'user_id', '{$customer->getId()}'); +"; } - return $this->_getPageTrackingCodeAnalytics($accountId); + if ($this->helper('googleanalytics')->isDebugModeEnabled()) { + $this->helper('googleanalytics')->log($trackingCode); + } + + return $trackingCode; } /** @@ -192,8 +232,10 @@ protected function _getOrdersTrackingCodeUniversal() } /** + * Render information about specified orders and their items + * * @return string - * @throws Mage_Core_Model_Store_Exception + * @throws JsonException */ protected function _getOrdersTrackingCodeAnalytics4() { @@ -202,62 +244,107 @@ protected function _getOrdersTrackingCodeAnalytics4() $moduleName = $request->getModuleName(); $controllerName = $request->getControllerName(); - //purchase events - $orderIds = $this->getOrderIds(); - if (!empty($orderIds) && is_array($orderIds)) { - $collection = Mage::getResourceModel('sales/order_collection') - ->addFieldToFilter('entity_id', ['in' => $orderIds]); - /** @var Mage_Sales_Model_Order $order */ - foreach ($collection as $order) { - $orderData = [ - 'currency' => $order->getBaseCurrencyCode(), - 'transaction_id' => $order->getIncrementId(), - 'value' => number_format($order->getBaseGrandTotal(), 2), - 'coupon' => strtoupper($order->getCouponCode()), - 'shipping' => number_format($order->getBaseShippingAmount(), 2), - 'tax' => number_format($order->getBaseTaxAmount(), 2), - 'items' => [] + /** + * This event signifies that an item was removed from a cart. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#remove_from_cart + */ + $removedProducts = Mage::getSingleton('core/session')->getRemovedProductsCart(); + if ($removedProducts) { + foreach ($removedProducts as $removedProduct) { + $_removedProduct = Mage::getModel('catalog/product')->load($removedProduct); + $eventData = []; + $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); + $eventData['value'] = number_format($_removedProduct->getFinalPrice(), 2); + $eventData['items'] = []; + $_item = [ + 'item_id' => $_removedProduct->getSku(), + 'item_name' => $_removedProduct->getName(), + 'price' => number_format($_removedProduct->getFinalPrice(), 2), ]; + if ($_removedProduct->getAttributeText('manufacturer')) { + $_item['item_brand'] = $_removedProduct->getAttributeText('manufacturer'); + } + if ($_removedProduct->getCategoryIds()) { + $_lastCat = end($_removedProduct->getCategoryIds()); + $_cat = Mage::getModel('catalog/category')->load($_lastCat); + $_item['item_category'] = $_cat->getName(); + } + array_push($eventData['items'], $_item); + $result[] = "gtag('event', 'remove_from_cart', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; + } + Mage::getSingleton('core/session')->unsRemovedProductsCart(); + } - /** @var Mage_Sales_Model_Order_Item $item */ - foreach ($order->getAllVisibleItems() as $item) { - $orderData['items'][] = [ - 'item_id' => $item->getSku(), - 'item_name' => $item->getName(), - 'quantity' => $item->getQtyOrdered(), - 'price' => $item->getBasePrice(), - 'discount' => $item->getBaseDiscountAmount() - ]; + /** + * This event signifies that an item was added to a cart for purchase. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#add_to_cart + */ + $addedProducts = Mage::getSingleton('core/session')->getAddedProductsCart(); + if ($addedProducts) { + foreach ($addedProducts as $addedProduct) { + $_addedProduct = Mage::getModel('catalog/product')->load($addedProduct); + $eventData = []; + $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); + $eventData['value'] = number_format($_addedProduct->getFinalPrice(), 2); + $eventData['items'] = []; + $_item = [ + 'item_id' => $_addedProduct->getSku(), + 'item_name' => $_addedProduct->getName(), + 'price' => number_format($_addedProduct->getFinalPrice(), 2), + ]; + if ($_addedProduct->getAttributeText('manufacturer')) { + $_item['item_brand'] = $_addedProduct->getAttributeText('manufacturer'); } - $result[] = "gtag('event', 'purchase', " . json_encode($orderData, JSON_THROW_ON_ERROR) . ");"; + if ($_addedProduct->getCategoryIds()) { + $_lastCat = end($_addedProduct->getCategoryIds()); + $_cat = Mage::getModel('catalog/category')->load($_lastCat); + $_item['item_category'] = $_cat->getName(); + } + array_push($eventData['items'], $_item); + $result[] = "gtag('event', 'add_to_cart', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; + Mage::getSingleton('core/session')->unsAddedProductsCart(); } } - //Begin advanced eCommerce events - //product page + /** + * This event signifies that some content was shown to the user. Use this event to discover the most popular items viewed. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#view_item + */ if ($moduleName == 'catalog' && $controllerName == 'product') { $productViewed = Mage::registry('current_product'); + $category = Mage::registry('current_category') ? Mage::registry('current_category')->getName() : false; $eventData = []; $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); $eventData['value'] = number_format($productViewed->getFinalPrice(), 2); $eventData['items'] = []; - $eventData['items'][] = [ - 'id' => $productViewed->getSku(), - 'name' => $productViewed->getName(), + $_item = [ + 'item_id' => $productViewed->getSku(), + 'item_name' => $productViewed->getName(), 'list_name' => 'Product Detail Page', - 'brand' => $productViewed->getAttributeText('manufacturer'), - 'category' => 'Products', + 'item_category' => $category, 'price' => number_format($productViewed->getFinalPrice(), 2), ]; - + if ($productViewed->getAttributeText('manufacturer')) { + $_item['item_brand'] = $productViewed->getAttributeText('manufacturer'); + } + array_push($eventData['items'], $_item); $result[] = "gtag('event', 'view_item', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; } - //category page + /** + * Log this event when the user has been presented with a list of items of a certain category. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#view_item_list + */ elseif ($moduleName == 'catalog' && $controllerName == 'category') { $layer = Mage::getSingleton('catalog/layer'); $category = $layer->getCurrentCategory(); $productCollection = clone $layer->getProductCollection(); + $productCollection->addAttributeToSelect('sku'); + $toolbarBlock = Mage::app()->getLayout()->getBlock('product_list_toolbar'); $pageSize = $toolbarBlock->getLimit(); $currentPage = $toolbarBlock->getCurrentPage(); @@ -271,61 +358,34 @@ protected function _getOrdersTrackingCodeAnalytics4() $eventData['item_list_name'] = $category->getName(); $eventData['items'] = []; - foreach ($productCollection as $productViewed) { - $eventData['items'][] = [ - 'id' => $productViewed->getSku(), - 'name' => $productViewed->getName(), - 'list_name' => 'Product Detail Page', - 'brand' => $productViewed->getAttributeText('manufacturer'), - 'category' => 'Products', + $index = 1; + foreach ($productCollection as $key => $productViewed) { + $_item = [ + 'item_id' => $productViewed->getSku(), + 'index' => $index, + 'item_name' => $productViewed->getName(), 'price' => number_format($productViewed->getFinalPrice(), 2), ]; + if ($productViewed->getAttributeText('manufacturer')) { + $_item['item_brand'] = $productViewed->getAttributeText('manufacturer'); + } + if ($productViewed->getCategory()->getName()) { + $_item['item_category'] = $productViewed->getCategory()->getName(); + } + array_push($eventData['items'], $_item); + $index++; $eventData['value'] += $productViewed->getFinalPrice(); } $eventData['value'] = number_format($eventData['value'], 2); $result[] = "gtag('event', 'view_item_list', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; } - //cart + /** + * This event signifies that a user viewed his cart. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#view_cart + */ elseif ($moduleName == 'checkout' && $controllerName == 'cart') { - $removedProduct = Mage::getSingleton('core/session')->getRemovedProductCart(); - if ($removedProduct) { - $_removedProduct = Mage::getModel('catalog/product')->load($removedProduct); - $eventData = []; - $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); - $eventData['value'] = number_format($_removedProduct->getFinalPrice(), 2); - $eventData['items'] = []; - $eventData['items'][] = [ - 'id' => $_removedProduct->getSku(), - 'name' => $_removedProduct->getName(), - 'list_name' => 'Product Detail Page', - 'brand' => $_removedProduct->getAttributeText('manufacturer'), - 'category' => 'Products', - 'price' => number_format($_removedProduct->getFinalPrice(), 2), - ]; - $result[] = "gtag('event', 'remove_from_cart', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; - Mage::getSingleton('core/session')->unsRemovedProductCart(); - } - - $addedProduct = Mage::getSingleton('core/session')->getAddedProductCart(); - if ($addedProduct) { - $_addedProduct = Mage::getModel('catalog/product')->load($addedProduct); - $eventData = []; - $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); - $eventData['value'] = number_format($_addedProduct->getFinalPrice(), 2); - $eventData['items'] = []; - $eventData['items'][] = [ - 'id' => $_addedProduct->getSku(), - 'name' => $_addedProduct->getName(), - 'list_name' => 'Product Detail Page', - 'brand' => $_addedProduct->getAttributeText('manufacturer'), - 'category' => 'Products', - 'price' => number_format($_addedProduct->getFinalPrice(), 2), - ]; - $result[] = "gtag('event', 'add_to_cart', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; - Mage::getSingleton('core/session')->unsAddedProductCart(); - } - $productCollection = Mage::getSingleton('checkout/session')->getQuote()->getAllVisibleItems(); $eventData = []; $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); @@ -333,41 +393,109 @@ protected function _getOrdersTrackingCodeAnalytics4() $eventData['items'] = []; foreach ($productCollection as $productInCart) { - $eventData['items'][] = [ - 'id' => $productInCart->getSku(), - 'name' => $productInCart->getName(), - 'list_name' => 'Product Detail Page', - 'brand' => $productInCart->getAttributeText('manufacturer'), - 'category' => 'Products', - 'price' => number_format($productInCart->getFinalPrice(), 2), + $_product = Mage::getModel('catalog/product')->load($productInCart->getProductId()); + $_item = [ + 'item_id' => $_product->getSku(), + 'item_name' => $_product->getName(), + 'price' => number_format($_product->getFinalPrice(), 2), ]; - $eventData['value'] += $productInCart->getFinalPrice(); + if ($_product->getAttributeText('manufacturer')) { + $_item['item_brand'] = $_product->getAttributeText('manufacturer'); + } + if ($_product->getCategoryIds()) { + $_lastCat = end($_product->getCategoryIds()); + $_cat = Mage::getModel('catalog/category')->load($_lastCat); + $_item['item_category'] = $_cat->getName(); + } + array_push($eventData['items'], $_item); + $eventData['value'] += $_product->getFinalPrice(); } $eventData['value'] = number_format($eventData['value'], 2); $result[] = "gtag('event', 'view_cart', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; } - //begin checkout + /** + * This event signifies that a user has begun a checkout. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events#begin_checkout + */ elseif ($moduleName == 'checkout' && $controllerName == 'onepage') { $productCollection = Mage::getSingleton('checkout/session')->getQuote()->getAllVisibleItems(); - $eventData = []; - $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); - $eventData['value'] = 0.00; - $eventData['items'] = []; + if ($productCollection) { + $eventData = []; + $eventData['currency'] = Mage::app()->getStore()->getCurrentCurrencyCode(); + $eventData['value'] = 0.00; + $eventData['items'] = []; + foreach ($productCollection as $productInCart) { + $_product = Mage::getModel('catalog/product')->load($productInCart->getProductId()); + $_item = [ + 'item_id' => $_product->getSku(), + 'item_name' => $_product->getName(), + 'price' => number_format($_product->getFinalPrice(), 2), + ]; + if ($_product->getAttributeText('manufacturer')) { + $_item['item_brand'] = $_product->getAttributeText('manufacturer'); + } + if ($_product->getCategoryIds()) { + $_lastCat = end($_product->getCategoryIds()); + $_cat = Mage::getModel('catalog/category')->load($_lastCat); + $_item['item_category'] = $_cat->getName(); + } + array_push($eventData['items'], $_item); + $eventData['value'] += $_product->getFinalPrice(); + } + $eventData['value'] = number_format($eventData['value'], 2); + $result[] = "gtag('event', 'begin_checkout', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; + } + } - foreach ($productCollection as $productInCart) { - $eventData['items'][] = [ - 'id' => $productInCart->getSku(), - 'name' => $productInCart->getName(), - 'list_name' => 'Product Detail Page', - 'brand' => $productInCart->getAttributeText('manufacturer'), - 'category' => 'Products', - 'price' => number_format($productInCart->getFinalPrice(), 2), + /** + * This event signifies when one or more items is purchased by a user. + * + * @link https://developers.google.com/tag-platform/gtagjs/reference/events?hl=it#purchase + */ + $orderIds = $this->getOrderIds(); + if (!empty($orderIds) && is_array($orderIds)) { + $collection = Mage::getResourceModel('sales/order_collection') + ->addFieldToFilter('entity_id', ['in' => $orderIds]); + /** @var Mage_Sales_Model_Order $order */ + foreach ($collection as $order) { + $orderData = [ + 'currency' => $order->getBaseCurrencyCode(), + 'transaction_id' => $order->getIncrementId(), + 'value' => number_format($order->getBaseGrandTotal(), 2), + 'coupon' => strtoupper($order->getCouponCode()), + 'shipping' => number_format($order->getBaseShippingAmount(), 2), + 'tax' => number_format($order->getBaseTaxAmount(), 2), + 'items' => [] ]; - $eventData['value'] += $productInCart->getFinalPrice(); + + /** @var Mage_Sales_Model_Order_Item $item */ + foreach ($order->getAllVisibleItems() as $item) { + $_item = [ + 'item_id' => $item->getSku(), + 'item_name' => $item->getName(), + 'quantity' => $item->getQtyOrdered(), + 'price' => $item->getBasePrice(), + 'discount' => $item->getBaseDiscountAmount() + ]; + $_product = Mage::getModel('catalog/product')->load($item->getProductId()); + if ($_product->getAttributeText('manufacturer')) { + $_item['item_brand'] = $_product->getAttributeText('manufacturer'); + } + if ($_product->getCategoryIds()) { + $_lastCat = end($_product->getCategoryIds()); + $_cat = Mage::getModel('catalog/category')->load($_lastCat); + $_item['item_category'] = $_cat->getName(); + } + array_push($orderData['items'], $_item); + } + $result[] = "gtag('event', 'purchase', " . json_encode($orderData, JSON_THROW_ON_ERROR) . ");"; } - $eventData['value'] = number_format($eventData['value'], 2); - $result[] = "gtag('event', 'begin_checkout', " . json_encode($eventData, JSON_THROW_ON_ERROR) . ");"; + } + + if ($this->helper('googleanalytics')->isDebugModeEnabled() && count($result) > 0) { + $this->helper('googleanalytics')->log($result); } return implode("\n", $result); } diff --git a/app/code/core/Mage/GoogleAnalytics/Helper/Data.php b/app/code/core/Mage/GoogleAnalytics/Helper/Data.php index 7cb92cf7528..237d2c2b0ff 100644 --- a/app/code/core/Mage/GoogleAnalytics/Helper/Data.php +++ b/app/code/core/Mage/GoogleAnalytics/Helper/Data.php @@ -28,6 +28,8 @@ class Mage_GoogleAnalytics_Helper_Data extends Mage_Core_Helper_Abstract public const XML_PATH_TYPE = 'google/analytics/type'; public const XML_PATH_ACCOUNT = 'google/analytics/account'; public const XML_PATH_ANONYMIZATION = 'google/analytics/anonymization'; + public const XML_PATH_DEBUG = 'google/analytics/debug'; + public const XML_PATH_USERID = 'google/analytics/user_id'; /** * @var string google analytics 4 @@ -104,4 +106,37 @@ public function isUseAnalytics4($store = null) { return Mage::getStoreConfig(self::XML_PATH_TYPE, $store) == self::TYPE_ANALYTICS4; } + + /** + * Whether GA Debug Mode is enabled (only for development IP) + * + * @param null $store + * @return bool + */ + public function isDebugModeEnabled($store = null) + { + return Mage::getStoreConfigFlag(self::XML_PATH_DEBUG, $store) && Mage::helper('core')->isDevAllowed(); + } + + /** + * Log debug message + * + * @param string $message + */ + public function log($message = null) + { + $filename = sprintf('google%s.log', Mage::getStoreConfig(self::XML_PATH_TYPE)); + Mage::log($message, Zend_Log::DEBUG, $filename, true); + } + + /** + * Whether GA IP Anonymization is enabled + * + * @param null $store + * @return bool + */ + public function isUserIdEnabled($store = null) + { + return Mage::getStoreConfigFlag(self::XML_PATH_USERID, $store); + } } diff --git a/app/code/core/Mage/GoogleAnalytics/Model/Observer.php b/app/code/core/Mage/GoogleAnalytics/Model/Observer.php index 667241f6f59..772312819f5 100644 --- a/app/code/core/Mage/GoogleAnalytics/Model/Observer.php +++ b/app/code/core/Mage/GoogleAnalytics/Model/Observer.php @@ -59,7 +59,10 @@ public function removeItemFromCartGoogleAnalytics(Varien_Event_Observer $observe { $productRemoved = $observer->getEvent()->getQuoteItem()->getProduct(); if ($productRemoved) { - Mage::getSingleton('core/session')->setRemovedProductCart($productRemoved->getId()); + $_removedProducts = Mage::getSingleton('core/session')->getRemovedProductsCart() ?: []; + $_removedProducts[] = $productRemoved->getId(); + $_removedProducts = array_unique($_removedProducts); + Mage::getSingleton('core/session')->setRemovedProductsCart($_removedProducts); } } @@ -72,7 +75,14 @@ public function addItemToCartGoogleAnalytics(Varien_Event_Observer $observer) { $productAdded = $observer->getEvent()->getQuoteItem()->getProduct(); if ($productAdded) { - Mage::getSingleton('core/session')->setAddedProductCart($productAdded->getId()); + // Fix double add to cart for configurable products, skip child product + if ($productAdded->getParentProductId()) { + return; + } + $_addedProducts = Mage::getSingleton('core/session')->getAddedProductsCart() ?: []; + $_addedProducts[] = $productAdded->getParentItem() ? $productAdded->getParentItem()->getId() : $productAdded->getId(); + $_addedProducts = array_unique($_addedProducts); + Mage::getSingleton('core/session')->setAddedProductsCart($_addedProducts); } } } diff --git a/app/code/core/Mage/GoogleAnalytics/etc/system.xml b/app/code/core/Mage/GoogleAnalytics/etc/system.xml index 64120809aa6..9631f0fe728 100644 --- a/app/code/core/Mage/GoogleAnalytics/etc/system.xml +++ b/app/code/core/Mage/GoogleAnalytics/etc/system.xml @@ -57,6 +57,32 @@ 1 1 + + + select + adminhtml/system_config_source_yesno + 21 + 1 + 1 + 1 + Enable GA4 User_id tracking for logged in customers. + + analytics4 + + + + + select + adminhtml/system_config_source_yesno + 22 + 1 + 1 + 1 + Enable GA4 Debug Real Time view for Development IP. + + analytics4 + + select @@ -65,6 +91,9 @@ 1 1 1 + + universal + diff --git a/app/design/frontend/base/default/template/googleanalytics/ga.phtml b/app/design/frontend/base/default/template/googleanalytics/ga.phtml index 08762b3195b..d0a3fab571b 100644 --- a/app/design/frontend/base/default/template/googleanalytics/ga.phtml +++ b/app/design/frontend/base/default/template/googleanalytics/ga.phtml @@ -25,8 +25,7 @@ $_accountId = $_helper->getAccountId(); diff --git a/app/locale/en_US/Mage_GoogleAnalytics.csv b/app/locale/en_US/Mage_GoogleAnalytics.csv index 1b90846f791..54b35787571 100644 --- a/app/locale/en_US/Mage_GoogleAnalytics.csv +++ b/app/locale/en_US/Mage_GoogleAnalytics.csv @@ -6,3 +6,5 @@ "Type","Type" "Universal Analytics","Universal Analytics" "Google Analytics 4","Google Analytics 4" +"Enable GA4 User_id tracking for logged in customers.","Enable GA4 User_id tracking for logged in customers." +"Enable GA4 Debug Real Time view for Development IP.","Enable GA4 Debug Real Time view for Development IP." \ No newline at end of file