Dokumentation

Die Campaign Library liefert neben den Funktionen welche automatisch durch das Einbinden des Skripts getriggered werden noch zusätzlliche Möglichkeiten auf diese hier kurz eingegangen werden soll.

Fallback-CID

Die Bibliothek ermöglicht den Einsatz von Default-CID Werten. Sollte ein Nutzer auf eine Seite mit eingebundener Campaign Lib gelangen ohne irgendwelche CID Werte in der URL oder im Cookie mit sich zu bringen kann eine Standard-CID definiert werden welche in diesem Falle genutzt wird.

Die Default-CID wird wie auf der Startseite beschrieben per globalem Window LxoCampaignDefaults Objekt definiert. Es wird hier zwischen bei verschiedenen Defaults unterschieden:

• domainCid: Domainspezifische Fallback-CID die genutzt wird falls keine URL spezifische vorhanden ist.
• pageCid: URL-spezifische Fallback-CID für eine einzelne URL. Sie hat eine höhere Gewichtung als die domainCid und wird immer als Fallback CID genommen sollte sie gesetzt sein.

Generell macht es Sinn eine domainspezifische Fallback-CID mit der Initialisierung des Skript zusammen auf jeder Seite wo die Funktionalität der Campaign-Lib gewünscht ist zu setzen. Wird zusätzlich eine URL-spezifische Fallback-CID benötigt kann dies durch eine zusätzliche Definition ermöglicht werden (s. Beispiel).

Beispiel

//Initialisierung und setzen der Domainspezifischen Fallback-CID
<script src='https://app.lexoffice.de/lxo-campaign/lxoCampaign.js'></script>
<script type='text/javascript'>
  window.LxoCampaignDefaults = window.LxoCampaignDefaults || {};
  window.LxoCampaignDefaults.domainCid = 'domain-fallback-123';
</script>
//
// Eventuell weiteres HTML
//
//Setzen der URL-spezifischen Fallback CID
<script type='text/javascript'>
  window.LxoCampaignDefaults = window.LxoCampaignDefaults || {};
  window.LxoCampaignDefaults.pageCid = 'page-fallback-123';
</script>
    

Forced CID

In manchen Fällen ist es sinnvoll Kampagnenparameter zu erzwingen. Für diesen Fall bietet die Campaign Lib die LxoCampaignEnforced

Das globale Window Objekt funktioniert analog zu den LxoCampaignDefaults. Ist LxoCampaignEnforced gesetzt, ist es gleichgültig ob ein Nutzer bereits Kampagnendaten mit sich trägt oder Fallbacks gesetzt sind, es werden immer die forcierten Werte genutzt. Die Kampagnenparameter (cid|pid|pdata) müssen nicht alle gesetzt werden. Es kann auch zB nur die pid gesetzt werden.

Beispiel

//Kampagnenparameter erzwingen
<script type='text/javascript'>
  window.LxoCampaignEnforced = window.LxoCampaignEnforced || {};
  window.LxoCampaignEnforced.cid = 'enforced-cid';
  window.LxoCampaignEnforced.pid = 'enforced-pid';
  window.LxoCampaignEnforced.pdata = 'enforced-pdata';
</script>

Debuggen der Campaign Lib

Die Campaign Lib bietet zwei wertvolle Tools zum Debuggen. Beide können über die JS Console des Browsers genutzt werden.

1. Logging: Um die Ausgabe des Logs über die Console zu aktivieren einfach lxoCampaignEnableLog als Parameter an die URL hängen zB https://www.lexoffice.de/funktionen/?lxoCampaignEnableLog
2. Aktuelle Kampagnendaten abrufen: Über den Befehl LxoCampaign.getCampaignData(); in der JS Console können die aktuell genutzten Kampagnenparameter abgerufen werden.