Weitere Parameter für die manuelle Integration | Additional parameters for manual integration
Übermittlung von weiteren Daten
Damit Sie alle Funktionen von uptain nutzen können, übermitteln Sie bitte noch weitere Session-Daten:
Warenkorbwert | data-scv=”{{0 oder Warenkorbwert}}” |
Bestellnummer | data-ordernumber=”{{Bestellnummer}}” |
Erfolgreich bestellt | data-success=”{{1 oder 0}}” |
Kundengruppe | data-customergroup=”{{Kundengruppe}}” |
Verwendete Gutscheincode | data-usedvoucher=”{{Gutscheincode}}” |
Kundenumsatz | data-revenue=”{{Kundenumsatz}}” |
Sowie personenbezogene Daten für eine individualisierte Ansprache:
data-email=”{{E-Mail}}” | |
Titel | data-title=”{{Titel}}” |
Vorname | data-firstname=”{{Vorname}}” |
Nachname | data-lastname=”{{Nachname}}” |
Geschlecht | data-gender=”{{Geschlecht}}” |
Achten Sie dabei jedoch darauf, dass Sie nur E-Mail-Adressen und andere personenbezogene Daten übermitteln, bei denen Sie ein passendes Double Opt-In vorweisen oder Sie sicherstellen können, dass die jeweilige E-Mail des Besuchers die Anforderungen aus dem Paragraphen § 7 UWG Abs. 3 erfüllt. Sollte dies nicht gegeben sein oder möchten Sie für bestimmte Benutzer keine Aktivitäten von uptain durchführen, lassen Sie die Variable data-email einfach leer.
Darüber hinaus können Sie für den erweiterten Funktionsumfang weitere optionale Parameter übergeben, sofern dies gewünscht ist:
DIV-Tag für die Übermittlung der weiteren Daten
Bitte integrieren Sie folgendes DIV-Tag an der selben Stelle wie das Snippet und am besten direkt dahinter. Beachten Sie den folgenden Hinweis.
<div
id="__up_data_qp"
data-scv=”{{Warenkorbwert}}"
data-ordernumber=”{{Bestellnummer}}"
data-success=”{{1 oder 0}}"
data-email="{{E-Mail}}"
data-firstname=”{{Vorname}}"
data-lastname=”{{Nachname}}"
data-usedvoucher=”{{Gutscheincode}}"
data-customergroup=”{{Kundengruppe}}"
data-revenue="{{Kundenumsatz}}"
data-gender="{{Geschlecht}}"
data-title="{{Titel}}"
>
</div> |
Bei jedem Seitenaufruf wird das eingebettete JavaScript-Snippet ausgeführt und übermittelt alle im HTML-Tag bereitgestellten Daten. Allerdings müssen einige Daten zum Uptain übertragen werden, ohne dass eine neue Seite geladen werden muss, während der Benutzer auf derselben Seite bleibt. Beispielsweise bei Single Page Applications oder, wenn etwas in den Warenkorb gelegt wurde und die Seite nicht neu geladen wird oder die Produkte einer Kategorie oder einer Suchergebnisseite asynchron geladen werden.
Nachdem die aktualisierten Daten in das HTML-Tag geschrieben wurden, muss eine JavaScript-Funktion ausgeführt werden, um die Übertragung der Daten an uptain zu initiieren. In diesem Fall sollte folgende Funktion ausgeführt werden:
window._upEventBus.publish("uptain.readData");
An die Stelle der Werte in geschliffenen Klammern wie z.B. {{Warenkorbwert}} fügen Sie bitte die entsprechende Variable aus Ihrem Shop ein. Wie die entsprechende Variable in Ihrem Shop heißt, entnehmen Sie bitte aus der zugehörigen Dokumentation.
Erläuterungen zu den Variablen
data-scv
Hier übergeben Sie uns den aktuellen Warenkorbwert einer Session. Wenn der Kunde nichts im Warenkorb hat, übergeben Sie bitte die Zahl 0. Sobald der Kunde ein Produkt im Wert von z.B. 100 € legt, sollte “100.00” in der Variable stehen.
Bitte achten Sie darauf, dass auf der Dankesseite der Warenkorbwert erhalten bleibt oder als finaler Bestellwert übergeben wird. Auf der Dankesseite darf nicht “0.00” oder ein leerer Wert übergeben werden.
data-ordernumber
Hier übergeben Sie uns die jeweilige Bestellnummer nach erfolgreicher Bestellung. Dieser Wert darf nur auf der Dankesseite (Seite, auf der ein Kunde nach erfolgreicher Bestellung landet) übergeben werden.
data-success
Hier informieren Sie uns darüber, dass eine Bestellung erfolgreich durchgeführt wurde. Dieser Wert darf ebenfalls nur auf der Dankesseite mit 1 übergeben werden. Ansonsten übergeben Sie bitte eine 0 oder lassen den Wert leer.
data-email
Hier übergeben Sie uns die E-Mail-Adresse des eingeloggten Kunden. Beachten Sie bitte den Hinweis auf Datenschutz von oben.
data-firstname
Hier übergeben Sie uns den Vornamen des eingeloggten Kunden. Beachten Sie bitte den Hinweis auf Datenschutz von oben.
data-lastname
Hier übergeben Sie uns den Nachnamen des eingeloggten Kunden. Beachten Sie bitte den Hinweis auf Datenschutz von oben.
data-title
Als Freitext kann hier der Titel der Anrede (z.B. Dr. oder Prof.) Ihrer Webseitenbesucher übergeben werden.
data-gender
Sie können die Geschlechter Ihrer Webseitenbesucher übergeben. Wählen Sie zwischen m für männlich oder f für weiblich und lassen Sie das Feld für divers bitte leer.
data-customergroup
Sie können die in Ihrem Backend angelegten Kundengruppen übergeben.
data-revenue
Übergeben Sie uns den Kundenumsatz als Zahl und verwenden Sie dabei nur einen Punkt als Trennzeichen und nur und immer zwei Nachkommastellen.
data-usedvoucher
Übergeben Sie hier bitte den eingelösten Gutschein-Code spätestens auf der Dankesseite. Es ist wichtig, dass der tatsächlich eingegebene Gutschein übergeben wird und nicht eine interne Bezeichnung oder ähnliches. Achten Sie bitte auch auf die Groß- und Kleinschreibung.
Denken Sie bitte immer daran die Funktionalitäten selbständig zu testen, soweit es Ihnen möglich ist.
Additional parameters for manual integration
Transmission of additional data
To fully utilize all features of uptain, please also transmit additional session data:
Shopping Cart Value | data-scv=”{{0 oder Warenkorbwert}}” |
Order number | data-ordernumber=”{{Bestellnummer}}” |
Order successful | data-success=”{{1 oder 0}}” |
Customer group | data-customergroup=”{{Kundengruppe}}” |
Voucher code used | data-usedvoucher=”{{Gutscheincode}}” |
Customer revenue | data-revenue=”{{Kundenumsatz}}” |
As well as personal data for a personalized approach:
data-email=”{{E-Mail}}” | |
Titel | data-title=”{{Titel}}” |
First name | data-firstname=”{{Vorname}}” |
Surname | data-lastname=”{{Nachname}}” |
Gender | data-gender=”{{Geschlecht}}” |
However, please ensure that you only transmit email addresses and other personal data for which you can demonstrate appropriate double opt-in or ensure that the visitor's email meets the requirements of Paragraph § 7 UWG Abs. 3. If this is not the case or if you do not wish uptain to perform activities for certain users, simply leave the data-email variable empty.
Additionally, you can pass additional optional parameters for extended functionality if desired:
DIV tag for transmitting additional data
Please integrate the following DIV tag in the same location as the snippet, preferably directly after it. Please note the following information.
<div
id="__up_data_qp"
data-scv=”{{Shopping Cart Value}}"
data-ordernumber=”{{order number}}"
data-success=”{{1 or 0}}"
data-email="{{E-Mail}}"
data-firstname=”{{First Name}}"
data-lastname=”{{Surname}}"
data-usedvoucher=”{{Vouchercode}}"
data-customergroup=”{{customer group}}"
data-revenue="{{customer revenue}}"
data-gender="{{gender}}"
data-title="{{title}}"
>
</div> |
On each page load, the embedded JavaScript snippet runs and transmits all data provided in the HTML tag. However, certain data needs to be transferred to uptain without requiring a new page load while the user remains on the same page. This is necessary, for example, in Single Page Applications or when adding items to the cart without refreshing the page, or when products on a category or search results page load asynchronously.
After the updated data has been written into the HTML tag, a JavaScript function must be executed to initiate the transmission of data to uptain. In this case, the following function should be executed:
window._upEventBus.publish("uptain.readData");
Please replace the values in curly brackets such as {{ basket value}} with the corresponding variable from your shop. Refer to the associated documentation to find out the specific name of the variable in your shop.
Explanations of the variables
data-scv
Here you provide us with the current session's basket value. If the customer has nothing in their basket, it's best to leave the variable empty. Once the customer adds a product worth, for example, £100, the variable should show "100.00".
Please ensure that on the thank-you page, the basket value is retained or passed as the final order value. It should not be passed as "0.00".
data-ordernumber
Here you provide us with the respective order number after a successful order. This value may only be transferred on the thank you page (page where a customer lands after a successful order).
data-success
Here you inform us that an order has been successfully placed. This value should also only be passed as 1 on the thank-you page. Otherwise, please pass it as 0.
data-email
Here you provide us with the e-mail address of the logged-in customer. Please note the information on data protection mentioned above.
data-firstname
Here you provide us with the first name of the logged-in customer. Please note the information on data protection mentioned above.
data-lastname
Here you provide us with the surname of the logged-in customer. Please note the information on data protection mentioned above.
data-title
As custom text, you can pass the title of address (e.g., Dr. or Prof.) of your website visitors.
data-gender
You can transfer the gender of your website visitors. Choose between m for male or f for female and leave the field for diverse empty.
data-customergroup
You can transfer the customer groups created in your backend.
data-revenue
Pass the customer's revenue as a number, using a period as the decimal separator and always including two decimal places.
data-usedvoucher
Please enter the redeemed voucher code on the thank you page at the latest. It is important that the voucher actually entered is transferred and not an internal designation or similar. Please also note that the code is case-sensitive.
Please always remember to test the functionalities yourself to the extent possible.