Matomo Analytics - Prenly
Introduktion till Matomo
Matomo (tidigare Piwik) är ett analysverktyg med öppen källkod som ger omfattande insikter i hur webbplatser och applikationer används. Det samlar in och lagrar data och tillhandahåller ett webbgränssnitt för att visa realtidsdata och skapa rapporter. Besök https://matomo.org för mer information.
Denna integration kan användas på flera sätt:
- prenumerera på Matomo Cloud, vilket inkluderar hosting och support
- installera Matomo på din egen server för att få full kontroll över dina data
- bygga din egen slutpunkt som analyserar händelsedata, vilket gör att du kan lagra och hantera data precis som du vill
Detaljer om implementeringen
Prenly Reader-klienterna kommer att skicka statistiska data till Matomo-serverns spårningsapi-slutpunkt, enligt den officiella dokumentationen för Matomo-spårningsapin, med hjälp av:
- Matomos officiella JavaScript SDK från Prenly-webbläsaren.
- SDK:er med öppen källkod för Android och iOS från Prenlys läsare av inbyggda appar. Detta kräver att SDK:erna läggs till i den inbyggda appens programkod, vilket innebär att nya appversioner måste kompileras och släppas innan integrationen börjar fungera.
Den nuvarande implementeringen stöder export av händelser, men inte "sidvisningar", eftersom Prenly Reader inte förlitar sig på traditionell sidbaserad navigering.
Prenly stöder inte Matomo Tag Manager eftersom det främst är en lösning för webbmiljöer och därför inte är direkt tillämplig på Prenlys inbyggda klienter.
Inställning
Konfigurera en Matomo-server
Använda en Matomo-server
Den normala Matomo-installationen kräver att Matomo-serverprogramvaran med öppen källkod installeras lokalt eller via en externt hostad tjänst, som erbjuds av matomo.org eller av andra företag. Serverprogramvaran kommer att exponera ett api som samlar in statistiska data och ett webbverktyg som låter dig visa och analysera data.
I webbverktyget måste du:
- skapa en "webbplats" som motsvarar Prenly-applikationen, vilket kommer att resultera i ett "webbplats-ID"
- manuellt lägga till "anpassade dimensioner" (metadata för olika händelser) som Prenly kommer att skicka
När man tekniskt hanterar metadata/anpassade dimensioner i Matomo kallas varje dimension för ett vanligt heltal, eftersom det sparas i Matomos databas.
När du lägger till anpassade dimensioner via webbverktyget skapas de i nummerordning (1, 2, 3, ...). Eftersom Prenly kommer att skicka dimensioner enligt listan nedan är det viktigt att skapa de anpassade dimensionerna i rätt ordning.
Implementera en anpassad slutpunkt för spårning
Genom att studera specifikationen för Matomo tracking api är det möjligt att implementera en egen api-slutpunkt som samlar in de mätdata som skickas från Prenly Reader-applikationerna.
Detta är användbart om du vill lagra mätdata i ditt eget system och/eller i ditt eget format. Matomo tracking api är enkelt, så en sådan slutpunkt bör vara ganska enkel att implementera.
Notera följande:
- Det ska bara finnas en endpoint, och den måste svara på både GET- (enstaka händelse) och POST- (ett antal händelser) metoderna enligt beskrivningen i dokumenten.
- URL:en till endpointen måste sluta med
/matomo.php.Detta beror på att de klienter med öppen källkod som används av Prenly har denna begränsning. - De anpassade dimensioner som skickas av Prenly kommer att namnges enligt listan nedan.
Konfigurera integrationen i PWS
Följande konfigurationsparametrar ställs in i Prenly Workspace.
Webbplats-ID
Det plats-ID som konfigurerats i Matomo-servern, som ett heltal.
Exempel på: 5
URL för spårningsapi
Den URL som spårningsdata kommer att skickas till, slutar med matomo.php.
Exempel: https: //my.site.com/matomo.php
Transformation av data
Allmänt
På grund av tekniska begränsningar skickas alla egenskaper till Matomo som strängar.
Händelseattribut som är booleska skickas som "0" för false och "1" för true.
Händelseattribut
I Matomo används anpassade dimensioner för att representera händelsespecifika attribut. I Matomo-serverprogramvaran måste dessa anpassade dimensioner ställas in av en administratör i din Matomo-servers webbgränssnitt. Tyvärr erbjuder inte Matomo något sätt att namnge eller identifiera dessa dimensioner, utan de får ett nummer som representerar deras ID i Matomo-serverns databas.
Prenly kommer att skicka anpassade dimensioner enligt tabellen nedan. För att ID:na ska matcha tabellen nedan bör du lägga till de anpassade dimensionerna i rätt ordning.
| Åtgärd dimension id | Namn på parameter för begäran | Prenly-händelseattribut |
|---|---|---|
| 1 | dimension1 | applikation_slug |
| 2 | dimension2 | titel_slug |
| 3 | dimension3 | titel_uid |
| 4 | dimension4 | publikation_slug |
| 5 | dimension5 | publikation_uid |
| 6 | dimension6 | publikation_datum |
| 7 | dimension7 | sidnummer |
| 8 | dimension8 | del_slug |
| 9 | dimension9 | artikel_slug |
| 10 | dimension10 | artikel_uid |
| 11 | dimension11 | artikel_namn |
| 12 | dimension12 | artikel_externt_id |
| 13 | dimension13 | sektion_slug |
| 14 | dimension14 | external_url (föråldrad) |
| 14 | dimension14 | destination_url |
| 15 | dimension15 | push_notifieringar_aktiverade |
| 16 | dimension16 | push_notifiering_uid |
| 17 | dimension17 | push_notifikation_sänt_at |
| 18 | dimension18 | meddelande_titel |
| 19 | dimension19 | meddelande_kropp |
| 20 | dimension20 | kund_nummer |
| 21 | dimension21 | consent_analytical (om känt - skickas som "0" eller "1") |
| 22 | dimension22 | samtycke_funktionellt (om känt - skickas som "0" eller "1") |
| 23 | dimension23 | consent_marketing (om känt - skickas som "0" eller "1") |
| 24 | dimension24 | banner_typ |
| 25 | dimension25 | extern_länk_id |
| 26 | dimension26 | samtycke_tjänster |
| 27 | dimension27 | kanal_titel |
| 28 | dimension28 | kanal_slug |
| 29 | dimension29 | episod_titel |
| 30 | dimension30 | episod_entitet_id |
| 31 | dimension31 | publicera_datum |
| 32 | dimension32 | playback_position |
| 33 | dimension33 | ljud_url |
| 34 | dimension34 | audio_duration |
| 35 | dimension35 | spelad_duration |
| 36 | dimension36 | audio_entitet_id |
| 37 | dimension37 | ljud_titel |
| 38 | dimension38 | begränsad_tillgång |
Kontextuella data
Kontextuella data skickas som parametrar enligt dokumentationen i Matomos spårningsapi.
De SDK:er med öppen källkod som används i Prenly Reader-applikationerna implementerar dataspårning på lite olika sätt. Denna mångfald leder till variationer i de data som skickas från varje klienttyp till Matomo-servern.
Dessa parametrar bekräftas skickas från alla plattformar (webb, Android, iOS):
| Parameter | Syfte | Information om parametern |
|---|---|---|
| rec | Om händelsen ska spelas in | Alltid inställd på true (skickas som "1" ) |
| Webbplatsid | ID för spårningsserverns webbplats | Som konfigurerat i Prenly Workspace |
| e_c | Händelsekategori | Alltid inställd på "prenly-event" |
| e_a | Händelseåtgärd | Alltid inställd på "interaktion" |
| e_n | Händelsens namn | Prenly-händelsens namn, t.ex. "article_open" |
| res | Skärmupplösning | Till exempel "1280x1024" |
| uid | Unikt användar-ID om tillämpligt | Värdet för user_id från användarinformationens kontextuella data |
Det kan inte garanteras att andra parametrar skickas.
Observera att vi specifikt inte åsidosätter användaragenten med hjälp av parametern "ui". Vissa plattformar kan ändå skicka den, men du bör inte lita på det. Istället måste du kontrollera HTTP-rubriken User-Agent för att kunna bestämma användaragenten och plattformen.