snowplow_tracker library

Classes

ConsentGranted Adding data to your events Tracking events
Event used to track a user opting into data collection.
ConsentWithdrawn Adding data to your events Tracking events
Event to track a user withdrawing consent for data collection.
EmitterConfiguration Initialization and configuration
Configuration of the event emitter.
Event
Base class for all tracked events.
GdprConfiguration Initialization and configuration
Determines the GDPR context that will be attached to all events sent by the tracker.
ListItemView Adding data to your events Tracking events
Event tracking the view of an item in a list. If screen engagement tracking is enabled, the list item view events will be aggregated into a screen_summary entity.
MediaAdBreakEndEvent Adding data to your events Media events Tracking events
Media player event that signals the end of an ad break.
MediaAdBreakEntity
Properties for the ad break context entity attached to media events during ad break playback. Entity schema: iglu:com.snowplowanalytics.snowplow.media/ad_break/jsonschema/1-0-0
MediaAdBreakStartEvent Adding data to your events Media events Tracking events
Media player event that signals the start of an ad break.
MediaAdClickEvent Adding data to your events Media events Tracking events
Media player event fired when the user clicked on the ad.
MediaAdCompleteEvent Adding data to your events Media events Tracking events
Media player event that signals the ad creative was played to the end at normal speed.
MediaAdEntity
Properties for the ad context entity attached to media events during ad playback. Entity schema: iglu:com.snowplowanalytics.snowplow.media/ad/jsonschema/1-0-0
MediaAdFirstQuartileEvent Adding data to your events Media events Tracking events
Media player event fired when 25% of ad is reached after continuous ad playback at normal speed.
MediaAdMidpointEvent Adding data to your events Media events Tracking events
Media player event fired when a midpoint of ad is reached after continuous ad playback at normal speed.
MediaAdPauseEvent Adding data to your events Media events Tracking events
Media player event fired when the user clicked the pause control and stopped the ad creative.
MediaAdResumeEvent Adding data to your events Media events Tracking events
Media player event fired when the user resumed playing the ad creative after it had been stopped or paused.
MediaAdSkipEvent Adding data to your events Media events Tracking events
Media player event fired when the user activated a skip control to skip the ad creative.
MediaAdStartEvent Adding data to your events Media events Tracking events
Media player event that signals the start of an ad.
MediaAdThirdQuartileEvent Adding data to your events Media events Tracking events
Media player event fired when 75% of ad is reached after continuous ad playback at normal speed.
MediaBufferEndEvent Adding data to your events Media events Tracking events
Media player event fired when the the player finishes buffering content and resumes playback.
MediaBufferStartEvent Adding data to your events Media events Tracking events
Media player event fired when the player goes into the buffering state and begins to buffer content.
MediaEndEvent Adding data to your events Media events Tracking events
Media player event sent when playback stops when end of the media is reached or because no further data is available.
MediaErrorEvent Adding data to your events Media events Tracking events
Media player event fired when the user clicked the pause control and stopped the ad creative.
MediaFullscreenChangeEvent Adding data to your events Media events Tracking events
Media player event fired immediately after the browser switches into or out of full-screen mode.
MediaPauseEvent Adding data to your events Media events Tracking events
Media player event sent when the user pauses the playback.
MediaPictureInPictureChangeEvent Adding data to your events Media events Tracking events
Media player event fired immediately after the browser switches into or out of picture-in-picture mode.
MediaPlaybackRateChangeEvent Adding data to your events Media events Tracking events
Media player event sent when the playback rate has changed.
MediaPlayerEntity
Properties for the media player context entity attached to media events. Entity schema: iglu:com.snowplowanalytics.snowplow/media_player/jsonschema/2-0-0
MediaPlayEvent Adding data to your events Media events Tracking events
Media player event sent when the player changes state to playing from previously being paused.
MediaQualityChangeEvent Adding data to your events Media events Tracking events
Media player event tracked when the video playback quality changes.
MediaReadyEvent Adding data to your events Media events Tracking events
Media player event fired when the media tracking is successfully attached to the player and can track events.
MediaSeekEndEvent Adding data to your events Media events Tracking events
Media player event sent when a seek operation completes.
MediaSeekStartEvent Adding data to your events Media events Tracking events
Media player event sent when a seek operation begins.
MediaTracking
Media tracking instance with methods to track media events.
MediaTrackingConfiguration
Configuration for a MediaTracking instance.
MediaVolumeChangeEvent Adding data to your events Media events Tracking events
Media player event sent when the volume has changed.
NetworkConfiguration Initialization and configuration
Configuration of the collector network endpoint.
PageViewEvent Adding data to your events Tracking events
Event to capture page views on the Web. Not implemented on mobile platforms.
PlatformContextProperties
Overrides for the values for properties of the platform context. Only available on mobile apps (Android and iOS), not on Web.
ScreenView Adding data to your events Tracking events
Event to track user viewing a screen within the application.
ScrollChanged Adding data to your events Tracking events
Event tracked when a scroll view's scroll position changes. If screen engagement tracking is enabled, the scroll changed events will be aggregated into a screen_summary entity.
SelfDescribing Adding data to your events Tracking events
Event to track custom information that does not fit into the out-of-the box events.
Size
Resolution or viewport of screen.
Snowplow Getting started Initialization and configuration
Main interface for the package mainly used to initialize trackers and track events.
SnowplowObserver
Route observer that tracks ScreenView or PageViewEvent events when the currently active ModalRoute changes.
SnowplowTracker Getting started
Instance of an initialized Snowplow tracker identified by a namespace.
Structured Adding data to your events Tracking events
Event to capture custom consumer interactions without the need to define a custom schema.
SubjectConfiguration Initialization and configuration
Subject information about tracked user and device that is added to events.
Timing Adding data to your events Tracking events
Event used to track user timing events such as how long resources take to load.
TrackerConfiguration Initialization and configuration Sessions and data model
Configuration of the tracker and the core tracker properties.
WebActivityTracking Initialization and configuration Sessions and data model
Configuration for the behavior of page tracking on Web. Initializing the configuration will inform SnowplowObserver observers to auto track PageViewEvent events instead of ScreenView events on navigation changes. Further, setting the minimumVisitLength and heartbeatDelay properties will enable activity tracking using 'page ping' events on Web.

Enums

AppSetIdScope
BatteryState
DevicePlatform
Device platform the tracker runs on
MediaAdBreakType
Type of ads within the break
MediaType
Type of media content.
Method
NetworkType

Functions

defaultNameExtractor(RouteSettings settings) → String?

Typedefs

ScreenNameExtractor = String? Function(RouteSettings settings)
Signature for a function that extracts view name from RouteSettings to be used in ScreenView or PageViewEvent events tracked in the observer.