From 84a9aba7640046a98a8090d7f64bfa86b57d98cf Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Wed, 13 Sep 2023 14:42:12 +0200 Subject: [PATCH 1/5] adjust Doku with further infos new cookieid -> Control parameter --- Application/views/admin/de/module_options.php | 7 ++++++- Docs/CMP/consentmanager.md | 18 ++++++++++++++++++ Docs/README.md | 10 ++++++++++ 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 Docs/CMP/consentmanager.md diff --git a/Application/views/admin/de/module_options.php b/Application/views/admin/de/module_options.php index 35694eb..e3a2c2d 100755 --- a/Application/views/admin/de/module_options.php +++ b/Application/views/admin/de/module_options.php @@ -44,5 +44,10 @@ $aLang = [ 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_USERCENTRICS' => 'usercentrics', 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEFIRST' => 'cookiefirst', 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEBOT' => 'Cookiebot', - 'SHOP_MODULE_d3_gtm_settings_cookieName' => 'CookieID', + 'SHOP_MODULE_d3_gtm_settings_cookieName' => 'Steuerungsparameter', + 'HELP_SHOP_MODULE_d3_gtm_settings_cookieName' => 'Nähere infos zum "Steuerungsparameter"
+ Beachte:
+ Sofern Sie die consentmanager CMP verwenden, + bitte ich Sie, gründlichst, die Hinweise der Moduldokumentation/Consentmanager zu lesen. + ' ]; diff --git a/Docs/CMP/consentmanager.md b/Docs/CMP/consentmanager.md new file mode 100644 index 0000000..264536b --- /dev/null +++ b/Docs/CMP/consentmanager.md @@ -0,0 +1,18 @@ +# Consentmanager +## 1. Steuerungsparameter +Tragen Sie hier die gewünschte ID des zu prüfenden Anbieters (Vendor-ID) ein.
+Diese ID finden Sie in Ihrem Consentmanager-Dashboard, links, unter "CMP > Anbieter". + +Nähere Informationen hierzu suchen Sie bitte auf der offiziellen Webseite von [app.consentmanager](https://help.consentmanager.de/books/cmp/page/4-configuring-vendors-and-cookies). + +## 2. Gebräuchliche ID's +- s26 (Google Analytics/ GA/ GA4) +- s905 (Google Tag Manager/ GTM) + +## 3. Einrichtung GTM +Die von Ihnen eingetragene ID muss oder ist schlussendlich die ID, auf die im GTM-Umfeld geprüft wird. +Das heißt, dass sich die Eintragung nach GTM, oder umgekehrt, richtet. + +### Unterstützung benötigt? +Kein Problem! +Kontaktieren Sie uns gern unter [d3data.de](https://www.d3data.de) \ No newline at end of file diff --git a/Docs/README.md b/Docs/README.md index 5cd715a..6d8e104 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -5,6 +5,13 @@ Die Einbindung dieser Event-Templates erfolgt über TPL-Blöcke unter `source/mo *Hinweis: nicht alle templates sind bereits gefüllt. Wünschen Sie die Implementierung eines unausgefüllten templates? Kommen Sie auf uns zu unter https://www.d3data.de/ +## Steuerungsparameter +Tragen Sie hier im Normalfall die ID des zu prüfenden Cookies ein. +In bestimmten Fällen, müssen Sie hier alternative Werte eintragen. Diese Fälle sind bedingt +nach der gewählten CMP (Consent Manager Platform). + +> nähere Infos unter [CMP](#consent-manager-platform-cmp) + ## Blöcke Für den geregelten Ablauf sind folgende Blöcke nötig: - Suchergebnisse @@ -50,6 +57,9 @@ Dann tragen Sie in den Folgeeinstellungen unter "Cookie Manager Einstellungen", die Cookie-ID des zugehörigen Cookies ein. Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Cookie Manager nutzen?". +## Consent Manager Platform (CMP) +- [Consentmanager](https://git.d3data.de/D3Public/GoogleAnalytics4/src/branch/master/Docs/CMP/consentmanager.md) + ### Unterstützung für - [aggrosoft - oxid-cookie-compliance](https://github.com/aggrosoft/oxid-cookie-compliance) - https://github.com/aggrosoft/oxid-cookie-compliance From ef4e4625cd626da10588a80fc36eebd40f94d5f5 Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Wed, 13 Sep 2023 14:56:05 +0200 Subject: [PATCH 2/5] switch name of control-parameter; switch consentmanager-script-adjustments --- Modules/Core/ViewConfig.php | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/Modules/Core/ViewConfig.php b/Modules/Core/ViewConfig.php index 8e22842..fd0b20c 100644 --- a/Modules/Core/ViewConfig.php +++ b/Modules/Core/ViewConfig.php @@ -19,6 +19,8 @@ use OxidEsales\Eshop\Core\Config; use OxidEsales\Eshop\Core\Registry; use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory; use OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\Bridge\ModuleSettingBridgeInterface; +use Psr\Container\ContainerExceptionInterface; +use Psr\Container\NotFoundExceptionInterface; class ViewConfig extends ViewConfig_parent { @@ -117,7 +119,7 @@ class ViewConfig extends ViewConfig_parent */ public function getGtmScriptAttributes() :string { - $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName')); + $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName')); if (false === $this->shallUseOwnCookieManager()){ return ""; @@ -128,29 +130,24 @@ class ViewConfig extends ViewConfig_parent or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY ) { - if ($sCookieId) { - return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""'; + if ($sControlParameter) { + return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""'; } } if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER) { - 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" - '; + if ($sControlParameter) { + return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"'; } } if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){ - return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"'; + return 'type="text/plain" data-cookiefirst-category="' . $sControlParameter .'"'; } if ($this->sCookieManagerType === ManagerTypes::COOKIEBOT){ - return 'type="text/plain" data-cookieconsent="' . $sCookieId .'"'; + return 'type="text/plain" data-cookieconsent="' . $sControlParameter .'"'; } return ""; @@ -158,6 +155,10 @@ class ViewConfig extends ViewConfig_parent private $blGA4enabled = null; + /** + * @throws ContainerExceptionInterface + * @throws NotFoundExceptionInterface + */ public function isGA4enabled() { if ($this->blGA4enabled === null) From 36b3aa9ef23f3826f8380b4af7bc370e389b2df7 Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Wed, 13 Sep 2023 15:08:58 +0200 Subject: [PATCH 3/5] switch param-name --- Application/views/admin/de/module_options.php | 4 ++-- Modules/Core/ViewConfig.php | 4 ++-- metadata.php | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Application/views/admin/de/module_options.php b/Application/views/admin/de/module_options.php index e3a2c2d..a7b1a56 100755 --- a/Application/views/admin/de/module_options.php +++ b/Application/views/admin/de/module_options.php @@ -44,8 +44,8 @@ $aLang = [ 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_USERCENTRICS' => 'usercentrics', 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEFIRST' => 'cookiefirst', 'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEBOT' => 'Cookiebot', - 'SHOP_MODULE_d3_gtm_settings_cookieName' => 'Steuerungsparameter', - 'HELP_SHOP_MODULE_d3_gtm_settings_cookieName' => 'Nähere infos zum "Steuerungsparameter"
+ 'SHOP_MODULE_d3_gtm_settings_controlParameter' => 'Steuerungsparameter', + 'HELP_SHOP_MODULE_d3_gtm_settings_controlParameter' => 'Nähere infos zum "Steuerungsparameter"
Beachte:
Sofern Sie die consentmanager CMP verwenden, bitte ich Sie, gründlichst, die Hinweise der Moduldokumentation/Consentmanager zu lesen. diff --git a/Modules/Core/ViewConfig.php b/Modules/Core/ViewConfig.php index fd0b20c..39e1818 100644 --- a/Modules/Core/ViewConfig.php +++ b/Modules/Core/ViewConfig.php @@ -77,7 +77,7 @@ class ViewConfig extends ViewConfig_parent $this->defineCookieManagerType(); - $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName')); + $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_controlParameter')); // Netensio Cookie Manager if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) { @@ -119,7 +119,7 @@ class ViewConfig extends ViewConfig_parent */ public function getGtmScriptAttributes() :string { - $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName')); + $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_controlParameter')); if (false === $this->shallUseOwnCookieManager()){ return ""; diff --git a/metadata.php b/metadata.php index bea66b4..2040610 100755 --- a/metadata.php +++ b/metadata.php @@ -131,7 +131,7 @@ $aModule = [ ], [ 'group' => 'd3_gtm_settings_cookiemanager', - 'name' => 'd3_gtm_settings_cookieName', + 'name' => 'd3_gtm_settings_controlParameter', 'type' => 'str', 'value' => 'example', 'position' => 999 From bb513e6dedc6bd3830e0da923bf96ce92026eba5 Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Wed, 13 Sep 2023 15:13:35 +0200 Subject: [PATCH 4/5] adjust set-param check --- Modules/Core/ViewConfig.php | 10 +++------- metadata.php | 2 +- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/Modules/Core/ViewConfig.php b/Modules/Core/ViewConfig.php index 39e1818..e5af0db 100644 --- a/Modules/Core/ViewConfig.php +++ b/Modules/Core/ViewConfig.php @@ -121,7 +121,7 @@ class ViewConfig extends ViewConfig_parent { $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_controlParameter')); - if (false === $this->shallUseOwnCookieManager()){ + if (false === $this->shallUseOwnCookieManager() or ($sControlParameter === '')){ return ""; } @@ -130,16 +130,12 @@ class ViewConfig extends ViewConfig_parent or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY ) { - if ($sControlParameter) { - return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""'; - } + return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""'; } if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER) { - if ($sControlParameter) { - return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"'; - } + return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"'; } if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){ diff --git a/metadata.php b/metadata.php index 2040610..e6b1fa5 100755 --- a/metadata.php +++ b/metadata.php @@ -133,7 +133,7 @@ $aModule = [ 'group' => 'd3_gtm_settings_cookiemanager', 'name' => 'd3_gtm_settings_controlParameter', 'type' => 'str', - 'value' => 'example', + 'value' => '', 'position' => 999 ], [ From 19553fcee22532f155c71c9062c680997f126e12 Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Wed, 13 Sep 2023 16:00:12 +0200 Subject: [PATCH 5/5] bump metadata and readme --- CHANGELOG.md | 9 +++++++++ metadata.php | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d0dac6f..1bd2fc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,15 @@ 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). +## [2.13.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.12.0...2.13.0) - 2023-09-13 +### Added +- extended Docs +### Changed +- control-param name +- control-param function +- adjusted check for set control-param +- consentmanager-script-adjustments + ## [2.12.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.11.1...2.12.0) - 2023-09-07 ### Added - cookiebot functionality diff --git a/metadata.php b/metadata.php index e6b1fa5..6535535 100755 --- a/metadata.php +++ b/metadata.php @@ -26,7 +26,7 @@ $aModule = [ Die Entwicklung basiert auf einem Fork von Marat Bedoev - Github-Link ", 'thumbnail' => 'thumbnail.png', - 'version' => '2.12.0', + 'version' => '2.13.0', 'author' => 'Data Development (Inh.: Thomas Dartsch)', 'email' => 'support@shopmodule.com', 'url' => 'https://www.oxidmodule.com/',