SNAnalytics – Client

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer

    • Die SNAnalytics Die API bietet Methoden zum Verschieben anwenderdefinierter Analytics-Daten (Ereignisse, Seiten und Anwendereigenschaften) an den User Experience Analytics Für Serviceportal Dashboard.

    User Experience Analytics Für Serviceportal Stellt Dashboard-Ansichten zur Überwachung der Leistungskennzahlen (Key Performance Indicators, KPIs) von Webanwendungen bereit, die auf basieren Serviceportal. Sie können diese Einblicke verwenden, um Ihr Portal zu optimieren. Beispiel: User Experience Analytics Verfolgt, wann ein Anwender ein Katalogelement bestellt oder einen wissensartikel anzeigt. Sie können diese Daten verwenden, um abzuleiten, welche Elemente oder Artikel bei Anwendern am beliebtesten sind.

    Um auf diese API zuzugreifen, muss das Plugin „Serviceportal Analytics“ (com.glide.service-portal.analytics) in der Instanz aktiviert sein. Darüber hinaus müssen Sie innerhalb Ihrer Anwendung den snAnalytics Angular-Service importieren, z. B.:

    <client_script><![CDATA[function($rootScope, $scope, $window, $timeout, spUtil, $sce, spModal, $uibModal, $location, cabrillo, snAnalytics)

    Weitere Informationen finden Sie unter User Experience Analytics für Serviceportal .

    SNAnalytics – addEvent(Objektnutzlast)

    Speichert die angegebenen Ereignisinformationen im Analytics-Datenspeicher.

    Ereignisse sind Aktionen, die von einem Anwender ausgeführt werden, z. B. Klicken auf eine Schaltfläche oder Senden eines Formulars. Rufen Sie diese Methode in Ihrem Webseiten-Widget auf, wenn Sie eine Anwenderaktion erfassen möchten. Diese Ereignisse werden dann automatisch in der zugehörigen Zeitleiste der Anwendersitzung und im User Experience Analytics-Dashboard angezeigt.

    Im Folgenden finden Sie ein Beispiel für eine Nutzlast, die in einem übergeben wurde AddEvent() Anruf:
    var payload= {};
payload.name = "Manage Account";
payload.data = {};
payload.data["Function Name"] = c.data.function_name;
payload.data["User Type"] = c.data.user_type;
payload.data["Company"] = c.data.company_name;
snAnalytics.addEvent(payload);

    Die folgende Bildschirmaufnahme zeigt die Informationen, die im Analytics-Dashboard für das Ereignis „Account verwalten“ angezeigt werden. Die Zeitleiste oben stellt die Anzahl der Auftretungen des Ereignisses dar. Die Kreisdiagramme unter der Zeitleiste spiegeln die Eigenschaften wider, die in erfasst wurden AddEvent() Rufen Sie an. Dashboard mit Ereignissen

    Wenn Sie erfassen möchten, wann Anwender auf eine Webseite zugreifen, verwenden Sie SNAnalytics – Startpage (Zeichenfolgenname, Zeichenfolgenbeschreibung) Methode anstelle dieser Methode.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Nutzlast Objekt Ereignis, das im Analytics-Datenspeicher gespeichert werden soll.

    Datentyp: Objekt

    "payload": {
  "data": [Array],
  "name": String
}
    Nutzlast.Daten Array

    Jedes Element kann eine Zeichenfolge (Groß-/Kleinschreibung beachten), ein boolescher Wert, eine Zahl oder ein Datum sein.

    		 Optional. Name-Wert-Paare von anwenderdefinierten Ereigniseigenschaften. Diese Eigenschaften können beliebige Werte sein, die Sie nachverfolgen und im Analytics-Dashboard anzeigen möchten. Sie werden unter der zugehörigen Ereigniszeitleiste im Analytics-Dashboard angezeigt. Die Seiten-Id Eigenschaft wird für alle Basissystemereignisse immer zuerst im Dashboard angezeigt, und alle anderen Eigenschaften sind alphabetisch sortiert.

    Wenn für ein Ereignis keine Eigenschaften erforderlich sind, wird im Analytics-Dashboard nur eine Ereigniszeitleiste angezeigt. Eigenschaften können zu einem späteren Zeitpunkt hinzugefügt werden.

    Die folgenden Werte werden mit dieser Methode automatisch konvertiert:
    • Zeichenfolgenwert von „Ja“: Boolescher Wert von „wahr“
    • Zeichenfolgenwert von „no“: Boolescher Wert von „false“

    Standardwert: Null
    payload.name Zeichenfolge Beschreibender Name des Ereignisses. Sonderzeichen sind nicht zulässig.

    Maximale Länge: Die Länge des Ereignisnamens und -Werts darf 300 Byte nicht überschreiten.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie aufrufen AddEvent() Methode während der Initialisierung eines Widgets.

    function initialize() {
  c.options.glyph = c.options.glyph || 'search';
  c.options.title = c.options.title || c.data.searchMsg;
  c.options.color = c.options.color || "default";
  c.searchTerm = c.data.q;
  c.searchQuery = "";
  c.pageID = $scope.page && $scope.page.id;
  c.showSuggestions =  c.data.searchTypeBehavior === "suggestions" && c.data.isSuggestionsEnabled === "true";
  c.suggestionsLimit = c.options.limit || "";
  c.latitude = null;
  c.longitude = null;
  c.isLocationTrackerDisabled = c.data.isLocationTrackerDisabled === "true";
  c.isTypeAheadEnabled = c.data.isTypeAheadEnabled === "true";

  c.sendAnalytics = function(type){
    var payload= {};
    payload.name = "Initiate Search";
    payload.data = {};
    payload.data["Keyword"] = (type == 'User Entered' ? c.searchTerm : c.searchQuery);
    payload.data["Type"] = type;
    snAnalytics.addEvent(payload);
  };
}

    SNAnalytics – appendToUserProperty(Zeichenfolgenname, Zeichenfolgenwert)

    Hängt die angegebene Zeichenfolge an die angegebene Anwenderzeichenfolgeneigenschaft im Analytics-Datenspeicher an.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    name Zeichenfolge oder Zeichenfolge[] Name der Eigenschaft, an die die angegebene Zeichenfolge angehängt werden soll. Sonderzeichen sind nicht zulässig.
    Hinweis:
    Die zugeordnete Eigenschaft muss eine Zeichenfolge oder Zeichenfolge[] sein.

    Maximale Länge: Die Länge des Eigenschaftsnamens und des Eigenschaftswerts darf 300 Byte nicht überschreiten.
    Wert Zeichenfolge Wert, der an die Zeichenfolgeneigenschaft angehängt werden soll.
    Die folgenden Werte werden mit dieser Methode automatisch konvertiert:
    • Zeichenfolgenwert von „Ja“: Boolescher Wert von „wahr“
    • Zeichenfolgenwert von „no“: Boolescher Wert von „false“
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt, wie hinzugefügt wird Fernsehen Zu Tags Eigenschaft.

    snAnalytics.setUserProperties({
  level: 7,
  lastPurchase: new Date(),
  lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
  isPremium: true,
  tags: ['chair', 'table'],
});

// Append television to the tags property (now 'tags' will have 'chair', 'table', and 'television')
snAnalytics.appendToUserProperty('tags', 'television');

    SNAnalytics – incUserProperty(Zeichenfolgenname, Zahlenwert)

    Erhöht oder verringert den angegebenen Anwendereigenschaftswert mit dem angegebenen Zahlenwert im Analytics-Datenspeicher.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der zu erhöhenden Eigenschaft. Bei Wert wird zwischen Groß- und Kleinschreibung unterschieden.
    Hinweis:
    Die zugeordnete Eigenschaft muss eine Zahl sein.
    Wert Anzahl Betrag, um den die Eigenschaft erhöht werden soll. Wenn Sie eine negative Zahl eingeben, wird der Wert verringert.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Eigenschaft erhöht wird Nachfrist Tage Bis 5.

    snAnalytics.incUserProperty('Grace days', 5)

    SNAnalytics – removeUserProperty(Zeichenfolgenname)

    Entfernt die angegebene Eigenschaft für den aktuellen Anwender aus dem Analytics-Datenspeicher.

    Außerdem wird die Eigenschaft nicht mehr im Analytics-Dashboard angezeigt.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der zu entfernenden Eigenschaft. Bei Wert wird zwischen Groß- und Kleinschreibung unterschieden.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Eigenschaft IsAdmin entfernt wird.

    snAnalytics.removeUserProperty('IsAdmin');

    SNAnalytics – setUserProperties (Objekteigenschaften)

    Legt die angegebenen Eigenschaften mit den angegebenen Werten für den aktuellen Anwender im Analytics-Datenspeicher fest.

    Diese Eigenschaften werden im Analytics-Datenspeicher gespeichert und auf der Detailseite der Anwendersitzung angezeigt, wie unten dargestellt. Wenn bereits eine Eigenschaft im Analytics-Datenspeicher vorhanden ist, wird der aktuelle Wert mit dem neuen Wert überschrieben.

    Sitzungsseite mit Eigenschaften

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Eigenschaften Objekt

    Jedes Element in diesem Objekt kann eine Zeichenfolge, ein boolescher Wert, eine Zahl, ein Datum, eine Zeichenfolge[], oder null.

    		 Objekt, das die Name-Wert-Paare der festzulegenden Anwendereigenschaften enthält, z. B.:
    {
  level: 7,
  lastPurchase: new Date(),
  lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
  isPremium: true,
  tags: ['chair', 'table'],
}
    Die folgenden Werte werden mit dieser Methode automatisch konvertiert:
    • Zeichenfolgenwert von „Ja“: Boolescher Wert von „wahr“
    • Zeichenfolgenwert von „no“: Boolescher Wert von „false“
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie mehrere Eigenschaften für den aktuellen Anwender festgelegt werden.

    snAnalytics.setUserProperties({
  level: 7,
  lastPurchase: new Date(),
  lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
  isPremium: true,
  tags: ['chair', 'table'],
});

    SNAnalytics – setUserProperty(Zeichenfolgenname, UserProperty-Wert)

    Legt die angegebene Eigenschaft mit dem angegebenen Wert für den aktuellen Anwender im Analytics-Datenspeicher fest.

    Diese Eigenschaften werden im Analytics-Datenspeicher gespeichert und auf der Detailseite der Anwendersitzung angezeigt, wie unten dargestellt. Wenn bereits eine Eigenschaft im Analytics-Datenspeicher vorhanden ist, wird der aktuelle Wert mit dem neuen Wert überschrieben.

    Sitzungsseite mit Eigenschaften

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der zu aktualisierenden Eigenschaft. Dieser Name wird als Bezeichnung für die Eigenschaft angezeigt. Beispiel: Im vorherigen Screenshot Domäne, Instanzname, Unternehmen, Rolle, und Anwendertyp sind alle Namensparameter. Sonderzeichen sind nicht zulässig.

    Maximale Länge: Die Länge des Eigenschaftsnamens und des Eigenschaftswerts darf 300 Byte nicht überschreiten.
    Wert Anwendereigenschaft

    Dieser Wert kann eine Zeichenfolge, ein boolescher Wert, eine Zahl, ein Datum, eine Zeichenfolge[], oder null.

    		 Wert, der in der angegebenen Eigenschaft festgelegt werden soll.
    Die folgenden Werte werden mit dieser Methode automatisch konvertiert:
    • Zeichenfolgenwert von „Ja“: Boolescher Wert von „wahr“
    • Zeichenfolgenwert von „no“: Boolescher Wert von „false“
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Eigenschaft festgelegt wird Unternehmen .

    snAnalytics.setUserProperty('Company', "ABC Company")

    SNAnalytics – Startpage (Zeichenfolgenname, Zeichenfolgenbeschreibung)

    Speichert den Namen und die Beschreibung einer Seite im Analytics-Datenspeicher.

    Diese Informationen werden in der Zeitleiste der Anwendersitzung und im Analytics-Dashboard angezeigt. Rufen Sie diese Methode in Ihren anwenderdefinierten Widgets auf, um die von einem Anwender aufgerufenen Seiten nachzuverfolgen. Sie können diese Methode auch verwenden, um die Anwendernavigation auf einer einzelnen Seite nachzuverfolgen. Weitere Informationen finden Sie unter Exploring User Experience Analytics.
    Hinweis:
    Im Allgemeinen werden Portalseiten automatisch mit dieser Nachverfolgungsfunktion versehen. Verwenden Sie diese Methode für anwenderdefinierte Szenarien, z. B. ein einzelseitiges anwenderdefiniertes Widget in einem Assistentenszenario.

    Seiteneigenschaften in der Zeitleiste

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Beschreibender Name der Seite oder des Seitenabschnitts. Sonderzeichen sind nicht zulässig.
    Beschreibung Zeichenfolge Optional. Beschreibung der Seite, die in der Zeitleiste und dem Analytics-Dashboard angezeigt werden soll.

    Standard: nameParameterwert
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie aufrufen Startseite () Methode.

    snAnalytics.startPage('login_view', 'Login');