eCommerce Events übergeben

eCommerce Events 

Mit Hilfe der Erfassung von eCommerce Events lässt sich die komplette User Journey durch einen Online-Shop nachvollziehen und auf Kategorien und Artikel herunterbrechen. Zu den eCommerce Events zählen nicht nur die Transaktionsdaten beim Bestellabschluss, sondern auch die Interaktionen, die vor einem Kauf stattfinden:

• Produktlisten-Ansichten
• Produktdetail-Aufrufe
• Merklisten-Aktionen
• Warenkorb-Aktionen
• Bestellungen bis hin zu Wandlung in Käufe oder Stornos

Implementierung über Plugins

In diesen Plugins ist das eCommerce Event-Tracking bereits integriert:

• xt:Commerce
• shopware
• OXID
• Magento

Wenn du ein anderes Shopsystem einsetzt und das Google Enhanced Ecommerce Plugin nutzt (direkt und nicht über den Google Tag Manager), übernimmt etracker die Messung, indem du eine Ergänzung im etracker Tracking Code vornimmst (siehe Google Enhanced Ecommerce Activities mit etracker messen).

Die eCommerce JavaScript-Schnittstelle kann auch direkt in die Website eingebunden und die Informationen mit Seitenaufrufen und Klick-Events an etracker übergeben werden.

Google Enhanced Ecommerce Activities mit etracker messen

Ist das (Erweiterte) Ecommerce Tracking von Google im Shop integriert, können die Daten von etracker erfasst werden, wenn die Integration direkt über die Website und nicht via Data Layer des Google Tag Managers erfolgt. Dies vereinfacht die Migration von Google Analytics sehr, wenn nicht eines der oben genannten Plugins verwendet wird. Der Einsatz von Google Analytics ist hierfür nicht erforderlich. Das Google Analytics Tag kann weiterhin vorhanden bleiben oder auch entfernt werden.

Zudem ist Voraussetzung, dass der aktuelle etracker Tracking Code korrekt eingebunden ist und um das Data-Attribut data-ecommerce-grabber=“true““ ergänzt wird.

Der Tracking Code sieht dann wie folgt aus:

<!-- Copyright (c) 2000-2021 etracker GmbH. All rights reserved. -->
<!-- This material may not be reproduced, displayed, modified or distributed -->
<!-- without the express prior written permission of the copyright holder. -->
<!-- etracker tracklet 5.0 -->
<script type="text/javascript">
// var et_pagename = "";
// var et_areas = "";
// var et_tval = 0;
// var et_tsale = 0;
// var et_tonr = "";
// var et_basket = "";
</script>
<script data-ecommerce-grabber="true" id="_etLoader" type="text/javascript" charset="UTF-8" data-block-cookies="true" data-respect-dnt="true"
 data-secure-code="XXXXXX" src="//code.etracker.com/code/e.js" async></script>
<!-- etracker tracklet 5.0 end -->

Der data-secure-code „XXXXXX“ ist durch den persönlichen Account-Schlüssel zu ersetzen.

Folgende eCommerce Events werden von etracker übernommen:

• Produkt auf einer Liste gesehen
• Produkt(-detailseite) angesehen
• In den Warenkorb gelegt
• Aus dem Warenkorb entfernt
• Bestellung des Produkts als Lead

Wichtig:

Sollten bereits etracker eCommerce Events über ein Plugin oder die direkt eingebundene API gemessen werden, sollte die hier beschriebene Funktion nicht genutzt werden, da die Events dann doppelt erfasst werden.

etracker eCommerce API in die Website einbinden

Die eCommerce API ist eine JavaScript-Schnittstelle. Die Schnittstelle ist mit der Auslieferung des etracker Tracking Codes aktiviert, sodass die Events sofort in den Code eingebunden werden können.

Debug-Modus

Die Schnittstelle ist mit einem Debug-Modus ausgestattet, der besonders während des Einbaus der eCommerce API hilfreich ist. Wenn der Debug-Modus aktiviert ist, werden Fehlermeldungen, Events und der Aufruf der etracker Schnittstelle in der JavaScript-Konsole angezeigt. Die Events werden nicht an etracker übermittelt, wenn der Debug-Modus aktiviert ist. Der Modus kann erst eingeschaltet werden, wenn der Tracking Code komplett geladen ist. Um die Ausgaben lesen zu können, helfen Entwicklertools wie sie heute von vielen Browsern angeboten werden.

