SNAnalytics – Client

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 6 Minuten Lesedauer

    • Die SNAnalytics- API bietet Methoden zum Übertragen von benutzerdefinierten Analysedaten (Events, Seiten und Benutzereigenschaften) an das Dashboard „User Experience Analytics for Service Portal“.

    User Experience Analytics für Service Portal bietet Dashboard-Ansichten für die Überwachung der Leistungskennzahlen (KPIs) von Webanwendungen, die auf Service Portal basieren. Sie können diese Einblicke verwenden, um Ihr Portal zu optimieren. Beispielsweise verfolgt User Experience Analytics, wenn ein Benutzer ein Katalogelement bestellt oder einen Wissensartikel anzeigt. Sie können diese Daten verwenden, um abzuleiten, welche Elemente oder Artikel bei Benutzern am beliebtesten sind.

    Für den Zugriff auf diese API muss das Plugin „Service Portal Analytics“ (com.glide.service-portal.analytics) in der Instanz aktiviert sein. Darüber hinaus müssen Sie in 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 Service Portal.

    SNAnalytics – addEvent(Object payload)

    Speichert die angegebenen Event-Informationen im Analytics-Datenspeicher.

    Events sind Aktionen, die von einem Benutzer ausgeführt werden, z. B. das Klicken auf eine Schaltfläche oder das Senden eines Formulars. Rufen Sie diese Methode in Ihrem Webseiten-Widget auf, wenn Sie eine Benutzeraktion erfassen möchten. Diese Events werden dann automatisch in der zugehörigen Zeitleiste der Benutzersitzung und im Dashboard für Benutzer-Experience-Analysen angezeigt.

    Das Folgende ist ein Beispiel für eine Nutzlast, die in einem addEvent()- Aufruf übergeben wird:
    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 Screenshot-Aufnahme unten zeigt die Informationen, die im Analytics-Dashboard für das Event „Account verwalten“ angezeigt werden. Die Zeitleiste oben zeigt an, wie oft das Event aufgetreten ist. Die Kreisdiagramme unter der Zeitleiste spiegeln die Eigenschaften wider, die im addEvent()- Aufruf erfasst wurden. Dashboard mit Events

    Wenn Sie erfassen möchten, wann Benutzer auf eine Webseite zugreifen, verwenden Sie die Methode SNAnalytics – startPage(String name, String description) anstelle dieser Methode.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Nutzlast Objekt Event, 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 benutzerdefinierten Event-Eigenschaften. Diese Eigenschaften können beliebige Werte sein, die Sie nachverfolgen und im Analytics-Dashboard anzeigen möchten. Sie werden unter der zugehörigen Event-Zeitleiste im Analytics-Dashboard angezeigt. Die Seiten- ID -Eigenschaft wird im Dashboard für alle Basissystem-Events immer zuerst angezeigt, und alle anderen Eigenschaften werden alphabetisch sortiert.

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

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

    Standardwert: Null
    Nutzlast.Name Zeichenfolge Beschreibender Name des Ereignisse. Sonderzeichen sind nicht zulässig.

    Maximale Länge: Die Länge des Event-Namens und -Werts darf 300 Byte nicht überschreiten.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die addEvent()- Methode während der Initialisierung eines Widgets aufgerufen wird.

    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(String name, String value)

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

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge oder String[] 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 eine 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 von dieser Methode automatisch konvertiert:
    • Zeichenfolgenwert von „yes“: Boolescher Wert von „wahr“
    • Zeichenfolgenwert von „no“: Boolescher Wert von „false“.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt, wie Sie der Tags -Eigenschaft „ fernsehen “ hinzufügen.

    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(String name, Number value)

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

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

    Das folgende Beispiel zeigt, wie die Eigenschaft Toleranztage um 5 erhöht wird.

    snAnalytics.incUserProperty('Grace days', 5)

    SNAnalytics – removeUserProperty(String name)

    Entfernt die angegebene Eigenschaft für den aktuellen Benutzer 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. Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Keine

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

    snAnalytics.removeUserProperty('IsAdmin');

    SNAnalytics – setUserProperties(Object properties)

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

    Diese Eigenschaften werden im Analytics-Datenspeicher gespeichert und auf der Detailseite der Benutzersitzung angezeigt (siehe unten). Wenn im Analytics-Datenspeicher bereits eine Eigenschaft 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 sein.

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

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

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

    SNAnalytics – setUserProperty(String name, UserProperty value)

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

    Diese Eigenschaften werden im Analytics-Datenspeicher gespeichert und auf der Detailseite der Benutzersitzung angezeigt (siehe unten). Wenn im Analytics-Datenspeicher bereits eine Eigenschaft 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. Im vorherigen Screenshot sind beispielsweise Domäne, Instanzname, Unternehmen, Rolle und Benutzertyp Namensparameter. Sonderzeichen sind nicht zulässig.

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

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

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

    Das folgende Beispiel zeigt, wie die Eigenschaft Companyfestgelegt wird.

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

    SNAnalytics – startPage(String name, String description)

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

    Diese Informationen werden in der Zeitleiste der Benutzersitzung und im Analytics-Dashboard angezeigt. Rufen Sie diese Methode in Ihren benutzerdefinierten Widgets auf, um die von einem Benutzer besuchten Seiten nachzuverfolgen. Sie können diese Methode auch verwenden, um die Benutzernavigation auf einer einzelnen Seite nachzuverfolgen. Weitere Informationen finden Sie unter User Experience Analytics verwenden.
    Hinweis:
    Im Allgemeinen werden Portalseiten automatisch mit dieser Nachverfolgungsfunktion gekennzeichnet. Verwenden Sie diese Methode für benutzerdefinierte Szenarien, z. B. ein benutzerdefiniertes Widget für eine einzelne Seite 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 im Zeitleisten- und Analyse-Dashboard angezeigt werden soll.

    Standard: Parameterwert name .
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die startPage()- Methode aufgerufen wird.

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