bump version && changelog to 1.9.0

[rework] change structure of GA-event
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
2023-06-19 14:50:34 +02:00 · 2023-06-19 11:34:45 +02:00 · 2023-05-31 14:22:11 +02:00 · 2023-05-31 14:11:50 +02:00 · 2023-05-31 10:29:49 +02:00 · 2023-05-31 10:28:19 +02:00
16 changed files with 304 additions and 213 deletions
--- a/Application/views/admin/de/module_options.php
+++ b/Application/views/admin/de/module_options.php
@ -1,16 +1,13 @@
 <?php
-
 /**
- * This Software is the property of Data Development and is protected
- * by copyright law - it is NOT Freeware.
- * Any unauthorized use of this software without a valid license
- * is a violation of the license agreement and will be prosecuted by
- * civil and criminal law.
- * http://www.shopmodule.com
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * https://www.d3data.de
 *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author        D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * @link          http://www.oxidmodule.com
+ * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+ * @link      https://www.oxidmodule.com
 */

 $style = '<style type="text/css">
@ -34,5 +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_cookieName'            => 'CookieID',
+    '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',
 ];
--- a/Application/views/blocks/_gtm_js.tpl
+++ b/Application/views/blocks/_gtm_js.tpl
@ -1,40 +1,12 @@
-[{assign var="d3VtConfigObject" value=$oViewConf->getConfig()}]
-[{if $d3VtConfigObject->getConfigParam('d3_gtm_settings_hasOwnCookieManager')}]
-    [{if $oViewConf->D3blAcceptedCookie($d3VtConfigObject->getConfigParam('d3_gtm_settings_cookieName'))}]
+[{* Always prepare the data layer to avoid errors *}]
+<script>
+  var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
+</script>

-        [{if $oViewConf->getGtmContainerId()}][{strip}]
-        <!-- Google Tag Manager -->
-        <script>
-          var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
-          (function (w, d, s, l, i) {
-            w[l] = w[l] || [];
-            w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
-            var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : '';
-            j.async = true;
-            j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
-            f.parentNode.insertBefore(j, f);
-          })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
-        </script>
-        <!-- End Google Tag Manager -->
-        [{if $oViewConf->getTopActionClassName() === "alist" }]
-        [{* include file="ga4_view_item_list.tpl" gtmCategory=$oView->getActiveCategory() gtmProducts=$oView->getArticleList() listtype=$oView->getListType() *}]
-        [{elseif $oViewConf->getTopActionClassName() === "details" }]
-        [{* include file="ga4_view_item.tpl" gtmProduct=$oView->getProduct() *}]
-        [{elseif $oViewConf->getTopActionClassName() === "search" }]
-        [{elseif $oViewConf->getTopActionClassName() === "basket" }]
-
-        [{/if}]
-        [{/strip}][{/if}]
-    [{else}]
-    <script>
-      var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
-    </script>
-    [{/if}]
-[{else}]
+[{if $oViewConf->D3blShowGtmScript()}]
    [{if $oViewConf->getGtmContainerId()}][{strip}]
    <!-- Google Tag Manager -->
-    <script>
-      var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
+    <script [{$oViewConf->getGtmScriptAttributes()}]>
      (function (w, d, s, l, i) {
        w[l] = w[l] || [];
        w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
@ -45,15 +17,15 @@
      })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
    </script>
    <!-- End Google Tag Manager -->
+
    [{if $oViewConf->getTopActionClassName() === "alist" }]
    [{* include file="ga4_view_item_list.tpl" gtmCategory=$oView->getActiveCategory() gtmProducts=$oView->getArticleList() listtype=$oView->getListType() *}]
    [{elseif $oViewConf->getTopActionClassName() === "details" }]
    [{* include file="ga4_view_item.tpl" gtmProduct=$oView->getProduct() *}]
    [{elseif $oViewConf->getTopActionClassName() === "search" }]
    [{elseif $oViewConf->getTopActionClassName() === "basket" }]
-
    [{/if}]
    [{/strip}][{/if}]
-[{/if}]
+    [{/if}]

