Page API
Aktiviere und deaktiviere Pages aus deinem eigenen Code mit dem API-Trigger.
Eine Page in ABlyft legt fest, auf welchen URLs ein Experiment läuft. Normalerweise prüft ABlyft Pages automatisch. Mit dem API-Trigger entscheidest du selbst, wann eine Page geprüft wird, indem du das Snippet aus deinem Code aufrufst. Das ist nützlich, wenn ein Zustand deiner Website nicht an der URL erkennbar ist, zum Beispiel ein Schritt im Checkout, der die Adresse nicht ändert.
Zum Konzept von Pages und URL-Regeln siehe Pages & URL-Targeting.
Eine Page für die API einrichten
- Öffne die Page (in deinem Project unter Pages) und suche den Bereich Trigger.
- Wähle bei Trigger die Option API (manual activation by an API / JavaScript call).
- Öffne Advanced Settings und prüfe den API Name. Er darf Buchstaben, Zahlen, Bindestriche und Unterstriche enthalten und muss im Project eindeutig sein. Dieser Name identifiziert die Page in deinem Code.
- Kopiere den Code aus API trigger code. Er aktualisiert sich mit dem API Name, den du eingibst.
<script>
window['ablyft'] = window['ablyft'] || [];
window['ablyft'].push({
eventType: 'activatePage',
pageApiName: 'checkout-step-2'
});
</script>checkout-step-2 ist ein Beispiel für einen API Name.
Das Feld API Name wird bei jedem Trigger angezeigt, daher kannst du activatePage auch für Pages mit einem anderen Trigger aufrufen.
Der API trigger code wird nur angezeigt, wenn der Trigger API ist.
Eine Page aktivieren
Rufe activatePage mit dem API Name oder der ID der Page auf. Wenn du beides übergibst, wird die ID verwendet.
// By API name
ablyft.push({ eventType: 'activatePage', pageApiName: 'checkout-step-2' });
// By ID
ablyft.push({ eventType: 'activatePage', pageId: 12345678 });Beim Aufruf prüft das Snippet wie gewohnt die URL-Regeln und Bedingungen der Page. Wenn sie zutreffen, wird die Page aktiv, ihre Pageview-Goals werden ausgelöst und die Experiments auf der Page werden ausgewertet. Ist die Page bereits aktiv, wird der Aufruf ignoriert.
Existiert die Page nicht, wird ein Fehler in der Konsole protokolliert.
Eine Page deaktivieren
ablyft.push({ eventType: 'deactivatePage', pageApiName: 'checkout-step-2' });Was passiert, hängt vom Deactivation Mode der Page ab. Das Reset-
JavaScript ihrer Experiments läuft in den Modi Reset und Force-reset. Im Modus Persistent hat ein deactivatePage-Aufruf
keine Wirkung: Die Page wird nie deaktiviert.
Aufruf vor dem Laden des Snippets
push-Aufrufe funktionieren bereits, bevor das Snippet geladen ist, weil sie in eine Warteschlange gestellt werden. Siehe
die JavaScript API.
Reference
Siehe activatePage / deactivatePage in der push-Reference.