Matomo Analytics
Art. no. 216207851
Wprowadzenie
Matomo (dawniej Piwik) to narzędzie analityczne o otwartym kodzie źródłowym, które zapewnia kompleksowy wgląd w wykorzystanie stron internetowych i aplikacji. Gromadzi i przechowuje dane oraz zapewnia interfejs sieciowy do przeglądania danych w czasie rzeczywistym i tworzenia raportów. Więcej informacji można znaleźć na stronie https://matomo.org.
Integracja ta może być wykorzystywana na wiele sposobów:
- subskrybować Matomo Cloud, która obejmuje hosting i wsparcie
- zainstalować Matomo na własnym serwerze, aby uzyskać pełną kontrolę nad danymi
- zbudować własny punkt końcowy, który analizuje dane zdarzeń, co pozwala na przechowywanie danych i zarządzanie nimi dokładnie tak, jak chcesz.
Szczegóły implementacji
Klienci Prenly Reader będą wysyłać dane statystyczne do punktu końcowego api śledzenia serwera Matomo, zgodnie z oficjalną dokumentacją api śledzenia Matomo, przy użyciu:
- oficjalnego zestawu SDK Matomo w języku JavaScript z czytnika Prenly.
- open source SDK:s dla Android och iOS z czytników aplikacji natywnych Prenly. Wymaga to dodania SDK do kodu programu aplikacji natywnej, co oznacza, że nowe wersje aplikacji muszą zostać skompilowane i wydane, zanim integracja zacznie działać.
Obecna implementacja obsługuje eksportowanie zdarzeń, ale nie "widoków stron", ponieważ Prenly Reader nie opiera się na tradycyjnej nawigacji opartej na stronach.
Prenly nie obsługuje Matomo Tag Manager, ponieważ jest to przede wszystkim rozwiązanie dla środowisk internetowych, a zatem nie ma bezpośredniego zastosowania do natywnych klientów Prenly.
Konfiguracja
Konfiguracja serwera Matomo
Korzystanie z serwera Matomo
Normalna konfiguracja Matomo wymaga zainstalowania oprogramowania serwera Matomo o otwartym kodzie źródłowym na miejscu lub za pośrednictwem usługi hostowanej zewnętrznie, oferowanej przez matomo.org lub inne firmy. Oprogramowanie serwera będzie udostępniać interfejs API, który zbiera dane statystyczne, oraz narzędzie internetowe, które umożliwia przeglądanie i analizowanie danych.
W narzędziu internetowym należy
- utworzyć "witrynę" odpowiadającą aplikacji Prenly, co spowoduje utworzenie "identyfikatora witryny"
- ręcznie dodać "wymiary niestandardowe" (metadane dla różnych zdarzeń), które będą wysyłane przez Prenly.
Jeśli chodzi o metadane/wymiary niestandardowe w Matomo, każdy wymiar jest określany jako zwykła liczba całkowita, ponieważ jest zapisywany w bazie danych Matomo.
Podczas dodawania niestandardowych wymiarów za pomocą narzędzia internetowego są one tworzone w kolejności numerycznej (1, 2, 3, ...). Ponieważ Prenly wyśle wymiary zgodnie z poniższą listą, ważne jest, aby utworzyć niestandardowe wymiary we właściwej kolejności.
Wdrażanie niestandardowego punktu końcowego śledzenia
Zapoznając się ze specyfikacją api śledzenia Matomo, można zaimplementować własny punkt końcowy api, który zbiera dane metryczne wysyłane z aplikacji Prenly Reader.
Jest to przydatne, jeśli chcesz przechowywać dane metryczne we własnym systemie i/lub we własnym formacie. API śledzenia Matomo jest proste, więc taki punkt końcowy powinien być dość łatwy do wdrożenia.
Należy zwrócić uwagę na następujące kwestie:
- Powinien istnieć tylko jeden punkt końcowy i musi on odpowiadać zarówno na metodę GET (pojedyncze zdarzenie), jak i POST (partia zdarzeń), jak opisano w dokumentacji.
- Adres URL punktu końcowego musi kończyć się na
/matomo.php.
Wynika to z faktu, że klienci open source używani przez Prenly mają to ograniczenie. - Niestandardowe wymiary wysyłane przez Prenly zostaną nazwane zgodnie z poniższą listą.
Konfiguracja integracji w PWS
Następujące parametry konfiguracyjne są ustawiane w Prenly Workspace.
Site ID
Identyfikator witryny skonfigurowany na serwerze Matomo jako liczba całkowita.
Przykład: 5
Tracking api URL
Adres URL, na który będą wysyłane dane śledzenia, kończący się na matomo.php
.
Przykład: https:
//my.site.com/matomo.php
Transformacja danych
Ogólne
Ze względu na ograniczenia techniczne, wszystkie właściwości są wysyłane do Matomo jako ciągi znaków.
Atrybuty zdarzeń, które są wartościami logicznymi, są wysyłane jako "0"
dla wartości false i "1"
dla wartości true.
Atrybuty zdarzeń
W Matomo niestandardowe wymiary są używane do reprezentowania atrybutów specyficznych dla zdarzeń. W oprogramowaniu serwera Matomo te niestandardowe wymiary muszą zostać skonfigurowane przez administratora w interfejsie internetowym serwera Matomo. Niestety, Matomo nie oferuje sposobu na nazwanie lub zidentyfikowanie tych wymiarów, zamiast tego otrzymają one numer reprezentujący ich identyfikator w bazie danych serwera Matomo.
Prenly wyśle niestandardowe wymiary zgodnie z poniższą tabelą. Aby identyfikatory były zgodne z poniższą tabelą, należy dodać wymiary niestandardowe we właściwej kolejności.
Identyfikator wymiaru akcji | Nazwa parametru żądania | Atrybut zdarzenia Prenly |
---|---|---|
1 | dimension1 | application_slug |
2 | dimension2 | title_slug |
3 | dimension3 | title_uid |
4 | dimension4 | publication_slug |
5 | dimension5 | publication_uid |
6 | dimension6 | publication_date |
7 | dimension7 | page_number |
8 | dimension8 | part_slug |
9 | dimension9 | article_slug |
10 | dimension10 | article_uid |
11 | dimension11 | article_name |
12 | dimension12 | article_external_id |
13 | dimension13 | section_slug |
14 | dimension14 | external_url (przestarzałe) |
14 | dimension14 | destination_url |
15 | dimension15 | push_notifications_enabled |
16 | dimension16 | push_notification_uid |
17 | dimension17 | push_notification_sent_at |
18 | dimension18 | message_title |
19 | dimension19 | message_body |
20 | dimension20 | customer_number |
21 | dimension21 | consent_analytical (jeśli znany - wysyłany jako "0" lub "1" ) |
22 | dimension22 | consent_functional (jeśli znany - wysyłany jako "0" lub "1" ) |
23 | dimension23 | consent_marketing (jeśli znany - wysyłany jako "0" lub "1" ) |
24 | dimension24 | banner_type |
25 | dimension25 | external_link_id |
26 | dimension26 | consent_services |
27 | dimension27 | channel_title |
28 | dimension28 | channel_slug |
29 | dimension29 | episode_title |
30 | dimension30 | episode_entity_id |
31 | dimension31 | publish_date |
32 | dimension32 | playback_position |
33 | dimension33 | audio_url |
34 | dimension34 | audio_duration |
35 | dimension35 | played_duration |
36 | dimension36 | audio_entity_id |
37 | dimension37 | audio_title |
38 | dimension38 | limited_access |
Dane kontekstowe
Dane kontekstowe są wysyłane jako parametry zgodnie z dokumentacją w api śledzenia Matomo.
Zestawy SDK typu open source używane w aplikacjach Prenly Reader implementują śledzenie danych w nieco inny sposób. Ta różnorodność prowadzi do różnic w danych wysyłanych z każdego typu klienta do serwera Matomo.
Potwierdzono, że parametry te są wysyłane ze wszystkich platform (web, Android, iOS):
Parametr | Cel | Informacje |
---|---|---|
rec | Czy nagrywać zdarzenie | Zawsze ustawione na true (wysyłane jako "1" ) |
siteid | Identyfikator witryny serwera śledzącego | Zgodnie z konfiguracją w Prenly Workspace |
e_c | Kategoria zdarzenia | Zawsze ustawiona na "prenly-event" . |
e_a | Akcja zdarzenia | Zawsze ustawione na "interakcja" |
e_n | Nazwa zdarzenia | Wstępna nazwa zdarzenia, na przykład "article_open" . |
res | Rozdzielczość ekranu | Na przykład "1280x1024" |
uid | Unikalny identyfikator użytkownika, jeśli dotyczy | Wartość user_id z danych kontekstowych informacji o użytkowniku |
Nie można zagwarantować wysłania innych parametrów.
Należy pamiętać, że specjalnie nie zastępujemy agenta użytkownika za pomocą parametru "ui". Nadal niektóre platformy mogą go wysyłać, ale nie należy temu ufać. Zamiast tego należy sprawdzić nagłówek HTTP User-Agent, aby móc określić agenta użytkownika i platformę.