-[{$smarty.block.parent}]
+[{$smarty.block.parent}]
--- a/Application/views/blocks/_gtm_nojs.tpl
+++ b/Application/views/blocks/_gtm_nojs.tpl
@ -1,8 +1,12 @@
-[{if $oViewConf->getGtmContainerId()}][{strip}]
+[{if $oViewConf->D3blShowGtmScript()}]
+    [{if $oViewConf->getGtmContainerId()}][{strip}]
    <!-- Google Tag Manager (noscript) -->
    <noscript>
        <iframe src="https://www.googletagmanager.com/ns.html?id=[{$oViewConf->getGtmContainerId()}]"
                height="0" width="0" style="display:none;visibility:hidden"></iframe>
    </noscript>
-    <!-- End Google Tag Manager (noscript) -->[{/strip}][{/if}]
+<!-- End Google Tag Manager (noscript) -->
+    [{/strip}][{/if}]
+    [{/if}]
+
 [{$smarty.block.parent}]
--- a/Application/views/blocks/checkout_s1.tpl
+++ b/Application/views/blocks/checkout_s1.tpl
@ -2,10 +2,10 @@

 [{*$oxcmp_basket|get_class_methods|dumpvar*}]

+[{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
+
 [{assign var='gtmCartArticles' value=$oView->getBasketArticles()}]
 [{strip}][{capture assign=d3_ga4_view_cart}]
-    let iPrice = "[{oxprice price=$oxcmp_basket->getPrice()}]";
-
    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
    dataLayer.push({
        'event': 'view_cart',
@ -13,15 +13,15 @@
        'ecommerce': {
            'actionField': "step: 1",
            'currency': "[{$currency->name}]",
-            'value': iPrice.replace("€", ""),
+            'value': [{$d3BasketPrice->getPrice()}],
            'items': [
                [{foreach from=$oxcmp_basket->getContents() item=basketitem name=gtmCartContents  key=basketindex}]
-                [{assign var='_price' value=$basketitem->getUnitPrice()}]
+                [{assign var="d3oItemPrice" value=$basketitem->getPrice()}]
                {
-                    'item_id': '[{$gtmCartArticles[$basketindex]->oxarticles__oxartnum->value}]',
-                    'item_name': '[{$gtmCartArticles[$basketindex]->oxarticles__oxtitle->value}]',
-                    'item_variant': '[{$gtmCartArticles[$basketindex]->oxarticles__oxvarselect->value}]',
-                    'price': [{$_price->getPrice()}],
+                    'item_id': '[{$gtmCartArticles[$basketindex]->getFieldData('oxartnum')}]',
+                    'item_name': '[{$gtmCartArticles[$basketindex]->getFieldData('oxtitle')}]',
+                    'item_variant': '[{$gtmCartArticles[$basketindex]->getFieldData('oxvarselect')}]',
+                    'price': [{$d3oItemPrice->getPrice()}],
                    'quantity':[{$basketitem->getAmount()}],
                    'position':[{$smarty.foreach.gtmCartContents.index}]
                }[{if !$smarty.foreach.gtmCartContents.last}],[{/if}]
--- a/Application/views/blocks/checkout_s5.tpl
+++ b/Application/views/blocks/checkout_s5.tpl
@ -10,21 +10,22 @@
        'event': 'purchase',
        'eventLabel':'Checkout Step 5',
        'ecommerce': {
-          'transaction_id': '[{$_gtmOrder->oxorder__oxordernr->value}]',
-          'affiliation':    '[{$oxcmp_shop->oxshops__oxname->value}]',
-          'value':          '[{$_gtmOrder->oxorder__oxtotalordersum->value}]',
-          'tax':            '[{math equation="x+y" x=$_gtmOrder->oxorder__oxartvatprice1->value y=$_gtmOrder->oxorder__oxartvatprice2->value }]',
-          'shipping':       '[{$_gtmOrder->oxorder__oxdelcost->value}]',
+          'transaction_id': '[{$_gtmOrder->getFieldData("oxordernr")}]',
+          'affiliation':    '[{$oxcmp_shop->getFieldData("oxname")}]',
+          'value':          [{$_gtmOrder->getTotalOrderSum()}],
+          'tax':            [{math equation="x+y" x=$_gtmOrder->getFieldData("oxartvatprice1") y=$_gtmOrder->getFieldData("oxartvatprice2") }],
+          'shipping':       [{$_gtmOrder->getFieldData("oxdelcost")}],
          'currency':       '[{$_gtmOrder->getFieldData('oxcurrency')}]',
          'items':
              [
-                [{foreach from=$_gtmArticles item="_gtmArticle" name="gtmArticles"}]
+                [{foreach from=$_gtmArticles item="d3BasketArticle" name="gtmArticles"}]
+                  [{assign var="d3oArticlePrice" value=$d3BasketArticle->getPrice()}]
                {
-                    'id':       '[{$_gtmArticle->oxorderarticles__oxartnum->value}]',
-                    'name':     '[{$_gtmArticle->oxorderarticles__oxtitle->value}]',
-                    'variant':  '[{$_gtmArticle->oxorderarticles__oxselvariant->value}]',
-                    'price':    [{$_gtmArticle->oxorderarticles__oxprice->value}],
-                    'quantity': [{$_gtmArticle->oxorderarticles__oxamount->value}],
+                    'id':       '[{$d3BasketArticle->getFieldData("oxartnum")}]',
+                    'name':     '[{$d3BasketArticle->getFieldData("oxtitle")}]',
+                    'variant':  '[{$d3BasketArticle->getFieldData("oxselvariant")}]',
+                    'price':    [{$d3oArticlePrice->getPrice()}],
+                    'quantity': [{$d3BasketArticle->getFieldData("oxamount")}],
                    'position': [{$smarty.foreach.gtmArticles.iteration}]
                }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]
                [{/foreach}]
--- a/Application/views/blocks/detail.tpl
+++ b/Application/views/blocks/detail.tpl
@ -1,25 +0,0 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProduct" value=$oView->getProduct()}]
-[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event': 'view_item',
-        'eventLabel':'Product View',
-        'ecommerce': {
-            'currency': '[{$currency->name}]',
-            'items': [
-                {
-                    'item_name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
-                    'item_id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
-                    'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                    'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-                    'item_variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
-                    'price': [{$gtmProduct->oxarticles__oxprice->value}]
-                }
-            ]
-        }
-    });
-</script>
--- a/Application/views/blocks/view_item.tpl
+++ b/Application/views/blocks/view_item.tpl
@ -0,0 +1,26 @@
+[{$smarty.block.parent}]
+[{assign var="gtmProduct" value=$oView->getProduct()}]
+[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
+[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+
+<script>
+  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+  dataLayer.push({
+    'event': 'view_item',
+    'eventLabel':'Product View',
+    'ecommerce': {
+      'currency': '[{$currency->name}]',
+      'items': [
+        {
+          'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
+          'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
+          'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+          'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
+          'item_variant': '[{if $gtmProduct->getFieldData("oxvarselect")}][{$gtmProduct->getFieldData("oxvarselect")}][{/if}]',
+          [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+          'price': [{$d3PriceObject->getPrice()}]
+        }
+      ]
+    }
+  });
+</script>
--- a/Application/views/blocks/widget_product_list.tpl
+++ b/Application/views/blocks/widget_product_list.tpl
@ -1,35 +0,0 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProduct" value=$oView->getProduct()}]
-[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event': 'ee.impression',
-        'eventLabel':'Impression',
-        'ecommerce': {
-            'currencyCode': '[{$currency->name}]',
-            'impressions': [
-                {
-                    'name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
-                    'id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
-                    'price': [{$gtmProduct->oxarticles__oxprice->value}],
-                    'brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                    'category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-                    'variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]'
-                    [{if $list && $position}],
-                    'list': '[{$list}]',
-                    'position': [{"_"|str_replace:"":$position}]
-                    [{/if}]
-                }
-            ]
-        }
-    });
-</script>
-<!--
-sWidgetType [{$sWidgetType}] | [{$oView->getViewParameter('sWidgetType')}]
-sListType [{$sListType}] | [{$oView->getViewParameter('sListType')}]
-iIndex [{$iIndex}] | [{$oView->getIndex()}]
-listId [{$listId}] | [{$oView->getViewParameter('listId')}]
-testid [{$testid}] | [{$oView->getViewParameter('testid')}]
-->
--- a/Application/views/ga4/add_to_cart.tpl
+++ b/Application/views/ga4/add_to_cart.tpl
@ -1,59 +1,47 @@
 [{$smarty.block.parent}]

-[{*$gtmProduct|get_class_methods|dumpvar*}]
+[{* 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) {
-    [{*event.preventDefault();*}]
+  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */

-    let iArtQuantity = $("#amountToBasket").val();
+  let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');

-    dataLayer.push({
-        'isAddToBasket': true,
-      'event':'add_to_cart',
-      'eventLabel': 'add_to_cart',
-      'ecommerce': {
-        'currency':   "[{$currency->name}]",
-        'value':      iArtQuantity*[{$gtmProduct->getFieldData('oxprice')}],
-        'items':      [
-          {
-            'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
-            'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
-            'price':          '[{$gtmProduct->getFieldData('oxprice')}]',
-            '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] || '',
-            [{if false}]
-            [{* ??? what *}]
-            'item_list_name': 'Search Results',  // If associated with a list selection.
-            'item_list_id': 'SR123',  // If associated with a list selection.
-            'index': 1,  // If associated with a list selection.
-            [{/if}]
-            'quantity': iArtQuantity
-          }
-        ]
+  [{*** Debug cases ***}]
+  [{*event.preventDefault();*}]
+
+  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}]
--- a/Application/views/ga4/search.tpl
+++ b/Application/views/ga4/search.tpl
@ -13,12 +13,13 @@
          'search_term': '[{$searchparamforhtml}]',
          'items': [
            [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+            [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
            [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
            [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
            {
              'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
              'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-              'price': [{$gtmProduct->oxarticles__oxprice->value|default:'0'}],
+              'price': [{$d3PriceObject->getPrice()}],
              'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
              'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
              'quantity': 1
--- a/Application/views/ga4/view_item_list.tpl
+++ b/Application/views/ga4/view_item_list.tpl
@ -1,4 +1,5 @@
-[{assign var="gtmProducts" value=$products}]
+[{$smarty.block.parent}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]

 [{assign var="breadCrumb" value=''}]

@ -15,12 +16,13 @@
              'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
                'items': [
                    [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+                    [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
                    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
                    [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
                    {
                        'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
                        'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                        'price': [{$gtmProduct->oxarticles__oxprice->value|default:'0'}],
+                        'price': [{$d3PriceObject->getPrice()}],
                        'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
                        'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
                        'quantity': 1
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -4,6 +4,46 @@ 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
+### Fixed
+- unnecessary converting of int to str
+- missing PriceObject-bug
+### Changed
+- genuine code cleanup
+
+## [1.4.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.3.1...1.4.0) - 2023-05-02
+### Added
+- "OXID Cookie Management powered by usercentrics" compatibility
+- usercentrics defined script attributes
+- cookie-manager evaluation
+### Changed
+- genuine clean up of base-js-files
+
 ## [1.3.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2.1...1.3.1) - 2023-03-17
 ### Added
 - Aggrosoft-Cookie-Consent compatibility
--- a/Docs/README.md
+++ b/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
@ -54,12 +54,15 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
 - [aggrosoft - oxid-cookie-compliance](https://github.com/aggrosoft/oxid-cookie-compliance)
  - https://github.com/aggrosoft/oxid-cookie-compliance
  - die entsprechend gewählte Kategorie in den Moduleinstellungen des 'Google Analytics 4' unter
-  ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+  - Default-Werte sind entweder ```ANALYTICS``` oder ```MARKETING```. Bitte auf die Großschreibung achten.

 - [Netensio - Cookie Consent Manager](https://www.netensio.de/oxid-eshop-module/cookie-consent-manager-fuer-oxid-eshop.html)
  - Modul entsprechend konfigurieren
  - CookieID des angelegten Cookies in den Moduleinstellungen des 'Google Analytics 4' unter
    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
-  
+
 - [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
-  - soweit ich weiß nichts weiter?
+  - 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
--- a/Modules/Core/ViewConfig.php
+++ b/Modules/Core/ViewConfig.php
@ -1,19 +1,19 @@
 <?php
 /**
- * This Software is the property of Data Development and is protected
- * by copyright law - it is NOT Freeware.
- * Any unauthorized use of this software without a valid license
- * is a violation of the license agreement and will be prosecuted by
- * civil and criminal law.
- * http://www.shopmodule.com
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * https://www.d3data.de
+ *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author        D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * @link          http://www.oxidmodule.com
+ * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+ * @link      https://www.oxidmodule.com
 */

 namespace D3\GoogleAnalytics4\Modules\Core;

 use OxidEsales\Eshop\Application\Controller\FrontendController;
+use OxidEsales\Eshop\Core\Config;
 use OxidEsales\Eshop\Core\Registry;

 class ViewConfig extends ViewConfig_parent
@ -21,38 +21,145 @@ class ViewConfig extends ViewConfig_parent

    // Google Tag Manager Container ID
    private $sContainerId = null;
+    private $sCookieManagerType = null;

    public function getGtmContainerId()
    {
        if ($this->sContainerId === null)
        {
-
            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
        }
        return $this->sContainerId;
    }

    /**
-     * @param $sCookieID
+     * @return mixed
+     */
+    public function getModuleSettingExplicitManagerSelectValue()
+    {
+        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()
+    {
+        if ($this->sCookieManagerType === null)
+        {
+            $this->sCookieManagerType = false;
+
+            $allowedManagerTypes = [
+                'net_cookie_manager',
+                'agcookiecompliance',
+                'oxps_usercentrics'
+            ];
+
+            foreach ($allowedManagerTypes as $type) {
+                if ($this->isModuleActive($type)) {
+                    $this->sCookieManagerType = $type;
+                    break;
+                }
+            }
+        }
+
+        if ($this->sCookieManagerType === false and $this->getExplicitManager()){
+            return "externalService";
+        }
+
+        return $this->sCookieManagerType;
+    }
+
+    /**
     * @return bool
     */
-    public function D3blAcceptedCookie($sCookieID)
+    public function shallUseOwnCookieManager()
    {
-        $oSession = Registry::getSession();
-        $aCookies = $oSession->getVariable("aCookieSel");
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
+    }

-        if (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1") {
+    /**
+     * @return bool
+     */
+    public function D3blShowGtmScript()
+    {
+        /** @var Config $oConfig */
+        $oConfig = Registry::getConfig();
+
+        // No Cookie Manager in use
+        if (false === $this->shallUseOwnCookieManager()) {
            return true;
        }

+        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+
+        // Netensio Cookie Manager
+        if ($this->getCookieManagerType() == "net_cookie_manager") {
+            $oSession = Registry::getSession();
+            $aCookies = $oSession->getVariable("aCookieSel");
+
+            return (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
+        }
+
        // Aggrosoft Cookie Consent
-        if (method_exists($this, "isCookieCategoryEnabled")) {
-            return $this->isCookieCategoryEnabled($sCookieID);
+        if ($this->getCookieManagerType() == "agcookiecompliance") {
+            if (method_exists($this, "isCookieCategoryEnabled")) {
+                return $this->isCookieCategoryEnabled($sCookieID);
+            }
+        }
+
+        // UserCentrics or consentmanager
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
+            // Always needs the script-tags delivered to the DOM.
+            return true;
        }

        return false;
    }

+    /**
+     * Get additional attributes for script tags.
+     * This is especially important for UserCentrics.
+     * @return string
+     */
+    public function getGtmScriptAttributes()
+    {
+        $oConfig = Registry::getConfig();
+
+        if (false === $this->shallUseOwnCookieManager()){
+            return "";
+        }
+
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
+            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+
+            if ($sCookieId) {
+                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
+            }
+        }
+
+        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
+            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+
+            if ($sCookieId) {
+                return 'async 
+                        type="text/plain"
+                        data-cmp-src="https://www.googletagmanager.com/gtm.js?id='.$this->getGtmContainerId().'"
+                        class="cmplazyload"
+                        data-cmp-vendor="s905"
+                        ';
+            }
+        }
+
+        return "";
+    }
+
    private $blGA4enabled = null;

    public function isGA4enabled()
@ -72,7 +179,6 @@ class ViewConfig extends ViewConfig_parent
        $oConfig = Registry::getConfig();
        $oView   = $oConfig->getTopActiveView();
        /** @var FrontendController $oShop */
-
        $oUser = $oConfig->getUser();

        $cl         = $this->getTopActiveClassName();
--- a/README.md
+++ b/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" 
--- a/metadata.php
+++ b/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.3.1',
+    '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
        [
@ -43,17 +44,11 @@ $aModule          = [
            'block'    => 'theme_svg_icons',
            'file'     => '/Application/views/blocks/_gtm_nojs.tpl'
        ],
-        // widget_product_list
-        [
-            'template' => 'widget/product/list.tpl',
-            'block'    => 'widget_product_list',
-            'file'     => '/Application/views/blocks/widget_product_list.tpl'
-        ],
        // details
        [
            'template' => 'page/details/inc/productmain.tpl',
            'block'    => 'details_productmain_title',
-            'file'     => '/Application/views/blocks/detail.tpl',
+            'file'     => '/Application/views/blocks/view_item.tpl',
            'position' => 150
        ],
        // checkout
@ -70,8 +65,8 @@ $aModule          = [
        // Lists
        // view_item_list
        [
-            'template' => 'widget/product/list.tpl',
-            'block'    => 'd3Ga4_view_item_list',
+            'template' => 'page/list/list.tpl',
+            'block'    => 'page_list_productlist',
            'file'     => '/Application/views/ga4/view_item_list.tpl',
            'position' => 150
        ],
@ -126,5 +121,12 @@ $aModule          = [
            'value'    => 'example',
            'position' => 999
        ],
+        [
+            'group' => 'd3_gtm_settings_cookiemanager',
+            'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
+            'type' => 'select',
+            'value' => 'none',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
+        ],
    ]
 ];
Author	SHA1	Message	Date
MaxBUhe	3f59d1f210	bump version && changelog to 1.9.0	2023-06-19 14:50:34 +02:00
MaxBUhe	5ed924e840	[rework] change structure of GA-event 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	2023-06-19 11:34:45 +02:00
MaxBUhe	d4ef0f35f9	bump version && changelog to 1.8.0	2023-05-31 14:22:11 +02:00
MaxBUhe	c17ae1cef5	fix explicit manager bug bug would adjust the script even if the check for an own cookieManager is not set	2023-05-31 14:11:50 +02:00
MaxBUhe	32e08a88ca	rm typo in readme	2023-05-31 10:29:49 +02:00
MaxBUhe	9d9daf9a85	bump version && changelog to 1.7.0	2023-05-31 10:28:19 +02:00
MaxBUhe	6eefc062ba	add missing article-getter	2023-05-31 10:17:51 +02:00
MaxBUhe	3f89e26bde	adjust readme and switch used block-extension	2023-05-30 16:41:59 +02:00
MaxBUhe	e624cfdfcb	bump version && changelog to 1.6.0	2023-05-30 08:56:19 +02:00
MaxBUhe	e2cdda530b	adjusted usercentrics script	2023-05-26 13:49:50 +02:00
MaxBUhe	3e65d05c0b	added position to block-extension	2023-05-24 11:09:36 +02:00
MaxBUhe	561a2101f1	[working-state] restructuring usercentricts & consentmanager decision consentmanager decision is working so far; next step is implementing usercentricts	2023-05-23 14:52:07 +02:00
MaxBUhe	6fca52cc06	add usercentrics chosable settings-value; add additional methods; add new multilang-idents	2023-05-23 14:33:35 +02:00
MaxBUhe	dfdc5d5edf	bump version && changelog to 1.5.0	2023-05-23 11:44:07 +02:00
MaxBUhe	ae6f9bfaa9	switch php-file-header hint	2023-05-23 10:49:59 +02:00
MaxBUhe	1d9e09b8b1	switch view_item and item_list template	2023-05-23 10:49:05 +02:00
MaxBUhe	f9a0834d26	add settings-entry; add consentmanager-option	2023-05-16 14:42:12 +02:00
MaxBUhe	bb70cda626	fix unnecessary convert of int to str	2023-05-16 14:41:47 +02:00
MaxBUhe	c9a1174c98	genuine code cleanup; switch hard-getter to methods and use price-object # Conflicts: # Application/views/blocks/view_item.tpl # Application/views/ga4/add_to_cart.tpl	2023-05-16 14:41:32 +02:00
Christoph Staeblein	f3b2911679	OXID UserCentrics support, general overhaul for cookie managers	2023-05-16 14:24:50 +02:00
MaxBUhe	6d155d310b	bump version && changelog to 1.4.0	2023-05-02 14:21:43 +02:00
Christoph Staeblein	6e62f39b71	OXID UserCentrics support, general overhaul for cookie managers taken from pull-request; thank you C. Stäblein	2023-04-04 10:15:15 +02:00