SNAnalytics : Client

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Die SNAnalytics- API bietet Methoden zum Übertragen von anwenderdefinierten Analytics-Daten (Ereignisse, Seiten und Anwendereigenschaften) an das Dashboard User Experience Analytics für Serviceportal.

    User Experience Analytics für Serviceportal bietet Dashboard-Ansichten für die Überwachung der Leistungskennzahlen (Key Performance Indicators, KPIs) von Webanwendungen, die auf Serviceportalbasieren. Sie können diese Einblicke verwenden, um Ihr Portal zu optimieren. User Experience Analytics verfolgt beispielsweise, wenn ein Benutzer ein Katalogelement bestellt oder einen Wissensartikel anzeigt. Sie können diese Daten verwenden, um abzuleiten, welche Elemente oder Artikel bei Anwendern 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 Service snAnalytics Angular 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 for Service Portal.

    SNAnalytics – addEvent(Object payload)

    Speichert die angegebenen Ereignisinformationen im Analytics Data Store.

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

    Im Folgenden finden Sie 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);

    Der Screenshot unten zeigt die Informationen, die im Analytics-Dashboard für das Ereignis „Account verwalten“ angezeigt werden. Die Zeitleiste oben zeigt an, wie oft das Ereignis aufgetreten ist. Die Kreisdiagramme unter der Zeitleiste spiegeln die Eigenschaften wider, die im Aufruf von addEvent() erfasst wurden. Dashboard mit Ereignissen

    Wenn Sie erfassen möchten, wann Benutzer auf eine Webseite zugreifen, verwenden Sie die Methode SNAnalytics – startPage(Zeichenfolgenname, Zeichenfolgenbeschreibung) 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
}
    payload.data 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 Eigenschaft „Seiten-ID“ wird im Dashboard für alle Basissystemereignisse immer zuerst 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 „yes“: Boolescher Wert „wahr“
    • Zeichenfolgenwert „Nein“: Boolescher Wert „falsch“.

    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. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Methode addEvent() 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(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 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 „yes“: Boolescher Wert „wahr“
    • Zeichenfolgenwert „Nein“: Boolescher Wert „falsch“.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Keine

    In diesem Beispiel wird gezeigt, wie der Tags -Eigenschaft TV hinzugefügt wird.

    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 Wert der angegebenen Anwendereigenschaft um den angegebenen Zahlenwert im Analytics-Datenspeicher.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der zu inkrementierenden 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 Nachfrist um 5 erhöht wird.

    snAnalytics.incUserProperty('Grace days', 5)

    SNAnalytics – entfernenUserProperty(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 Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Keine

    Im folgenden Beispiel wird gezeigt, 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 Benutzersitzung angezeigt (siehe Abbildung unten). Wenn eine Eigenschaft im Analytics-Datenspeicher bereits 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 eine NULL sein.

    		 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 „yes“: Boolescher Wert „wahr“
    • Zeichenfolgenwert „Nein“: Boolescher Wert „falsch“.
    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(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 Benutzersitzung angezeigt (siehe Abbildung unten). Wenn eine Eigenschaft im Analytics-Datenspeicher bereits 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 Eigenschaftswerts darf 300 Byte nicht überschreiten.
    Wert Anwendereigenschaft

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

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

    Das folgende Beispiel zeigt, wie die Eigenschaft Unternehmenfestgelegt wird.

    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 Benutzersitzung und im Analytics-Dashboard angezeigt. Rufen Sie diese Methode in Ihren anwenderdefinierten 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 getaggt. Verwenden Sie diese Methode für anwenderdefinierte Szenarien, z. B. ein anwenderdefiniertes Widget mit einer 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 in der Zeitleiste und im Analytics-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');