From 62b382eadfbe0ba7277d7797f8e081f6517949d1 Mon Sep 17 00:00:00 2001 From: MaxBUhe Date: Thu, 26 Jan 2023 09:09:09 +0100 Subject: [PATCH] adding tech-docs; rm unnecessary sections in readme; fixing wrong links --- Docs/README.md | 51 +++++++++++++++++++++++++++++++++++++ README.md | 69 +++++++------------------------------------------- metadata.php | 3 ++- 3 files changed, 62 insertions(+), 61 deletions(-) create mode 100644 Docs/README.md diff --git a/Docs/README.md b/Docs/README.md new file mode 100644 index 0000000..b526a3b --- /dev/null +++ b/Docs/README.md @@ -0,0 +1,51 @@ +## Technische Doku +### GA4 Events / Customizing +Für alle implementierten GA4 Events existieren Templates unter `source/modules/d3/googleanalytics4/Application/views/ga4/`, dabei entspricht der Dateiname dem Eventnamen in GA4. +Die Einbindung dieser Event-Templates erfolgt über TPL-Blöcke unter `source/modules/d3/googleanalytics4/Application/views/blocks/`. +*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/ + +### Blöcke +Für den geregelten Ablauf sind folgende Blöcke nötig: +- Suchergebnisse + - Blockname: search_results + - 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 + - GA4 Event: view_item_list +- Detailseite + - Blockname: details_productmain_title + - Datei: page/details/inc/productmain.tpl + - GA4 Event: view_item +- dem WK hinzufügen (button) + - Blockname: details_productmain_tobasket + - Datei: page/details/inc/productmain.tpl + - GA4 Event: add_to_cart +- Warenkorb + - Blockname: checkout_basket_main + - Datei: page/checkout/basket.tpl + - GA4 Event: view_cart +- abgeschlossener Kauf + - Blockname: checkout_thankyou_main + - Datei: page/checkout/thankyou.tpl + - GA4 Event: purchase + +### Verfügbare Datalayer Variablen +Für die einfachste Übersicht der enthaltenen Daten empfehle ich den Vorschau-Modus vom Google Tag Manager. + +Bei jedem Seitenaufruf wird die Datenschicht mit einigen wenigen Infos erstellt, die man zum reinen Erfassen der Seitenaufrufe benötigt: ++ **page.type** - Seitentyp: default / cms / product / listing / checkout (an google analytics angelehnt) ++ **page.title** - Seitentitel (außer Startseite, sie hat keinen Titel) ++ **page.cl** - OXID Controller Klasse (start, search, etc) ++ **userid** - oxId vom Benutzer bzw `false` falls nicht eingeloggt ++ **sessionid** - session iD + +Alle für Ecommerce Tracking relevanten Daten werden mit speziellen Ecommerce Events in die Datenschicht eingefügt. + +### Cookie-Handling +Sie nutzen einen eigenen, als Modul im Shop installierten, Cookie-manager? +Dann tragen Sie in den Folgeeinstellungen unter "Cookie Manager Einstellungen", +die Cookie-ID des zugehörigen Cookies ein. Und aktivieren Sie diese Weiche, +indem Sie den Haken bei "Eigenen Cookie Manager nutzen?" setzen. \ No newline at end of file diff --git a/README.md b/README.md index c486d35..a1c31dd 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,7 @@ Bitte tragen Sie den folgenden Abschnitt in die `composer.json` Ihres Projektes ``` "extra": { - "oxideshop": { - "blacklist-filter": [ - "*.md", - "composer.json", - ".php-cs-fixer.php", - "*.xml", - "*.neon" - ], - "target-directory": "d3/googleanalytics" + optionale Anweisungen von 3rd-Party-Packages (z.B. Patch- oder Symlink-Anweisungen) } ``` @@ -58,57 +50,11 @@ Tragen Sie die nötige sog. 'Container ID' ein. Diese sieht in etwa so aus: 'GTM Aktivieren Sie GA4 selbst, indem Sie dieses direkt darunter anhaken. -### GA4 Events / Customizing -Für alle implementierten GA4 Events existieren Templates unter `source/modules/d3/googleanalytics4/Application/views/ga4/`, dabei entspricht der Dateiname dem Eventnamen in GA4. -Die Einbindung dieser Event-Templates erfolgt über TPL-Blöcke unter `source/modules/d3/googleanalytics4/Application/views/blocks/`. -*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/ - -### Blöcke -Für den geregelten Ablauf sind folgende Blöcke nötig: -- Suchergebnisse - - Blockname: search_results - - 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 - - GA4 Event: view_item_list -- Detailseite - - Blockname: details_productmain_title - - Datei: page/details/inc/productmain.tpl - - GA4 Event: view_item -- dem WK hinzufügen (button) - - Blockname: details_productmain_tobasket - - Datei: page/details/inc/productmain.tpl - - GA4 Event: add_to_cart -- Warenkorb - - Blockname: checkout_basket_main - - Datei: page/checkout/basket.tpl - - GA4 Event: view_cart -- abgeschlossener Kauf - - Blockname: checkout_thankyou_main - - Datei: page/checkout/thankyou.tpl - - GA4 Event: purchase - -### Verfügbare Datalayer Variablen -Für die einfachste Übersicht der enthaltenen Daten empfehle ich den Vorschau-Modus vom Google Tag Manager. - -Bei jedem Seitenaufruf wird die Datenschicht mit einigen wenigen Infos erstellt, die man zum reinen Erfassen der Seitenaufrufe benötigt: -+ **page.type** - Seitentyp: default / cms / product / listing / checkout (an google analytics angelehnt) -+ **page.title** - Seitentitel (außer Startseite, sie hat keinen Titel) -+ **page.cl** - OXID Controller Klasse (start, search, etc) -+ **userid** - oxId vom Benutzer bzw `false` falls nicht eingeloggt -+ **sessionid** - session iD - -Alle für Ecommerce Tracking relevanten Daten werden mit speziellen Ecommerce Events in die Datenschicht eingefügt. +### Technische Infos +- Navigieren Sie bitte zur [technischen Doku](./Docs/README.md) --- -Sie nutzen einen eigenen, als Modul im Shop installierten, Cookie-manager? Dann tragen Sie in den Folgeeinstellungen -unter "Cookie Manager Einstellungen", die Cookie-ID des zugehörigen Cookies ein. Und aktivieren Sie diese Weiche, -indem Sie den Haken bei "Eigenen Cookie Manager nutzen?" setzen. - ## Changelog Siehe [CHANGELOG](CHANGELOG.md) für weitere Informationen. @@ -134,8 +80,11 @@ Copyright (c) D3 Data Development (Inh. Thomas Dartsch) Diese Software wird unter der GNU GENERAL PUBLIC LICENSE Version 3 vertrieben. ``` -Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [LICENSE](LICENSE.md)-Datei, die mit diesem Quellcode verteilt wurde. +Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [LICENSE](LICENSE)-Datei, die mit diesem Quellcode verteilt wurde. -## weitere Lizenzen und Nutzungsbedingungen +## Credits +Zu diesem Modul haben beigetragen: -... \ No newline at end of file +- [Marat Bedoev](https://github.com/vanilla-thunder) + +Vielen Dank. \ No newline at end of file diff --git a/metadata.php b/metadata.php index d0ca5c3..05e240b 100755 --- a/metadata.php +++ b/metadata.php @@ -137,7 +137,8 @@ $aModule = [ [ 'template' => 'page/details/inc/productmain.tpl', 'block' => 'details_productmain_tobasket', - 'file' => '/Application/views/ga4/add_to_cart.tpl' + 'file' => '/Application/views/ga4/add_to_cart.tpl', + 'position' => 150 ] ], 'settings' => [