SNAnalytics : Client
L’API SNAnalytics fournit des méthodes permettant de transmettre par push des données d’analyse personnalisées (événements, pages et propriétés utilisateur) vers le tableau de bord User Experience Analytics for Service Portal.
User Experience Analytics pour Service Portal fournit des vues de tableau de bord pour la surveillance des indicateurs clés de performance (KPI) des applications Web intégrées à Service Portal. Vous pouvez utiliser ces aperçus pour optimiser votre portail. Par exemple, User Experience Analytics effectue un suivi lorsqu’un utilisateur commande un élément de catalogue ou affiche un article de la base de connaissances. Vous pouvez utiliser ces données pour déduire quels éléments ou articles sont les plus populaires auprès des utilisateurs.
Pour accéder à cette API, le module d’extension Service Portal Analytics (com.glide.service-portal.analytics) doit être activé sur l’instance. En outre, au sein de votre application, vous devez importer le service snAnalytics Angular, tel que :
<client_script><![CDATA[function($rootScope, $scope, $window, $timeout, spUtil, $sce, spModal, $uibModal, $location, cabrillo, snAnalytics)Pour plus d’informations, consultez User Experience Analytics pour Service Portal.
SNAnalytics : addEvent(Charge utile de l’objet)
Stocke les informations sur l’événement spécifié dans le magasin de données d’analyse.
Les événements sont des actions effectuées par un utilisateur, comme cliquer sur un bouton ou soumettre un formulaire. Appelez cette méthode dans votre widget de page Web chaque fois que vous souhaitez capturer une action de l’utilisateur. Ces événements s’affichent ensuite automatiquement sur la chronologie de session utilisateur et le tableau de bord User Experience Analytics associés.
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);La capture d’écran ci-dessous montre les informations qui s’affichent sur le tableau de bord d’analyse pour l’événement « Gérer le compte ». La chronologie en haut représente le nombre de fois où l’événement s’est produit. Les graphiques à secteurs sous la chronologie reflètent les propriétés qui ont été capturées dans l’appel addEvent().
Si vous souhaitez capturer le moment où les utilisateurs accèdent à une page Web, utilisez cette SNAnalytics - startPage(nom de la chaîne, description de la chaîne) méthode au lieu de celle-ci.
| Nom | Type | Description |
|---|---|---|
| payload | Objet | Événement à stocker dans le magasin de données d’analyse. Type de données : objet |
| charge.données utiles | Tableau Chaque élément peut être une chaîne (sensible à la casse), un booléen, un nombre ou une date. |
Facultatif. Paires nom-valeur des propriétés d’événements personnalisées. Ces propriétés peuvent être n’importe quelle valeur que vous souhaitez suivre et afficher sur le tableau de bord d’analyse. Ils apparaissent sous la chronologie des événements associée sur le tableau de bord d’analyse. La propriété ID de page apparaît toujours en premier sur le tableau de bord pour tous les événements du système de base, et toutes les autres propriétés sont triées par ordre alphabétique. Si aucune propriété n’est requise pour un événement, seule une chronologie d’événement s’affiche sur le tableau de bord d’analyse. Des propriétés peuvent être ajoutées ultérieurement. Cette méthode convertit automatiquement les valeurs suivantes :
Valeur par défaut : nul |
| payload.name | Chaîne | Nom descriptif de l’événement. Les caractères spéciaux ne sont pas autorisés. Longueur maximale : la longueur du nom et de la valeur de l’événement ne peut pas dépasser 300 octets. |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment appeler la méthode addEvent() lors de l’initialisation d’un widget.
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(nom de chaîne, valeur de chaîne)
Ajoute la chaîne spécifiée à la propriété de chaîne d’utilisateur spécifiée dans le magasin de données d’analyse.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne ou chaîne de caractères[] | Nom de la propriété à laquelle ajouter la chaîne spécifiée. Les caractères spéciaux ne sont pas autorisés. Remarque :
La propriété associée doit être une chaîne ou une chaîne []. Longueur maximale : la longueur du nom de propriété et de la valeur de propriété ne peut pas dépasser 300 octets. |
| valide | Chaîne | Valeur à ajouter à la propriété de chaîne. Cette méthode convertit automatiquement les valeurs suivantes :
|
| Type | Description |
|---|---|
| Néant |
Cet exemple montre comment ajouter tv à la propriété tags .
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(nom de chaîne, valeur numérique)
Incrémente ou décrémente la valeur de propriété d’utilisateur spécifiée avec la valeur numérique spécifiée dans le magasin de données d’analyse.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de la propriété à incrémenter. La valeur est sensible à la casse. Remarque : La propriété associée doit être un nombre. |
| valide | Numéro | Montant selon lequel incrémenter la propriété. Si vous entrez un nombre négatif, la valeur est décrémentée. |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment incrémenter la propriété de 5 jours de grâce .
snAnalytics.incUserProperty('Grace days', 5)SNAnalytics : removeUserProperty(nom de chaîne)
Supprime la propriété spécifiée pour l’utilisateur actuel à partir du magasin de données d’analyse.
En outre, la propriété n’apparaît plus sur le tableau de bord d’analyse.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de la propriété à supprimer. La valeur est sensible à la casse. |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment supprimer la propriété IsAdmin.
snAnalytics.removeUserProperty('IsAdmin');SNAnalytics : setUserProperties(propriétés de l’objet)
Définit les propriétés spécifiées avec les valeurs spécifiées pour l’utilisateur actuel dans le magasin de données d’analyse.
Ces propriétés sont enregistrées dans le magasin de données d’analyse et s’affichent sur la page des détails de la session utilisateur, comme illustré ci-dessous. Si une propriété existe déjà dans le magasin de données d’analyse, la valeur actuelle est remplacée par la nouvelle valeur.
| Nom | Type | Description |
|---|---|---|
| Propriétés de | Objet Chaque élément de cet objet peut être une chaîne de caractères, un booléen, un nombre, une date, une chaîne de caractères ou une valeur nulle. |
Objet contenant les paires nom-valeur des propriétés utilisateur à définir, par exemple :Cette méthode convertit automatiquement les valeurs suivantes :
|
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment définir plusieurs propriétés pour l’utilisateur actuel.
snAnalytics.setUserProperties({
level: 7,
lastPurchase: new Date(),
lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
isPremium: true,
tags: ['chair', 'table'],
});SNAnalytics : setUserProperty(nom de chaîne, valeur UserProperty)
Définit la propriété spécifiée avec la valeur spécifiée pour l’utilisateur actuel dans le magasin de données d’analyse.
Ces propriétés sont enregistrées dans le magasin de données d’analyse et s’affichent sur la page des détails de la session utilisateur, comme illustré ci-dessous. Si une propriété existe déjà dans le magasin de données d’analyse, la valeur actuelle est remplacée par la nouvelle valeur.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de la propriété à mettre à jour. Ce nom apparaît comme l’étiquette de la propriété. Par exemple, dans la capture d’écran précédente, Domaine, Nom d’instance, Société, Rôle et Type d’utilisateur sont tous des paramètres de nom. Les caractères spéciaux ne sont pas autorisés. Longueur maximale : la longueur du nom de propriété et de la valeur de propriété ne peut pas dépasser 300 octets. |
| valide | UserProperty Cette valeur peut être une chaîne, un booléen, un nombre, une date, une chaîne [] ou null. |
Valeur à définir dans la propriété spécifiée. Cette méthode convertit automatiquement les valeurs suivantes :
|
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment définir la société immobilière.
snAnalytics.setUserProperty('Company', "ABC Company")SNAnalytics - startPage(nom de la chaîne, description de la chaîne)
Enregistre le nom et la description d’une page dans le magasin de données d’analyse.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom descriptif de la page ou de la section de page. Les caractères spéciaux ne sont pas autorisés. |
| description | Chaîne | Facultatif. Description de la page à afficher dans le tableau de bord de chronologie et d’analyse. Par défaut : name valeur du paramètre |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment appeler la méthode startPage().
snAnalytics.startPage('login_view', 'Login');