Motivation
Die lxo Campaign Library ist entstanden, um das Tracking der Kampagnen über die drei Parameter cid, pid und pdata zu vereinheitlichen.
Die Bilbiothek durchsucht auf der einbindenen Seite alle Links welche in Richtung app.lexoffice.de gehen und erweitert diese durch etwaig vorhandene Kampagnenparameter (CID, PID & PDATA).
Sie hält sich an die im Dokument cid/pid/pdata-Tracking: Handling + User Journey festgelegten Prinzipien und Fallbacks.
Das von der Library geschriebene Cookie lxoCampaign halt die Daten Subdomain übergreifend sofern auf allen Subdomains die Library zum Einsatz kommt.
Damit wird ein sauberes Kampagnentracking über die verschiedenen *.lexoffice.de Subdomains gewährleistet.
Externe Domains also welche die außerhalb von .lexoffice.de liegen, wie zB lexware-mac.de, fungieren hier wiederum als Inseln. Dh innerhalb der eigenen Domain werden Kampagnenparameter ausgetauscht. Beim Sprung auf eine .lexoffice.de Domain kann auf diese Daten nicht zugegriffen werden.
Die Library muss per <script> eingebunden werden. Das unten dargestellte Beispiel zeigt eine Einbindung mit einer beispielhaften globalen Fallback CID fallback-1234.
1. Initialisierung im <head> des HTML Dokuments
<script src='https://app.lexoffice.de/lxo-campaign/lxoCampaign.js'></script>Die Library wird dabei nicht direkt von dieser URL, sondern aus einem S3 Bucket geladen. Der dazu nötige Redirect wird transparent vom Browser gehandelt.
2. Definition der globalen Fallback CID. Muss auch ins HTML Dokument zB am Ende des <body> kopiert werden.
<script type='text/javascript'>
window.LxoCampaignDefaults = window.LxoCampaignDefaults || {};
window.LxoCampaignDefaults.domainCid = 'fallback-1234';
</script>Um die Erzeugung der Code Snippets zu erleichtern ist unter Generator ein Tool zum Erstellen der Snippets vorhanden.