bump version && changelog to 1.9.0

moving the procedere into one step so there's not an accidental triggering of an GA-Push-Event which at the end overwrites the View-Item-Push-Event in the cmpEvent

Application/views/admin/de/module_options.php

@@ -31,8 +31,10 @@ $aLang = [
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
     'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Cookie Manager nutzen?',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER'      => 'Nutzen Sie die Consentmanager-Einbindung?',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_NO'   => 'Nein',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_YES'  => 'Ja',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'                   => 'Nutzen Sie eine der folgenden Einbindungen?<br>
+                                                                        Dann wählen Sie bitte die zutreffende aus.',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_NONE'              => '---',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_CONSENTMANAGER'    => 'consentmanager',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_USERCENTRICS'      => 'usercentrics',
     'SHOP_MODULE_d3_gtm_settings_cookieName'  => 'CookieID',
 ];

Application/views/blocks/_gtm_nojs.tpl

@@ -1,4 +1,4 @@
-[{if $oViewConf->D3blShowGtmScript() && !$oViewConf->getCookieManagerType()}]
+[{if $oViewConf->D3blShowGtmScript()}]
     [{if $oViewConf->getGtmContainerId()}][{strip}]
     <!-- Google Tag Manager (noscript) -->
     <noscript>

Application/views/ga4/add_to_cart.tpl

@@ -1,56 +1,47 @@
 [{$smarty.block.parent}]
 
