Installations- und Konfigurationsanleitung

Anforderungen

• Magento Open Source / Adobe Commerce 2.4.x.
• PHP kompatibel mit der verwendeten Magento-Version.
• Composer-Zugriff auf das private Repository des Moduls.
• Modul kowal/base.
• Optional: Kowal_CookieConsent, wenn der Shop es für GTM und Consent Mode verwendet.

Installation mit Composer

composer config repositories.kowal-datalayer vcs composer require kowal/module-datalayerphp bin/magento module:enable Kowal_DataLayerphp bin/magento setup:upgradephp bin/magento cache:flush

Führen Sie in einer Produktionsumgebung, falls das Projekt dies erfordert, das standardmäßige Magento-Deployment aus:

php bin/magento setup:di:compilephp bin/magento setup:static-content:deployphp bin/magento cache:flush

Grundkonfiguration

Administrationsbereich:

Stores > Configuration > Kowal > Kowal Data Layer

Menü:

kowal.store > Modules > Data Layer > Settings

General

1. Enable Module - aktivieren Sie das Modul für den ausgewählten Konfigurationsbereich.
2. Debug Mode - nur während Tests und bei der Verifizierung der Implementierung aktivieren.
3. Render Mode - belassen Sie Server and JavaScript, wenn es keinen Grund gibt, den Betriebsmodus einzuschränken.
4. Missing Value Strategy - wählen Sie, ob fehlende Werte ausgelassen oder als undefined gesendet werden sollen.
5. Clear Ecommerce Before Push - empfohlen: Yes.
6. Fail-safe Mode - empfohlen: Yes; für den Verkauf kritische Prozesse bleiben auch nach Deaktivierung dieser Option geschützt.
7. Log Level - in Produktion empfohlen: Errors only.
8. Log Payloads - nur vorübergehend aktivieren.

Product Mapping

1. Product Identifier Attribute - wählen Sie das Attribut, das als item_id verwendet wird. Standardmäßig sku.
2. Brand Attribute - wählen Sie das Hersteller-/Markenattribut. Standardmäßig manufacturer.
3. Category Strategy - wählen Sie die Methode zum Aufbau von item_category.
4. Category Attribute - nur festlegen, wenn die Kategoriestrategie ein Produktattribut verwendet.
5. Configurable Product Strategy - entscheiden Sie, ob Daten des Child-/Simple-Produkts oder des Parent-/Configurable-Produkts verwendet werden sollen.
6. Include Out Of Stock Products On Lists - betrifft Produktlisten-Events.

Events

Aktivieren Sie die für die Implementierung erforderlichen Events:

• user_data
• view_item_list
• select_item
• view_item
• add_to_cart
• remove_from_cart
• view_cart
• add_to_wishlist
• begin_checkout
• add_shipping_info
• add_payment_info
• purchase
• purchase_test, wenn der Shop vor der Zahlung eine Zwischenseite verwendet.

Privacy

1. Send User ID - sendet die Magento-Kunden-ID für eingeloggte Kunden.
2. Send Hashed Email - sendet nur den SHA-256-Hash der E-Mail. Die rohe E-Mail wird nicht in dataLayer übertragen.

Integrations

1. Integrate With Kowal Cookie Consent - aktivieren, wenn der Shop Kowal_CookieConsent verwendet.
2. Render GTM From DataLayer Module - auf No belassen, wenn GTM bereits durch Cookie Consent oder ein anderes Modul gerendert wird.
3. Google Tag Manager ID - nur festlegen, wenn das Rendern von GTM aus diesem Modul aktiviert ist.
4. purchase_test Redirect Rules - fügen Sie nur die Zahlungsmethoden hinzu, die die Zwischenseite purchase_test verwenden sollen.

Regelmodi für purchase_test:

• Static URL - nur für Zahlungen mit fester Anbieter-URL verwenden.
• URL Pattern - verwenden, wenn ein URL-Muster mit Platzhaltern {order_id}, {order_increment_id}, {store_id} oder {quote_id} ausreicht.
• Adapter Required - für Gateways verwenden, die eine dynamische Transaktions-URL erzeugen. Vor dem Produktionsstart muss ein dedizierter Adapter für das jeweilige Zahlungsmodul hinzugefügt werden.

Multistore-Konfiguration

Konfigurieren Sie das Modul auf Store-View-Ebene, wenn sich die Shops unterscheiden in:

• Sprache;
• Währung;
• Werbe-Feed;
• Produktkennungsattribut;
• Markenattribut;
• Kategoriestruktur;
• Zahlungsmethoden.

Überprüfung der Implementierung

1. Öffnen Sie Google Tag Manager Preview.
2. Prüfen Sie dataLayer in der Browser-Konsole oder mit der Erweiterung DataLayer Checker.
3. Testen Sie die Produktseite und das Event view_item.
4. Öffnen Sie eine Kategorie oder Suchergebnisse und prüfen Sie view_item_list.
5. Klicken Sie auf ein Produkt in der Liste und prüfen Sie select_item.
6. Fügen Sie ein Produkt zum Warenkorb hinzu und prüfen Sie add_to_cart.
7. Ändern Sie die Menge oder entfernen Sie ein Produkt aus dem Warenkorb und prüfen Sie remove_from_cart.
8. Fügen Sie ein Produkt zur Wishlist hinzu und prüfen Sie add_to_wishlist.
9. Gehen Sie zum Warenkorb und Checkout und prüfen Sie view_cart sowie begin_checkout.
10. Speichern Sie Versand- und Zahlungsmethode und prüfen Sie add_shipping_info sowie add_payment_info.
11. Führen Sie eine Testbestellung durch und prüfen Sie purchase.
12. Aktualisieren Sie die Erfolgsseite und stellen Sie sicher, dass purchase nicht doppelt gesendet wird.
13. Prüfen Sie var/log/kowal_datalayer.log.

Integration von purchase_test

Wenn die Zahlungsmethode den Kunden aus dem Shop weiterleitet und die Ziel-URL des Anbieters kennt, kann die Zahlungsintegration Folgendes verwenden:

Kowal\DataLayer\Model\PurchaseTestRedirect::prepare($paymentRedirectUrl)

Die Methode gibt die URL der Zwischenseite des Moduls zurück. Die Zwischenseite sendet purchase_test und leitet den Kunden anschließend zum Zahlungsanbieter weiter. Wenn JavaScript oder DataLayer nicht funktioniert, sollte die Weiterleitung dennoch ausgeführt werden.

Für Integrationen, bei denen die URL von der Bestellung oder dem Transaktionstoken abhängt, verwenden Sie:

Kowal\DataLayer\Model\PurchaseTestRedirect::prepareForOrder($order, $fallbackRedirectUrl)

Wenn die Methode im Modus Adapter Required eingestellt ist, sollte der Adapter Folgendes implementieren:

Kowal\DataLayer\Api\PurchaseTestRedirectAdapterInterface

Der Adapter muss in DI als Array-Element adapters für Kowal\DataLayer\Model\PurchaseTest\RedirectAdapterPool registriert werden. Der Adapter ist der richtige Ort für Logik, die vom jeweiligen Zahlungsanbieter abhängt.