Vorgaben zum Aufruf der SZM-Library
Die Erfassung der App-Nutzung durch den Benutzer erfolgt, indem die App die SZM-Library bei definierten Ereignissen, welche eine Nutzer-Interaktion kennzeichnen, aufruft.
Die Nutzer-Interaktion wird als Event bezeichnet.
Hinweis
Die SZM-Library muss von der App bei Eintreten des Events explizit aufgerufen werden.
Weiterhin misst die IOLib bestimmte System- oder App-spezifische Werte automatisch. Zu diesem Zweck muss die Integration der IOLib iOS exakt wie im Kapitel „Integration des IOLib iOS Frameworks„ beschrieben erfolgen.
Interpretation von Events als mobile PI
Die nachfolgend aufgeführten Vorgaben definieren, wie die SZM-Library im Kontext der SZM Mobile Applications Messung zu verwenden ist.
Aus technischer Sicht wird zwischen 2 Typen von Events unterschieden:
PI-Events
Bei den PI-Events wird der Event dazu benutzt, analog zum stationären Web, eine PageImpression zu erzeugen. Diesem Event muss ein Inhaltscode (in der Folge einfach als „Code“ bezeichnet) zugeordnet werden. Dieser Code kann anschließend den unterschiedlichen Kategorien zugeordnet werden und dient als Grundlage für die Bildung von Belegungseinheiten. Bei den PI-Events sind die Vorgaben zur Mobile Impression der IVW zu beachten:
„Eine Mobile Impression ist eine Nutzeraktion innerhalb eines mobilen Angebots, die zu einem Aufruf eines Werbemittels führt oder führen könnte. Jede Nutzeraktion darf nur einmal gezählt werden. Nutzeraktionen, die zu keiner potentiellen Werbeauslieferung führen, dürfen nicht gezählt werden.
Voraussetzungen für die Zuweisung einer MI zu einem Angebot:
Der ausgelieferte Inhalt muss (bei mobile enabled Websites) den FQDN bzw. (bei Apps) den App-Namen des Angebots (oder Alias/Redirect) oder den zugewiesenen MEW- oder App-Namen des Angebots tragen.
Nutzeraktion:
Eine MI wird ausgelöst durch eine vom Nutzer durchgeführte Aktion. Darunter fallen ebenfalls: Reload, Öffnen einer App, Öffnen eines Browsers.
Keine Nutzeraktion:
Aufruf eines Inhalts durch eine automatische Weiterleitung (außer Redirects und Alias)., automatischer Reload, das Aufrufen eines Inhaltes beim Schließen (auch: Background) eines Browserfensters oder einer App, das Aufrufen von Inhalten über Robots/Spider und Ähnliches.
Keine Mobile Impression:
Das Scrollen innerhalb eines bereits geladenen Inhalts.
Non-PI-Events
Non-PI-Events sind Nutzeraktionen, die als Event im SZM-System erfasst werden, jedoch nicht zur Zählung einer Mobile Impression führen. Diesem Event darf kein Code zugeordnet werden. Beispiele für Non-PI-Events sind
- automatisch von der IOLib erfasste Events
- vom Anbieter festgelegte Events, welche keine mobile PI darstellen und dennoch als Events gemessen werden sollen, um z.B. die Nutzung der App durch die Nutzer besser nachvoll-ziehen zu können.
Richtlinien zur Vergabe der Codes
Bei den PI-Events ist der Code als eindeutige Kennzeichnung des angezeigten Inhalts mitzugeben. Der Code wird vom App-Anbieter spezifiziert.
Bei der Spezifikation der Inhalts-Codes sind die Code-Richtlinien der INFOnline zu beachten
- Länge der Codes: Ein Code darf maximal 255 Zeichen enthalten
- Anzahl der Codes: es dürfen maximal 2000 Codes verwendet werden
- Erlaubte zeichen: a-z, A-Z, 0-9; Komma „,“; Bindestrich „-“; Unterstrich „_“; Slash „/“
Weitere Informationen zu den Codes
Events
In den nachfolgenden Tabellen sind Events aufgeführt, welche in der Messung erhoben werden bzw. erhoben werden können. Unter welchen Umständen ein Event zu einer Page Impression führen kann, wird im folgenden ebenfalls erläutert.
Automatisch durch die SZM-Library gemessene Events
Die nachfolgende Tabelle beschreibt die Events, bei denen die SZM-Library automatisch aufgerufen wird. Bei den Events handelt es sich um Nutzeraktionen, welche aus technischen Gründen erhoben werden, jedoch nicht zur Zählung einer Mobile Impression führen. Diesem Event darf kein Code zugeordnet werden.
Event Klasse | Event Type | Event | Bemerkung |
IOLAccessoryEvent | Connected, |
|
|
IOLApplicationEvent | Start, | App-spezifische Event, z.B. Start der App, Beenden der App, Crash, etc. | ResignActive: |
IOLInternetConnectionEvent | Established | Art der Konnektivität ändert sich | Verbindung aufgebaut bzw. verloren |
IOLWebViewEvent | Init | Hybrid-Messung wird aktiviert |
|
PI-Events
Im Folgenden sind Events aufgeführt, welche typischerweise zur Auslösung einer PI führen. Die Übernahme des Schemas wird empfohlen. Die Events müssen manuell ausgelöst werden. Das Vorgehen ist im Kapitel „Logging eines Events„ beschrieben. Eine automatische Erhebung erfolgt nicht. PI-Events muss ein Code zugeordnet werden. Dieser Code kann anschließend den unterschiedlichen Kategorien zugeordnet werden und dient als Grundlage für die Bildung von Belegungseinheiten.
Hinweis
Bei den PI-Events sind die Vorgaben zur Mobile Impression der IVW zu beachten.
Event Klasse | Event Type | Event | Bemerkung |
IOLDeviceOrientationEvent | Changed | Ausrichtung des Gerätes | LandscapeLeft / LandscapeRight oder Portrait / Portrait UpsideDown |
IOLGestureEvent | Shake | Gerät wird geschüttelt |
|
IOLViewEvent | Appeared | Ein View (aka „Page“) wurde angezeigt oder mit neuen Daten aktualisiert | Beispiele: |
IOLGameEvent | Action | Gaming-Events | Aktion innerhalb eines Spiels |
IOLAudioEvent | Play | Audio Playback | Wiedergabe, Pause, Stop, |
IOLVideoEvent | Play | Video Playback | Wiedergabe, Pause, Stop, Nächster/vorheriger Titel, Vor/Zurückspulen, Wiederholung |
Non-PI-Events
Im Folgenden sind Events aufgeführt, welche typischerweise nicht zur Zählung einer PI führen. Sollten jedoch im Einzelfall Umstände vorliegen, unter denen auch hier eine Mobile PI erzeugt werden soll, können diese Events benutzt werden, um dies zu ermöglichen. Bevor Sie diese Events zur Erzeugung von PIs benutzen, klären Sie den jeweiligen Sachverhalt bitte unmittelbar mit der IVW Geschäftsstelle ab. Sollen diese Events zur Zählung von PIs führen, muss das auch hier manuell ausgelöst werden. Diesem Event muss dann ein Code zugeordnet werden. Dieser Code kann anschließend den unterschiedlichen Kategorien zugeordnet werden und dient als Grundlage für die Bildung von Belegungseinheiten.
| Event Klasse | Event Type | Event | Bemerkung |
| IOLViewEvent | Disappeared | Ein View (aka „Page“) wurde verlassen | Beispiele: Disappeared: Screen verlassen |
| IOLDocumentEvent | Open Edit Close | Dokument / Liste Bearbeitung | Liste editiert Dokument gespeichert |
| IOLDataEvent | Cancelled Refresh Succeeded Failed | Datenverbindung/ -verarbeitung | Datenverbindung abgebrochen Daten wurden aktualisiert Daten wurden erfolgreich übertragen Daten wurden nicht übertragen |
| IOLDownloadEvent | Cancelled Start Succeeded Failed | Download von Daten | Download wurde initiiert Download wurde abgebrochen Download erfolgreich beendet Download fehlgeschlagen |
| IOLUploadEvent | Cancelled Start Succeeded Failed | Upload von Daten | Upload wurde initiiert Upload wurde abgebrochen Upload erfolgreich beendet Upload fehlgeschlagen |
| IOLLoginEvent | Succeeded Failed Logout | Login | Login erfolgreich durchgeführt Login fehlgeschlagen Logout durchgeführt/Session beendet |
| IOLGameEvent | Finished Won Lost NewHighscore NewAchievement | Gaming-Events | Spiel beendet Spiel(runde) gewonnen Spiel(runde) verloren Neuer Highscore erreicht Neues Achievement erreicht |
| IOLHardwareButtonEvent | Pushed | Schalter oder Knopf am Gerät gedrückt | Lautstärke über Schalterwippe am Gerät geändert Device gelocked (Power Taste betätigt) Druck auf Home-Button |
| IOLBackgroundTaskEvent | Start End | Ein Hintergrundprozess wird gestartet bzw. beendet | Download oder Upload größerer Dateien, welche evtl. im Hintergrund weiterlaufen sollen |
| IOLOpenAppEvent | Maps Other | Eine andere App wird gestartet bzw. App wird über eine URL verlassen | Maps: Apple Maps wird aufgerufen Other: Andere Apps bzw. URIs werden aufgerufen (Email, Phone, Websites, etc.) |
| IOLAdvertisementEvent | Open, Close | Werbung wird angezeigt oder ausgeblendet | Werbe-Banner geöffnet bzw. geschlossen |
| IOLIAPEvent | Started, Finished, Cancelled | In-App-Käufe werden durchgeführt | IAP Prozess wird iniitiert (Start) IAP Prozess wird beendet (Finished) IAP Prozess wird vorzeitig abgebrochen (Cancelled) |
| IOLPushEvent | Received | Push Notifications | Eine Push Notification wird empfangen |
| IOLCustomEvent | * | Durch den Nutzer definierbar | Ein CustomEvent kann einen frei definierbaren Status bzw. Aktion messen (Für zukünftige Nutzung vorgesehen). |
Sobald in der App ein unter „manuell auszulösende Events“ beschriebenes Ereignis ausgelöst wird, ist die SZM-Library per logEvent aufzurufen. Hierbei ist eine Instanz der entsprechenden IOLEvent-Subklasse als Parameter zu übergeben (siehe dazu auch SZM-Library Funktionen).
Die Übermittlung der Non-PI-Events an das SZM System ist optional.
Hinweis
Die Non-PI-Events haben keinen Einfluss auf die Reichweitenermittlung Ihrer App.
Diese Events können von Ihnen zur quantitativen Ermittlung der Häufigkeit des Auftretens dieser Events (in den INFOnline Auswertesystemen) verwendet werden. Hierbei ist zu beachten, dass die Erfassung und Übermittlung der Non-PI-Events technische Ressourcen (CPU-Zeit, Netzwerkverkehr, Batterie) auf dem Endgerät verwendet.
Mit Hinblick auf die Inanspruchnahme der technischen Ressourcen auf dem Endgerät bitten wir Sie, in der Planung der Umsetzung der Integration der MessLibs zu entscheiden, ob Ihre App NonPI-Events an das SZM-System übermitteln soll.
Sonderfall Event „ViewRefreshed“
Für den Fall, dass eine View aktualisiert wird (IOLViewEvent, Type IOLViewEventTypeRefreshed), ist Folgendes zu beachten:
Hinweis
Das Event darf nur geloggt werden (bzw. die SZM-Library aufgerufen werden), wenn der Refresh der Daten manuell durch den Nutzer ausgelöst wurde. Bei einem automatischen Refresh darf das Event nicht geloggt werden.
Sonderfall WatchKit Events
Das Pendant zur Klasse UIViewController ist die Klasse WKInterfaceController in WatchKit. Diese Klasse enthält die beiden Methoden willActivate und didDeactivate, welche die Pendants zu den Methoden viewWillAppear bzw. viewDidDisappear aus UIViewController darstellen.
Um die serverseitige Erfassung von WatchKit Events so einfach wie möglich zu gestalten, sollte der Eventtyp IOLViewEvent und dessen Types IOLViewEventTypeAppeared und IOLViewEventTypeDisappeared in den Callback-Methoden der Klasse WKInterfaceController verwendet werden.
Beispiel (Code in einer Subklasse von WKInterfaceController):
Objective-c:
Swift:
