Installatie- en configuratiehandleiding

Vereisten

• Magento Open Source / Adobe Commerce 2.4.x.
• PHP compatibel met de gebruikte Magento-versie.
• Composer-toegang tot de private repository van de module.
• Module kowal/base.
• Optioneel: Kowal_CookieConsent, als de webshop deze gebruikt voor GTM en Consent Mode.

Installatie via 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

Voer in de productieomgeving, indien het project dit vereist, de standaard Magento-deployment uit:

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

Basisconfiguratie

Beheerpaneel:

Stores > Configuration > Kowal > Kowal Data Layer

Menu:

kowal.store > Modules > Data Layer > Settings

General

1. Enable Module - schakel de module in voor het geselecteerde configuratiebereik.
2. Debug Mode - alleen inschakelen tijdens tests en verificatie van de implementatie.
3. Render Mode - laat Server and JavaScript staan, tenzij er een reden is om de werkingsmodus te beperken.
4. Missing Value Strategy - kies of ontbrekende waarden moeten worden overgeslagen of verzonden als undefined.
5. Clear Ecommerce Before Push - aanbevolen Yes.
6. Fail-safe Mode - aanbevolen Yes; verkoopkritische processen blijven ook beschermd wanneer deze optie is uitgeschakeld.
7. Log Level - in productie aanbevolen Errors only.
8. Log Payloads - alleen tijdelijk inschakelen.

Product Mapping

1. Product Identifier Attribute - kies het attribuut dat wordt gebruikt als item_id. Standaard sku.
2. Brand Attribute - kies het fabrikant-/merkattribuut. Standaard manufacturer.
3. Category Strategy - kies de manier waarop item_category wordt opgebouwd.
4. Category Attribute - alleen instellen wanneer de categorie-strategie gebruikmaakt van een productattribuut.
5. Configurable Product Strategy - bepaal of gegevens van het child/simple-product of van het parent/configurable-product worden gebruikt.
6. Include Out Of Stock Products On Lists - van toepassing op productlijst-events.

Events

Schakel de events in die voor de implementatie vereist zijn:

• 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, als de webshop een tussenpagina gebruikt vóór betaling.

Privacy

1. Send User ID - verzendt de Magento-klant-ID voor ingelogde klanten.
2. Send Hashed Email - verzendt alleen de SHA-256-hash van het e-mailadres. Het ruwe e-mailadres komt niet in dataLayer terecht.

Integrations

1. Integrate With Kowal Cookie Consent - schakel in als de webshop Kowal_CookieConsent gebruikt.
2. Render GTM From DataLayer Module - laat op No staan als GTM al wordt gerenderd door Cookie Consent of een andere module.
3. Google Tag Manager ID - alleen instellen wanneer GTM-rendering vanuit deze module is ingeschakeld.
4. purchase_test Redirect Rules - voeg alleen die betaalmethoden toe die de tussenpagina purchase_test moeten gebruiken.

Regelmodi voor purchase_test:

• Static URL - alleen gebruiken voor betalingen met een vast adres van de betaalprovider.
• URL Pattern - gebruiken wanneer een URL-patroon met placeholders {order_id}, {order_increment_id}, {store_id} of {quote_id} volstaat.
• Adapter Required - gebruiken voor gateways die een dynamische transactie-URL genereren. Voor livegang in productie moet een dedicated adapter voor de specifieke betaalmodule worden toegevoegd.

Multistore-configuratie

Configureer de module op store-view-niveau als de shops verschillen in:

• taal;
• valuta;
• advertentiefeed;
• attribuut voor product-ID;
• merkattribuut;
• categoriestructuur;
• betaalmethoden.

Verificatie van de implementatie

1. Open Google Tag Manager Preview.
2. Controleer dataLayer in de browserconsole of met de extensie DataLayer Checker.
3. Test de productpagina en het event view_item.
4. Open een categorie of zoekresultaten en controleer view_item_list.
5. Klik op een product in de lijst en controleer select_item.
6. Voeg een product toe aan de winkelwagen en controleer add_to_cart.
7. Wijzig de hoeveelheid of verwijder een product uit de winkelwagen en controleer remove_from_cart.
8. Voeg een product toe aan de wishlist en controleer add_to_wishlist.
9. Ga naar de winkelwagen en de checkout en controleer view_cart en begin_checkout.
10. Sla de verzend- en betaalmethode op en controleer add_shipping_info en add_payment_info.
11. Plaats een testbestelling en controleer purchase.
12. Vernieuw de succespagina en controleer of purchase niet wordt gedupliceerd.
13. Controleer var/log/kowal_datalayer.log.

Integratie van purchase_test

Als de betaalmethode de klant buiten de webshop doorstuurt en de doel-URL van de provider kent, kan de betaalintegratie gebruikmaken van:

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

De methode retourneert de URL van de tussenpagina van de module. De tussenpagina verzendt purchase_test en stuurt de klant vervolgens door naar de betaalprovider. Als JavaScript of DataLayer niet werkt, moet de redirect alsnog worden uitgevoerd.

Gebruik voor integraties waarbij de URL afhankelijk is van de bestelling of een transactietoken:

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

Als de methode is ingesteld op Adapter Required, moet de adapter het volgende implementeren:

Kowal\DataLayer\Api\PurchaseTestRedirectAdapterInterface

De adapter moet in DI worden geregistreerd als een array-element adapters voor Kowal\DataLayer\Model\PurchaseTest\RedirectAdapterPool. De adapter is de juiste plek voor logica die afhankelijk is van de specifieke betaalprovider.