ablyft.get()
Lies Project-Daten und den Laufzeitzustand aus dem Snippet.
ablyft.get(type, argument?) gibt je nach type Daten zurück. Ein unbekannter Typ protokolliert ABlyft - Unknown API type in der Konsole und gibt undefined zurück.
type | Rückgabe |
|---|---|
data | Grundlegende Informationen zu Project und Snippet |
activePageIds | IDs der aktuell aktiven Pages |
activeExperimentIds | Aktuell aktive Experiments |
pingedGoals | Goals, die beim Testen im Preview- oder QA-Modus erfasst wurden |
pages / experiments / goals | Rohdatenlisten des Projects |
variationById / goalById | Eine einzelne Variation oder ein einzelnes Goal |
trackingConsentEnabled | Gespeicherter Consent-Zustand |
deviceType | Gerätetyp des Visitors |
bucketing | Variation-Zuweisung des Visitors |
preview_bucketing | Über den Preview-Modus ausgewählte Variations |
tools | Das Tools-Objekt |
data
Objekt mit den folgenden Werten:
| Property | Bedeutung |
|---|---|
projectId | Das Project, zu dem das Snippet gehört. |
version | Die Snippet-Version. |
revision | Die Publication-Nummer. Sie steigt mit jeder Publication. Vergleiche sie mit Snippet revision in den Snippet-Einstellungen, um zu sehen, ob du die neueste Version erhältst. |
goalsEnabled | false bedeutet, dass Goals nicht gezählt werden, was im Preview-Modus der Fall ist. |
isPreview | true, wenn der Preview-Modus aktiv ist. |
optedOut | true, wenn du in diesem Browser ein Opt-out durchgeführt hast. |
storage | Wo das Snippet Daten speichert (default oder eine benutzerdefinierte Einstellung). |
const data = ablyft.get('data');
console.log(data.projectId, data.version, data.revision);activePageIds
const pageIds = ablyft.get('activePageIds'); // e.g. [12345678]activeExperimentIds
const experiments = ablyft.get('activeExperimentIds');
console.log(experiments);pingedGoals
Goals, die während der aktuellen Browser-Session erfasst wurden, während du im Preview- oder QA-Modus testest (gelesen aus sessionStorage). In diesen Modi werden Goals aufgelistet, aber nicht an ABlyft gesendet. Gibt ein leeres Array zurück, wenn es keine gibt.
const goals = ablyft.get('pingedGoals');
console.log(`${goals.length} goals recorded in this session`);pages
const pages = ablyft.get('pages');experiments
const experiments = ablyft.get('experiments');goals
const goals = ablyft.get('goals');variationById
Erfordert die Variation-ID als zweites Argument; ohne sie wird nichts zurückgegeben.
const variation = ablyft.get('variationById', 98765432);goalById
Erfordert die Goal-ID als zweites Argument.
const goal = ablyft.get('goalById', 55555555);trackingConsentEnabled
Gibt true zurück, wenn der Consent erteilt wurde, false, wenn er abgelehnt wurde, und einen leeren Wert (nicht gesetzt), wenn der Visitor noch nicht entschieden hat.
Praktisch für die Consent-Regeln in den Project-Einstellungen, siehe Consent Manager.
if (ablyft.get('trackingConsentEnabled') === true) {
console.log('Tracking allowed');
}deviceType
const device = ablyft.get('deviceType'); // device type detected by the snippetbucketing
Objekt, das Experiment-IDs auf die Variation-IDs abbildet, denen der Visitor zugewiesen ist.
const bucketing = ablyft.get('bucketing');
// { "12345678": 98765432 }preview_bucketing
Über den Preview-Modus ausgewählte Variations, als Objekt, das Experiment-ID auf Variation-ID (Zahl) abbildet. Leeres Objekt, wenn der Preview-Modus nicht genutzt wird.
const preview = ablyft.get('preview_bucketing');tools
Dasselbe wie ablyft.getTools().
const tools = ablyft.get('tools');