Debug-Modus mit Konfigurationsobjekt _etr einschalten

Die Einstellung greift erst, wenn die Datei e.js nachgeladen ist. Vorher versendete Events werden aber trotzdem auf Fehler geprüft, da sie ja erst verarbeitet werden, wenn die e.js geladen ist. Wenn _etr bereits existiert, sollte es nicht überschrieben werden.

Beispiel:

<script type="text/javascript" charset="UTF-8">
 // Parameterblock
 var et_pagename = "__INDEX__";
 _etr = {
 debugMode : true
 }
</script>
<script id="_etLoader" type="text/javascript" charset="UTF-8" data-preload-dc="data-preload-dc" data-secure-code="XXXXXX" src="//code.etracker.com/code/e.js" async></script>

Debug-Modus mit etCommerce.debugMode einschalten

Hinweis: Die Variable etCommerce.debugMode muss nach dem Aufruf des Tracking Codes gesetzt werden. Der Tracking Code wird durch die Datei e.js aufgerufen.

// einschalten des Debug-Modus
etCommerce.debugMode = true;

Debug-Modus über die Konsole einschalten

Der Debug-Modus lässt sich auch direkt in der Konsole aktivieren mit folgenden Befehlen:

_etracker.tools.enableDebug()
_etracker.tools.enableDebugMode()

Es wird ein Config-Cookie für diese Session gesetzt, welches die jeweilige Einstellung enthält. Die Einstellung bleibt bestehen, wenn du beide Debug-Modus gleichzeitig einstellen möchtest.

Nach erfolgreichem Test lässt sich der Debug-Modus mit folgenden Befehlen ausschalten:

_etracker.tools.disableDebug()
_etracker.tools.disableDebugMode()

Beispiel für Tracking Code etCommerce.debugMode hinter Parameterblock und etracker Code:

<script type="text/javascript" charset="UTF-8">
  // Parameterblock
  var et_pagename = "Seitenname";
 </script>
 <script id="_etLoader" type="text/javascript" charset="UTF-8" data-preload-dc="data-preload-dc" data-secure-code="XXXXXX" src="//code.etracker.com/code/e.js" async></script>
 <script type="text/javascript" charset="UTF-8">
 etCommerce.debugMode = true;
 </script> 

Funktionen der eCommerce API

Die Schnittstelle hat zwei grundlegende Funktionen, um Informationen an etracker zu übermitteln: sendEvent und attachEvent. sendEvent ist der direkte Aufruf eines von der Schnittstelle definierten eCommerce Events, welcher sofort die übergebenen Werte sendet. Soll das Absenden an ein bestimmtes JavaScript Event gekoppelt sein – z. B. Besucher klickt auf in den Warenkorb – dann kann die Funktion attachEvent verwendet werden, die das eCommerce Event an ein gewünschtes Objekt der Webseite anhängt. Wenn der Tracking Code am Ende der HTML-Seite eingebaut ist oder asynchron geladen wird, gibt es die Möglichkeit, Events und das Anhängen von Events an HTML-Objekte zwischenzuspeichern. Die Funktionen werden dann ausgeführt, wenn der etracker Tracking Code komplett geladen ist.

sendEvent – Event direkt absenden

etCommerce.sendEvent(event, parameter_1, [parameter_n])

Die Funktion sendEvent des Objekts etCommerce wird im JavaScript direkt aufgerufen. Die übergebenen Werte werden dabei direkt an etracker übermittelt.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter.

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('viewProduct', product, 'Warenkorb 1') ;

attachEvent – Event an Objekt anknüpfen

etCommerce.attachEvent(attachObject, event, parameter_1, [parameter_n]) Mit der Funktion attachEvent kann an jedes Webseiten-Objekt, das eine ID besitzt, einem eCommerce Event angehängt werden. Dieses wird dann durch das angegebene JavaScript-Event ausgelöst. So kann direkt mit dem Klick auf den Button In den Warenkorb das eCommerce Event an etracker übermittelt werden.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter.

