SNAnalytics - Cliente

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 7 min. de leitura

    • A API SNAnalytics fornece métodos para enviar dados de análise personalizados (eventos, páginas e propriedades do usuário) para o painel Análise da experiência do usuário para Portal de serviços.

    Análise da experiência do usuário para Portal de serviços fornece exibições de painel para monitorar os principais indicadores de desempenho (KPIs) de aplicações web criadas em Portal de serviços. Você pode usar essas informações para otimizar seu portal. Por exemplo, Análise da experiência do usuário rastreia quando um usuário solicita um item do catálogo ou exibe um artigo de conhecimento. Você pode usar esses dados para inferir quais itens ou artigos são os mais populares entre os usuários.

    Para acessar esta API, o plug-in Análise do Portal de serviços (com.glide.service-portal.analytics) deve ser ativado na instância. Além disso, em sua aplicação, você deve importar o serviço angular snAnalytics, como:

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

    Para obter informações adicionais, consulte Análise da experiência do usuário para Portal de serviços.

    SNAnalytics - addEvent(carga do objeto)

    Armazena as informações do evento especificado no armazenamento de dados de análise.

    Eventos são ações realizadas por um usuário, como clicar em um botão ou enviar um formulário. Chame este método no widget da página da web sempre que quiser capturar uma ação do usuário. Esses eventos aparecem automaticamente na linha do tempo da sessão do usuário associada e no painel da Análise da experiência do usuário.

    A seguir está um exemplo de uma carga passada em uma chamada addEvent() :
    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);

    A captura de tela abaixo mostra as informações que aparecem no painel de análise do evento "Gerenciar conta". A linha do tempo na parte superior representa o número de vezes que o evento ocorreu. Os gráficos de pizza abaixo da linha do tempo refletem as propriedades que foram capturadas na chamada addEvent(). Painel com eventos

    Se você quiser capturar quando os usuários acessam uma página da Web, use o método SNAnalytics - startPage (nome da cadeia de caracteres, descrição da cadeia de caracteres) em vez deste método.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    carga Objeto Evento a ser armazenado no armazenamento de dados de análise.

    Tipo de dados: objeto

    "payload": {
  "data": [Array],
  "name": String
}
    carga.dados Matriz

    Cada elemento pode ser uma cadeia de caracteres (diferencia maiúsculas de minúsculas), booliano, número ou data.

    		 Opcional. Pares de nome-valor de propriedades de evento personalizado. Essas propriedades podem ser quaisquer valores que você deseja rastrear e ver no painel de análise. Eles aparecem na linha do tempo do evento associado no painel de análise. A propriedade ID da página sempre aparece primeiro no painel para todos os eventos do sistema de base e todas as outras propriedades são classificadas em ordem alfabética.

    Se nenhuma propriedade for necessária para um evento, somente uma linha do tempo de evento aparecerá no painel de análise. As propriedades podem ser adicionadas posteriormente.

    Os seguintes valores são convertidos automaticamente por este método:
    • Valor da cadeia de caracteres "yes": valor booliano de "true"
    • Valor da cadeia de caracteres "não": valor booliano de "falso"

    Valor padrão: nulo
    payload.name Cadeia de caracteres Nome descritivo do evento. Caracteres especiais não são permitidos.

    Tamanho máximo: o tamanho do nome e valor do evento não pode exceder 300 bytes.
    Tabela 2. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como chamar o método addEvent() durante a inicialização de um 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 (nome da cadeia de caracteres, valor da cadeia de caracteres)

    Anexa a cadeia de caracteres especificada à propriedade de cadeia de caracteres do usuário especificada no armazenamento de dados de análise.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres ou cadeia de caracteres[] Nome da propriedade à qual a cadeia de caracteres especificada será anexada. Caracteres especiais não são permitidos.
    Nota:
    A propriedade associada deve ser uma cadeia de caracteres ou uma cadeia de caracteres[].

    Tamanho máximo: o tamanho do nome e do valor da propriedade não pode exceder 300 bytes.
    valor Cadeia de caracteres Valor a ser anexado à propriedade da cadeia de caracteres.
    Os seguintes valores são convertidos automaticamente por este método:
    • Valor da cadeia de caracteres "yes": valor booliano de "true"
    • Valor da cadeia de caracteres "não": valor booliano de "falso"
    Tabela 4. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo mostra como adicionar TV à propriedade de marcadores.

    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 (cadeia de caracteres nome, valor numérico)

    Incrementa ou decrementa o valor da propriedade do usuário especificado com o valor numérico especificado no armazenamento de dados de análise.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da propriedade a ser incrementada. O valor faz distinção entre maiúsculas e minúsculas.
    Nota:
    A propriedade associada deve ser um número.
    valor Número Valor pelo qual a propriedade será incrementada. Se você inserir um número negativo, o valor será diminuído.
    Tabela 6. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como incrementar a propriedade Dias de carência em 5.

    snAnalytics.incUserProperty('Grace days', 5)

    SNAnalytics - removeUserProperty(cadeia de caracteres name)

    Remove a propriedade especificada para o usuário atual do armazenamento de dados de análise.

    Além disso, a propriedade não aparece mais no painel de análise.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da propriedade a ser removida. O valor faz distinção entre maiúsculas e minúsculas.
    Tabela 8. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como remover a propriedade IsAdmin.

    snAnalytics.removeUserProperty('IsAdmin');

    SNAnalytics - setUserProperties (propriedades do objeto)

    Define as propriedades especificadas com os valores especificados para o usuário atual no armazenamento de dados de análise.

    Essas propriedades são salvas no armazenamento de dados de análise e aparecem na página de detalhes da sessão do usuário, conforme ilustrado abaixo. Se uma propriedade já existir no armazenamento de dados de análise, o valor atual será substituído pelo novo valor.

    Página da sessão com propriedades

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    propriedades Objeto

    Cada elemento neste objeto pode ser uma cadeia de caracteres, booliano, número, data, cadeia de caracteres[] ou nulo.

    		 Objeto que contém os pares de nome-valor das propriedades do usuário a serem definidas, como:
    {
  level: 7,
  lastPurchase: new Date(),
  lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
  isPremium: true,
  tags: ['chair', 'table'],
}
    Os seguintes valores são convertidos automaticamente por este método:
    • Valor da cadeia de caracteres "yes": valor booliano de "true"
    • Valor da cadeia de caracteres "não": valor booliano de "falso"
    Tabela 10. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como definir várias propriedades para o usuário atual.

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

    SNAnalytics - setUserProperty(cadeia de caracteres nome, valor UserProperty)

    Define a propriedade especificada com o valor especificado para o usuário atual no armazenamento de dados de análise.

    Essas propriedades são salvas no armazenamento de dados de análise e aparecem na página de detalhes da sessão do usuário, conforme ilustrado abaixo. Se uma propriedade já existir no armazenamento de dados de análise, o valor atual será substituído pelo novo valor.

    Página da sessão com propriedades

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da propriedade a ser atualizada. Este nome aparece como o rótulo da propriedade. Por exemplo, na captura de tela anterior, Domínio, Nome da instância, Empresa, Função e Tipo de usuário são todos parâmetros de nome. Caracteres especiais não são permitidos.

    Tamanho máximo: o tamanho do nome e do valor da propriedade não pode exceder 300 bytes.
    valor PropriedadeDoUsuário

    Este valor pode ser uma cadeia de caracteres, booliano, número, data, cadeia de caracteres[] ou nulo.

    		 Valor a ser definido na propriedade especificada.
    Os seguintes valores são convertidos automaticamente por este método:
    • Valor da cadeia de caracteres "yes": valor booliano de "true"
    • Valor da cadeia de caracteres "não": valor booliano de "falso"
    Tabela 12. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como definir a propriedade Empresa.

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

    SNAnalytics - startPage (nome da cadeia de caracteres, descrição da cadeia de caracteres)

    Salva o nome e a descrição de uma página no armazenamento de dados de análise.

    Essas informações aparecem na linha do tempo da sessão do usuário e no painel de análise. Chame este método em seus widgets personalizados para rastrear as páginas visitadas por um usuário. Você também pode usar este método para rastrear a navegação do usuário em uma página individual. Para obter mais informações, consulte Exploring User Experience Analytics.
    Nota:
    Em geral, as páginas do portal são marcadas automaticamente com esta capacidade de acompanhamento. Use este método para cenários personalizados, como um widget personalizado de página única em um cenário de assistente.

    Propriedades da página na linha do tempo

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome descritivo da página ou da seção da página. Caracteres especiais não são permitidos.
    descrição Cadeia de caracteres Opcional. Descrição da página a ser exibida na linha do tempo e no painel de análise.

    Padrão: name valor de parâmetro
    Tabela 14. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como chamar o método startPage().

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