-[{assign var="d3ProductObject" value=$oView->getProduct()}]
-[{assign var="d3PriceObject" value=$d3ProductObject->getPrice()}]
+[{* variable $gtmProduct is passed from parent tempalte *}]
+[{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+[{assign var="gtmCurrency" value=$oView->getActCurrency()}]
+[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
 
 [{capture assign=d3_ga4_add_to_cart}]
-[{block name="d3_ga4_add_to_basket"}]
+  [{block name="d3_ga4_add_to_basket"}]
   $("#toBasket").click(function(event) {
+  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
 
-    [{*** Debug cases ***}]
-    [{*event.preventDefault();*}]
+  let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
 
-    let iArtQuantity = $("#amountToBasket").val();
+  [{*** Debug cases ***}]
+  [{*event.preventDefault();*}]
 
-    dataLayer.push({
-        'isAddToBasket': true,
-      'event':'add_to_cart',
-      'eventLabel': 'add_to_cart',
-      'ecommerce': {
-        'currency':   "[{$currency->name}]",
-        'value':      iArtQuantity*[{$d3PriceObject->getPrice()}],
-        'items':      [
-          {
-            'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
-            'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
-            'price':          [{$d3PriceObject->getPrice()}],
-            'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-            'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
-            'item_category':  itemCategories[0] || 'no category',
-            'item_category_2':itemCategories[1] || '',
-            'item_category_3':itemCategories[2] || '',
-            'item_category_4':itemCategories[3] || '',
-            'quantity': iArtQuantity
-          }
-        ]
+  let iArtQuantity = $("#amountToBasket").val();
+
+  dataLayer.push({
+    'isAddToBasket': true,
+    'event':'add_to_cart',
+    'eventLabel': 'add_to_cart',
+    'ecommerce': {
+      'currency':   "[{$currency->name}]",
+      'value':      iArtQuantity*[{$d3PriceObject->getPrice()}],
+      'items':      [
+        {
+        'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
+        'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
+        'price':          [{$d3PriceObject->getPrice()}],
+        'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+        'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
+        'item_category':  itemCategories[0] || 'no category',
+        'item_category_2':itemCategories[1] || '',
+        'item_category_3':itemCategories[2] || '',
+        'item_category_4':itemCategories[3] || '',
+        'quantity': iArtQuantity
+        }
+      ]
       }
     });
   });
-[{/block}]
-[{/capture}]
-[{oxscript add=$d3_ga4_add_to_cart}]
-
-[{strip}]
-    [{* variable $gtmProduct is passed from parent tempalte *}]
-
-    [{assign var="gtmCurrency" value=$oView->getActCurrency()}]
-    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-    [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-
-    <script>
-      dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-
-      let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
-
-    </script>
-[{/strip}]
+  [{/block}]
+  [{/capture}]
+[{oxscript add=$d3_ga4_add_to_cart}]

Application/views/ga4/view_item_list.tpl

@@ -1,5 +1,5 @@
 [{$smarty.block.parent}]
-[{assign var="gtmProducts" value=$products}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
 
 [{assign var="breadCrumb" value=''}]
 

CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.8.0...1.9.0) - 2023-06-19
+### Changed
+- add_to_cart event template-structure
+
+## [1.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.7.0...1.8.0) - 2023-05-31
+### Fixed
+- bug in explicit manager selection
+
+## [1.7.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.6.0...1.7.0) - 2023-05-31
+### Added
+- extended call to read the technical documentation
+### Changed
+- block-extension for view_item_list
+- way of getting list-articles in view_item_list
+
+## [1.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.5.0...1.6.0) - 2023-05-30
+### Added
+- possibility to choose between consentmanager && usercentrics
+- position to block extension
+### Changed
+- genuine code cleanup
+- usercentrics includation script
+
 ## [1.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.4.0...1.5.0) - 2023-05-23
 ### Added
 - additional settings to explicitly indicate that consentmanager is used

Docs/README.md

@@ -12,8 +12,8 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Datei: page/search/search.tpl
     - GA4 Event: view_search_results
 - Artikelliste
-    - Blockname: d3Ga4_view_item_list (muss hinzugefügt werden)
-    - Datei: widget/product/list.tpl
+    - Blockname: page_list_productlist
+    - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
     - Blockname: details_productmain_title
@@ -63,6 +63,6 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
     ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
 
 - [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
-  - In der Usercentrics-Verwaltung einen Service für Google Analytics anlegen
-  - Den Service-Namen in den Moduleinstellungen des 'Google Analytics 4' unter
+  - In der Usercentrics-Verwaltung die Services "Google Analytics" und "Google Tag Manager" anlegen
+  - Den Service ```Google Tag Manager``` in den Moduleinstellungen des 'Google Analytics 4' unter
     ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen

Modules/Core/ViewConfig.php

@@ -27,15 +27,26 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-
             $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
         }
         return $this->sContainerId;
     }
 
-    public function getModuleConsentmanagerSettingSelectValue() :bool
+    /**
+     * @return mixed
+     */
+    public function getModuleSettingExplicitManagerSelectValue()
     {
-        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_CONSENTMANAGER') === 'YES';
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
+    }
+
+    /**
+     * @return false|mixed
+     */
+    public function getExplicitManager()
+    {
+        $sManagerName = $this->getModuleSettingExplicitManagerSelectValue();
+        return $sManagerName === "NONE" ? false : $sManagerName;
     }
 
     public function getCookieManagerType()
@@ -58,13 +69,21 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
-        if ($this->sCookieManagerType === false and $this->getModuleConsentmanagerSettingSelectValue()){
-            return "consentmanager";
+        if ($this->sCookieManagerType === false and $this->getExplicitManager()){
+            return "externalService";
         }
 
         return $this->sCookieManagerType;
     }
 
+    /**
+     * @return bool
+     */
+    public function shallUseOwnCookieManager()
+    {
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
+    }
+
     /**
      * @return bool
      */
@@ -74,7 +93,7 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
 
         // No Cookie Manager in use
-        if (!$oConfig->getConfigParam('d3_gtm_settings_hasOwnCookieManager')) {
+        if (false === $this->shallUseOwnCookieManager()) {
             return true;
         }
 
@@ -95,13 +114,12 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
-        // UserCentrics
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'consentmanager') {
+        // UserCentrics or consentmanager
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
             // Always needs the script-tags delivered to the DOM.
             return true;
         }
 
-        // Cookie Manager not (yet) supported
         return false;
     }
 
@@ -114,15 +132,19 @@ class ViewConfig extends ViewConfig_parent
     {
         $oConfig = Registry::getConfig();
 
-        if ($this->getCookieManagerType() == "oxps_usercentrics") {
+        if (false === $this->shallUseOwnCookieManager()){
+            return "";
+        }
+
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
             $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
             if ($sCookieId) {
-                return 'type="text/plain" data-usercentrics="' . $sCookieId . '"';
+                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
             }
         }
 
-        if ($this->getCookieManagerType() == "consentmanager") {
+        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
             $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
             if ($sCookieId) {

README.md

@@ -30,6 +30,10 @@ Sofern nötig, bestätigen Sie bitte, dass Sie `package-name` erlauben, Code aus
 
 Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
 
+> ### Wichtig!
+> Bitte stellen Sie sicher, dass die nötigen Blöcke im OXID-Shop zur Verfügung stehen.
+> Lesen Sie mehr in der [technischen Doku](./Docs/README.md) unter "Blöcke"!
+
 ## Verwendung
 ### Grundfunktionalität
 Nach erfolgreicher Installation finden Sie in Ihrem Shop-Admin unter "Erweiterungen > Module" 

metadata.php

@@ -17,7 +17,7 @@ $aModule          = [
                       Die Entwicklung basiert auf einem Fork von Marat Bedoev - <a href='https://github.com/vanilla-thunder/oxid-module-gtm'>Github-Link</a>
                       ",
     'thumbnail'   => 'thumbnail.png',
-    'version'     => '1.5.0',
+    'version'     => '1.9.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -35,7 +35,8 @@ $aModule          = [
         [
             'template' => 'layout/base.tpl',
             'block'    => 'head_meta_robots',
-            'file'     => '/Application/views/blocks/_gtm_js.tpl'
+            'file'     => '/Application/views/blocks/_gtm_js.tpl',
+            'position' => 150
         ],
         // tag manager nojs
         [
@@ -64,8 +65,8 @@ $aModule          = [
         // Lists
         // view_item_list
         [
-            'template' => 'widget/product/list.tpl',
-            'block'    => 'widget_product_list',
+            'template' => 'page/list/list.tpl',
+            'block'    => 'page_list_productlist',
             'file'     => '/Application/views/ga4/view_item_list.tpl',
             'position' => 150
         ],
@@ -122,10 +123,10 @@ $aModule          = [
         ],
         [
             'group' => 'd3_gtm_settings_cookiemanager',
-            'name' => 'd3_gtm_settings_HAS_CONSENTMANAGER',
+            'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NO|YES',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
         ],
     ]
 ];