Beispiel:

// Verknüpfen des eCommerce Events mit einem JavaScript-Event
 
etCommerce.attachEvent({'mousedown' : ['viewButton']}, 'viewProduct', product, 'Warenkorb 1') ;

Mögliche Events

Gegenwärtig unterstützt die eCommerce API neun verschiedene Events, die im Folgenden beschrieben werden.

ViewProductList – Produkt in Liste gesehen

Dieses Event kann gesendet werden, wenn sich der Kunde auf einer Produktliste befindet.

Beispiel:

{"eventName":"viewProductList","productList":{"type":"genericlist","products":[{"id":"12345","name":"Silber","category":["Strom","Privatkunden"],"price":0,"currency":"EUR"},{"id":"12346","name":"Gold","category":["Strom","Privatkunden"],"price":0,"currency":"EUR"},{"id":"12347","name":"Platinum","category":["Strom","Privatkunden"],"price":0,"currency":"EUR"}]}} 

viewProduct – Produkt(-Detailseite) angesehen 

Dieses Event kann gesendet werden, wenn sich der Kunde auf der Produktseite befindet. enn sich der Kunde auf der Produktseite oder einer Übersichtsseite von Produkten befindet.

Beispiel:

// Definition des Produkt-Objekts
var product = 
{
 id : '3445', 
 name : 'Elfrida', 
 category : ['Tiere', 'Großwild', 'Giraffen', 'Liebe Giraffen'], 
 price : '1723.60', 
 currency : 'EUR', 
 variants : {'Farbe' : 'gelb', 'Geschlecht' : 'weiblich', 'Figur' : 'dünn'}
};

// direkter Aufruf
etCommerce.sendEvent('viewProduct', product, 'Warenkorb 1') ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['button_ view']}, 'viewProduct', product, 'Warenkorb 1') ;

insertToWatchlist – Produkt zur Merkliste hinzugefügt

Dieses Event wird gesendet, wenn der Kunde seiner Merkliste ein Produkt hinzufügt.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter. Wird der Artikel direkt von einer Liste auf die Merkliste gesetzt, empfiehlt es sich, die Position und Quelle zu übergeben.

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('insertToWatchlist', product, 2 ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['insertButton']}, 'insertToWatchlist', product, 2) ;

removeFromWatchlist – Produkt von Merkliste entfernt

Mit Hilfe dieses Events kann festgestellt werden, welche Produkte wieder von der Merkliste entfernt wurden.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter.

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('removeFromWatchlist', product, 1) ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['removeButton']}, 'removeFromWatchlist', product, 1) ;

insertToBasket – Produkt in den Warenkorb gelegt

Dieses Event wird gesendet, wenn der Kunde seinem Warenkorb ein Produkt hinzufügt.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter. Wird der Artikel direkt von einer Liste in den Warenkorb gelegt, empfiehlt es sich, die Position und Quelle zu übergeben. 

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('insertToBasket', product, 2) ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['insertButton']}, 'insertToBasket', product, 2) ;

removeFromBasket – Produkt aus dem Warenkorb entfernt

Mit Hilfe dieses Events kann festgestellt werden, welche Produkte wieder aus einem Warenkorb entfernt wurden. 

Beispiele:

// direkter Aufruf
etCommerce.sendEvent('removeFromBasket', product, 1) ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['removeButton']}, 'removeFromBasket', product, 1) ;

order – Bestellung

Dieses Event übermittelt die gesamte Bestellung mit allen Bestelldaten und dem Warenkorb.

Beispiel:

// Definition des Bestell-Objekts
var order = 
{
 orderNumber : 'Bestellnummer 1',
 status : 'sale', 
 orderPrice : '1723.60',
 basket : {
 id : 'Warenkorb 1',
 products : [
 {
 product: {
 id : '3445', 
 name : 'Elfrida', 
 category : ['Tiere', 'Großwild', 'Giraffen', 'Liebe Giraffen'], 
 price : '1723.60',
 currency : 'EUR', 
 },
 quantity : 1
 }]
},
 customerGroup : 'Tierliebhaber',
 deliveryConditions : 'Großer Transport',
 paymentConditions : 'Sofortzahlung',
};

