Matomo Analytics
Art. no. 216207851
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ção | Nome do parâmetro do pedido | Atributo do evento Prenly |
---|---|---|
1 | dimensão1 | application_slug |
2 | dimensão2 | title_slug |
3 | dimensão3 | title_uid |
4 | dimensão4 | publication_slug |
5 | dimensão5 | publication_uid |
6 | dimensão6 | publication_date |
7 | dimensão7 | número_da_página |
8 | dimensão8 | identificador da peça |
9 | dimensão9 | artigo |
10 | dimensão10 | article_uid |
11 | dimensão11 | nome_do_artigo |
12 | dimensão12 | ID_externo_do_artigo |
13 | dimensão13 | secção_slug |
14 | dimensão14 | external_url (obsoleto) |
14 | dimensão14 | destination_url |
15 | dimensão15 | push_notifications_enabled |
16 | dimensão16 | push_notification_uid |
17 | dimensão17 | push_notification_sent_at |
18 | dimensão18 | título_da_mensagem |
19 | dimensão19 | corpo_da_mensagem |
20 | dimensão20 | número_do_cliente |
21 | dimensão21 | consent_analytical (se conhecido - enviado como "0" ou "1" ) |
22 | dimensão22 | consent_functional (se conhecido - enviado como "0" ou "1" ) |
23 | dimensão23 | consent_marketing (se conhecido - enviado como "0" ou "1" ) |
24 | dimensão24 | banner_type |
25 | dimensão25 | external_link_id |
26 | dimensão26 | consent_services |
27 | dimensão27 | título_do_canal |
28 | dimensão28 | channel_slug |
29 | dimensão29 | título_do_episódio |
30 | dimensão30 | id_entidade_do_episódio |
31 | dimensão31 | data_publicação |
32 | dimensão32 | playback_position |
33 | dimensão33 | audio_url |
34 | dimensão34 | audio_duration |
35 | dimensão35 | played_duration |
36 | dimensão36 | audio_entity_id |
37 | dimensão37 | audio_title |
38 | dimensão38 | acesso_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âmetro | Objetivo | Informação |
---|---|---|
rec | Se o evento deve ser registado | Definido sempre como verdadeiro (enviado como "1" ) |
siteid | O ID do sítio do servidor de rastreio | Conforme configurado no Prenly Workspace |
e_c | Categoria do evento | Sempre definido como "prenly-event" |
e_a | Ação do evento | Sempre definida como "interação" |
e_n | Nome do evento | O nome do evento Prenly, por exemplo "article_open" |
res | Resolução do ecrã | Por exemplo "1280x1024" |
uid | Identificação única do utilizador, se aplicável | O 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.