Matomo Analytics

Art. no. 216207851

No alt text available

Introdução

O Matomo (anteriormente Piwik) é uma ferramenta de análise de código aberto que fornece informações abrangentes sobre a utilização de sítios Web e aplicações. Recolhe e armazena dados e fornece uma interface Web para visualizar dados em tempo real e criar relatórios. Visite https://matomo.org para obter mais informações.

Esta integração pode ser utilizada de várias formas:

  • subscrever o Matomo Cloud, que inclui alojamento e suporte
  • instalar o Matomo no seu próprio servidor para ter controlo total sobre os seus dados
  • criar o seu próprio ponto de extremidade que analisa os dados do evento, o que lhe permite armazenar e gerir os dados exatamente como pretende

Detalhes da implementação

Os clientes do Prenly Reader enviarão dados estatísticos para o ponto de extremidade da API de rastreamento do servidor Matomo, de acordo com a documentação oficial da API de rastreamento do Matomo, utilizando

  • o SDK JavaScript oficial do Matomo do leitor Web Prenly.
  • os SDK:s de código aberto para Android och iOS dos leitores de aplicações nativas Prenly. Isso requer que os SDKs sejam adicionados ao código de programa do aplicativo nativo, o que implica que novas versões do aplicativo devem ser compiladas e lançadas antes que a integração comece a funcionar.

A implementação atual suporta a exportação de eventos, mas não "visualizações de páginas", uma vez que o Prenly Reader não se baseia na navegação tradicional baseada em páginas.

A Prenly não suporta o Matomo Tag Manager, uma vez que se trata essencialmente de uma solução para ambientes Web e, por conseguinte, não é diretamente aplicável aos clientes nativos da Prenly.

Configuração

Configuração de um servidor Matomo

Utilizar um servidor Matomo

A configuração normal do Matomo requer que o software de servidor Matomo de fonte aberta seja instalado no local ou através de um serviço alojado externamente, oferecido pelo matomo.org ou por outras empresas. O software do servidor irá expor uma API que recolhe dados estatísticos e uma ferramenta Web que lhe permite ver e analisar os dados.

Na ferramenta Web, é necessário

  • criar um "sítio" que corresponda à aplicação Prenly, o que dará origem a um "ID do sítio"
  • adicionar manualmente "dimensões personalizadas" (metadados para vários eventos) que o Prenly enviará

Quando se trata tecnicamente de metadados/dimensões personalizadas no Matomo, cada dimensão é referida como um número inteiro simples, uma vez que é guardada na base de dados do Matomo.

Quando se adicionam dimensões personalizadas através da ferramenta Web, estas são criadas por ordem numérica (1, 2, 3, ...). Uma vez que o Prenly enviará as dimensões de acordo com a lista abaixo, é importante criar as dimensões personalizadas pela ordem correta.

Implementação de um ponto final de rastreio personalizado

Ao estudar a especificação da api de rastreio Matomo, é possível implementar o seu próprio ponto final de api que recolhe os dados métricos enviados pelas aplicações Prenly Reader.

Isto é útil se pretender armazenar dados de métricas no seu próprio sistema e/ou no seu próprio formato. A API de rastreio do Matomo é simples, pelo que a implementação de um tal ponto final deve ser bastante simples.

Note o seguinte:

  • Deve haver apenas um ponto final, e ele deve responder aos métodos GET (evento único) e POST (um lote de eventos), conforme descrito nos documentos.
  • O URL para o ponto de extremidade deve terminar com /matomo.php. Isto deve-se ao facto de os clientes de código aberto utilizados pelo Prenly terem esta limitação.
  • As dimensões personalizadas enviadas por Prenly serão nomeadas de acordo com a lista abaixo.

Configurar a integração no PWS

Os seguintes parâmetros de configuração são definidos no Prenly Workspace.

ID do sítio

O ID do sítio configurado no servidor Matomo, como um número inteiro.

Exemplo: 5

URL da API de rastreio