// direkter Aufruf
etCommerce.sendEvent('order', order) ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['orderButton']}, 'order', order) ;

orderConfirmation – Bestellung vom Status Lead in den Status Sale transferiert

Dieses Event wird gesendet, wenn z. B eine Bestellung bestätigt wurde. 

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('orderConfirmation', 'Bestellnummer 1');

// Als Event angehängt
etCommerce.attachEvent({'mousedown' :['cancelButton']}, 'orderConfirmation', 'Bestellnummer 1') ;

orderCancellation – Bestellung storniert

Dieses Event wird gesendet, wenn der Kunde die gesamte Bestellung storniert.

Beispiel:

// direkter Aufruf
etCommerce.sendEvent('orderCancellation', 'Bestellnummer 1') ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['cancelButton']}, 'orderCancellation', 'Bestellnummer 1') ;

orderPartialCancellation – Bestellung teilstorniert

Dieses Event wird gesendet, wenn nur einzelne Produkte einer Bestellung storniert werden.

Beispiel:

// Definition von Produkt-Objekten
var products = [
 {
 product : {
 id : '3445', 
 name : 'Elfrida', 
 category : ['Tiere', 'Großwild', 'Giraffen', 'Liebe Giraffen'], 
 price : '1723.60', 
 },
 quantity: 1
}
];

// direkter Aufruf
etCommerce.sendEvent('orderPartialCancellation', 'Bestellnummer 1' , products) ;

// Als Event angehängt
etCommerce.attachEvent({'mousedown' : ['partialButton']}, 'orderPartialCancellation', 'Bestellnummer 1' , products) ;

Event Objekte

Die Informationen zu den Produkten, den Warenkörben und den Bestellungen werden in JavaScript-Objekten abgelegt. Im Folgenden wird eine Aufstellung dieser Objekte und ihr Aufbau dargestellt.

Das Produkt-Objekt

Dieses Objekt definiert ein Produkt mit den dazugehörigen Attributen.

Beispiel:

// Definition eines Produkt-Objekts
var product = 
{
    id      : '3445', 
    name      : 'Elfrida', 
    category : ['Tiere', 'Großwild', 'Giraffen', 'Liebe Giraffen'], 
    price      : '1723.60', 
    currency : 'EUR', 
    variants : {'Farbe' : 'gelb', 'Geschlecht' : 'weiblich', 'Figur' : 'dünn'}
};

Das Warenkorb-Objekt

Bei einer Bestellung werden die bestellten Produkte in einem Warenkorb-Objekt abgelegt.

Das Array products enthält ein oder mehrere Objekte, die wiederum aus Produkt-Objekten und der jeweiligen Anzahl bestehen. Dieses Produkte-Array findet auch in einer Teilstornierung Verwendung.

Beispiel:

// Definition eines Warenkorb-Objekts mit Produkte-Array
var basket = 
{
 id : '3',
 products : [
 {
 product: {
 …
 },
 quantity : 2
 },
 {
 product: {
 …
 },
 quantity : 1
 }
 ]
};

Das Bestell-Objekt

Das Objekt der Bestellung enthält sämtliche Bestelldaten und das Warenkorb-Objekt.

Hinweis: Parameter in eckigen Klammern [ ] sind optionale Parameter.

Beispiel:

// Definition eines Bestell-Objekts
var order = 
{
 orderNumber : '234',
 status : 'sale', 
 orderPrice : '5447.2',
 currency : 'EUR', 
 basket : {Warenkorb-Objekt},
 customerGroup : ‘Tierliebhaber’,
 deliveryConditions : 'Großer Transport',
 paymentConditions : 'Sofortzahlung',
}

Anwendungsbeispiele

Die Anwendungsbeispiele verdeutlichen, wie die verschiedenen Events für ausgewählte Aktionen auf der Website an etracker gesendet werden können.

Produktseite angesehen

Beim Aufrufen einer Produktseite sollen die Produktinformationen sofort an etracker übermittelt werden. Dafür wird ein Produkt-Objekt definiert. Die Daten werden über die sendEvent-Funktion direkt übermittelt.

Beispiel:

var et_Commerce_basketId = '3';
var et_Commerce_product = 
{
    id      : '3445', 
    name      : 'TV 47 Zoll Special Angebot', 
    category : [‘TV’, 'LCD', '47', 'Special'], 
    price      : '1723.60', 
};
 
// Produkt gesehen 
etCommerce.sendEvent('viewProduct', et_Commerce_product, et_Commerce_basketId);

Produkt in den Warenkorb gelegt

Um Produkte zu erfassen, die in den Warenkorb gelegt werden (durch Klicken auf einen in den Warenkorb legen-Button), ist ein Event zu definieren, das sich an den vorhandenen Button hängt. Zuvor muss ein Produkt-Objekt definiert werden, das die Produktdaten enthält. Die ID des Buttons lautet in diesem Fall ButtonAddToBasket und die Datenübermittlung erfolgt, wenn das JavaScript-Event mousedown ausgelöst wird. Die Anzahl der erfassten Produkte ergibt sich aus einem auf der Webseite hinterlegten Formularfeld ProductQuantity.

Beispiel:

var et_Commerce_basketId = '3';

var et_Commerce_product = 
{
 id : '3445', 
 name : 'TV 47 Zoll Special Angebot', 
 category : [‘TV’, 'LCD', '47', 'Special'], 
 price : '1723.60', 
};

Var et_Commerce_quantity = Number(document.getElementById('ProductQuantity').value) ;

etCommerce.attachEvent({'mousedown' : ['ButtonAddToBasket']}, 'insertToBasket', et_Commerce_product, et_Commerce_quantity, et_Commerce_basketId);

Produkt aus dem Warenkorb entfernen

Um die Information zu übermitteln, dass der Kunde ein Produkt wieder aus dem Warenkorb genommen hat, muss das Event removeFromBasket aufgerufen werden. Die Daten werden über die sendEvent Funktion direkt übermittelt.

Beispiel:

var et_Commerce_basketId = '3';

var et_Commerce_product = 
{
 id : '3445', 
 name : 'TV 47 Zoll Special Angebot', 
 category : [‘TV’, 'LCD', '47', 'Special'], 
 price : '1723.60', 
};

etCommerce.sendEvent('removeFromBasket', et_Commerce_product, 1, et_Commerce_basketId]);

Eine Bestellung beim Klick absenden

Um eine Bestellung direkt beim Klicken auf den Bestellknopf an etracker zu melden, benötigt man ein Event order, das an den Button sendOrder angehängt wird. Die Daten werden über die sendEvent Funktion direkt übermittelt.

Beispiel:

var basket = 
{
id : '3',
products : [
{
 product: 
 {
 id : '3445', 
 name : 'Elfrida', 
 category : ['Tiere', 'Großwild', 'Giraffen', 'Liebe Giraffen'], 
 price : '1723.60', 
 },
 quantity : 1
}]
}

var order = 
{
 orderNumber : '234',
 status : 'sale', 
 orderPrice : '5447.2',
 basket : basket,
 customerGroup : ‘Tierliebhaber’,
 deliveryConditions : 'Großer Transport',
 paymentConditions : 'Sofortzahlung',
}

etCommerce.attachEvent( {'mousedown' : ['sendOrder']}, 'order', order);

Change log

Hier sind die Änderungen an der Schnittstelle aufgelistet. Die Anwendungsbeispiele verdeutlichen, wie die verschiedenen Events für ausgewählte Aktionen auf der Webseite an etracker gesendet werden können.

Version 1.1.1

• Fehler im Debug-Modus behoben
• Die Definition von Objekten, die bei einem gewissen Browser-Event ausgelöst werden, hat sich geändert (attachEvent Funktion). Ab jetzt können pro Browser-Event verschiedene Objekt-IDs in einem Array definiert werden.

// Alte Darstellungsform
etCommerce.attachEvent({'mousedown' : 'partialButton'}, 'orderPartialCancellation', 'Bestellnummer 1' , products);

// Neue Darstellungsform mit Array
etCommerce.attachEvent({'mousedown' : ['partialButton', ‘partialButton2’]}, 'orderPartialCancellation', 'Bestellnummer 1' , products);

Version 1.1.3

• Typographie-Fehler in Code-Beispielen behoben („onmousedown“ geändert in „mousedown“).