O URL para o qual os dados de rastreamento serão enviados, terminando com matomo.php.

Exemplo: https: //my.site.com/matomo.php

Transformação de dados

Geral

Devido a limitações técnicas, todas as propriedades são enviadas para o Matomo como cadeias de caracteres.

Os atributos de eventos que são booleanos são enviados como "0" para falso e "1" para verdadeiro.

Atributos de eventos

No Matomo, as dimensões personalizadas são utilizadas para representar atributos específicos de eventos. No software do servidor Matomo, essas dimensões personalizadas devem ser configuradas por um administrador na interface web do servidor Matomo. Infelizmente, o Matomo não oferece uma forma de nomear ou identificar estas dimensões, em vez disso, estas obtêm um número que representa a sua identificação na base de dados do servidor Matomo.

O Prenly enviará dimensões personalizadas de acordo com a tabela abaixo. Para que os IDs correspondam à tabela abaixo, deve adicionar as dimensões personalizadas pela ordem correta.

ID da dimensão da açãoNome do parâmetro do pedidoAtributo do evento Prenly
1dimensão1application_slug
2dimensão2title_slug
3dimensão3title_uid
4dimensão4publication_slug
5dimensão5publication_uid
6dimensão6publication_date
7dimensão7número_da_página
8dimensão8identificador da peça
9dimensão9artigo
10dimensão10article_uid
11dimensão11nome_do_artigo
12dimensão12ID_externo_do_artigo
13dimensão13secção_slug
14dimensão14external_url (obsoleto)
14dimensão14destination_url
15dimensão15push_notifications_enabled
16dimensão16push_notification_uid
17dimensão17push_notification_sent_at
18dimensão18título_da_mensagem
19dimensão19corpo_da_mensagem
20dimensão20número_do_cliente
21dimensão21consent_analytical (se conhecido - enviado como "0" ou "1")
22dimensão22consent_functional (se conhecido - enviado como "0" ou "1")
23dimensão23consent_marketing (se conhecido - enviado como "0" ou "1")
24dimensão24banner_type
25dimensão25external_link_id
26dimensão26consent_services
27dimensão27título_do_canal
28dimensão28channel_slug
29dimensão29título_do_episódio
30dimensão30id_entidade_do_episódio
31dimensão31data_publicação
32dimensão32playback_position
33dimensão33audio_url
34dimensão34audio_duration
35dimensão35played_duration
36dimensão36audio_entity_id
37dimensão37audio_title
38dimensão38acesso_limitado

Dados contextuais

Os dados contextuais são enviados como parâmetros, tal como documentado na API de rastreio do Matomo.

Os SDK de código aberto utilizados nas aplicações Prenly Reader implementam o rastreio de dados de forma ligeiramente diferente. Esta diversidade leva a variações nos dados enviados de cada tipo de cliente para o servidor Matomo.

Estes parâmetros são confirmados a partir de todas as plataformas (web, Android, iOS):

ParâmetroObjetivoInformação
recSe o evento deve ser registadoDefinido sempre como verdadeiro (enviado como "1" )
siteidO ID do sítio do servidor de rastreioConforme configurado no Prenly Workspace
e_cCategoria do eventoSempre definido como "prenly-event"
e_aAção do eventoSempre definida como "interação"
e_nNome do eventoO nome do evento Prenly, por exemplo "article_open"
resResolução do ecrãPor exemplo "1280x1024"
uidIdentificação única do utilizador, se aplicávelO valor user_id dos dados contextuais das informações do utilizador

Não é possível garantir o envio de outros parâmetros.

Note-se que não substituímos especificamente o agente do utilizador utilizando o parâmetro "ui". Ainda assim, algumas plataformas podem enviá-lo, mas não deve confiar nele. Em vez disso, é necessário verificar o cabeçalho HTTP User-Agent para poder determinar o agente do utilizador e a plataforma.

 

© Textalk

We use DeepL and ChatGPT for translations. Occasional imprecisions may occur.