Snowplow Android Tracker 3.1.2
|
Public Attributes | |
String | appId |
DevicePlatform | devicePlatform |
boolean | base64encoding |
LogLevel | logLevel |
LoggerDelegate | loggerDelegate |
boolean | applicationContext |
boolean | platformContext |
boolean | geoLocationContext |
boolean | sessionContext |
boolean | deepLinkContext |
boolean | screenContext |
boolean | screenViewAutotracking |
boolean | lifecycleAutotracking |
boolean | installAutotracking |
boolean | exceptionAutotracking |
boolean | diagnosticAutotracking |
String | trackerVersionSuffix |
Static Public Attributes | |
static final String | TAG = TrackerConfiguration.class.getSimpleName() |
This class represents the configuration of the tracker and the core tracker properties. The TrackerConfiguration can be used to setup the tracker behaviour indicating what should be tracked in term of automatic tracking and contexts/entities to track with the events.
Definition at line 19 of file TrackerConfiguration.java.
com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.TrackerConfiguration | ( | @NonNull String | appId | ) |
It sets a default TrackerConfiguration. Default values: devicePlatform = DevicePlatform.Mobile; base64encoding = true; logLevel = LogLevel.OFF; loggerDelegate = null; sessionContext = true; applicationContext = true; platformContext = true; geoLocationContext = false; screenContext = true; deepLinkContext = true; screenViewAutotracking = true; lifecycleAutotracking = false; installAutotracking = true; exceptionAutotracking = true; diagnosticAutotracking = false;
appId | Identifier of the app. |
Definition at line 300 of file TrackerConfiguration.java.
com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.TrackerConfiguration | ( | @NonNull String | appId, |
@NonNull JSONObject | jsonObject | ||
) |
Definition at line 511 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.appId | ( | @NonNull String | appId | ) |
Identifer of the app.
Definition at line 328 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.applicationContext | ( | boolean | applicationContext | ) |
Whether application context is sent with all the tracked events.
Definition at line 373 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.base64encoding | ( | boolean | base64encoding | ) |
It indicates whether the JSON data in the payload should be base64 encoded.
Definition at line 346 of file TrackerConfiguration.java.
Configuration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.copy | ( | ) |
Implements com.snowplowanalytics.snowplow.configuration.Configuration.
Definition at line 486 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.deepLinkContext | ( | boolean | deepLinkContext | ) |
Whether deepLink context is sent with all the ScreenView events.
Definition at line 412 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.devicePlatform | ( | @NonNull DevicePlatform | devicePlatform | ) |
It sets the device platform the tracker is running on.
Definition at line 337 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.diagnosticAutotracking | ( | boolean | diagnosticAutotracking | ) |
Whether enable diagnostic reporting.
Definition at line 467 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.exceptionAutotracking | ( | boolean | exceptionAutotracking | ) |
Whether enable crash reporting.
Definition at line 458 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.geoLocationContext | ( | boolean | geoLocationContext | ) |
Whether geo-location context is sent with all the tracked events.
@apiNote Requires Location permissions as per the requirements of the various Android versions. Otherwise the whole context is skipped.
Definition at line 394 of file TrackerConfiguration.java.
String com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.getAppId | ( | ) |
Identifer of the app.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 105 of file TrackerConfiguration.java.
DevicePlatform com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.getDevicePlatform | ( | ) |
It sets the device platform the tracker is running on.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 116 of file TrackerConfiguration.java.
LoggerDelegate com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.getLoggerDelegate | ( | ) |
It sets the logger delegate that receive logs from the tracker.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 148 of file TrackerConfiguration.java.
LogLevel com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.getLogLevel | ( | ) |
It sets the log level of tracker logs.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 137 of file TrackerConfiguration.java.
String com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.getTrackerVersionSuffix | ( | ) |
Decorate the v_tracker field in the tracker protocol.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 269 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.installAutotracking | ( | boolean | installAutotracking | ) |
Whether enable automatic tracking of install event.
Definition at line 449 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isApplicationContext | ( | ) |
Whether application context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 158 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isBase64encoding | ( | ) |
It indicates whether the JSON data in the payload should be base64 encoded.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 126 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isDeepLinkContext | ( | ) |
Whether deepLink context is sent with all the ScreenView events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 198 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isDiagnosticAutotracking | ( | ) |
Whether enable diagnostic reporting.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 258 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isExceptionAutotracking | ( | ) |
Whether enable crash reporting.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 248 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isGeoLocationContext | ( | ) |
Whether geo-location context is sent with all the tracked events.
@apiNote Requires Location permissions as per the requirements of the various Android versions. Otherwise the whole context is skipped.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 178 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isInstallAutotracking | ( | ) |
Whether enable automatic tracking of install event.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 238 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isLifecycleAutotracking | ( | ) |
Whether enable automatic tracking of background and foreground transitions. @apiNote It needs the Foreground library installed.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 228 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isPlatformContext | ( | ) |
Whether mobile/platform context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 168 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isScreenContext | ( | ) |
Whether screen context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 208 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isScreenViewAutotracking | ( | ) |
Whether enable automatic tracking of ScreenView events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 218 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.isSessionContext | ( | ) |
Whether session context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Reimplemented in com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationUpdate.
Definition at line 188 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.lifecycleAutotracking | ( | boolean | lifecycleAutotracking | ) |
Whether enable automatic tracking of background and foreground transitions. @apiNote It needs the Foreground library installed.
Definition at line 440 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.loggerDelegate | ( | @Nullable LoggerDelegate | loggerDelegate | ) |
It sets the logger delegate that receive logs from the tracker.
Definition at line 364 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.logLevel | ( | @NonNull LogLevel | logLevel | ) |
It sets the log level of tracker logs.
Definition at line 355 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.platformContext | ( | boolean | platformContext | ) |
Whether mobile/platform context is sent with all the tracked events.
Definition at line 382 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.screenContext | ( | boolean | screenContext | ) |
Whether screen context is sent with all the tracked events.
Definition at line 421 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.screenViewAutotracking | ( | boolean | screenViewAutotracking | ) |
Whether enable automatic tracking of ScreenView events.
Definition at line 430 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.sessionContext | ( | boolean | sessionContext | ) |
Whether session context is sent with all the tracked events.
Definition at line 403 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setAppId | ( | @NonNull String | appId | ) |
Identifer of the app.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 110 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setApplicationContext | ( | boolean | applicationContext | ) |
Whether application context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 163 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setBase64encoding | ( | boolean | base64encoding | ) |
It indicates whether the JSON data in the payload should be base64 encoded.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 131 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setDeepLinkContext | ( | boolean | deepLinkContext | ) |
Whether deepLink context is sent with all the ScreenView events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 203 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setDevicePlatform | ( | @NonNull DevicePlatform | devicePlatform | ) |
It sets the device platform the tracker is running on.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 121 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setDiagnosticAutotracking | ( | boolean | diagnosticAutotracking | ) |
Whether enable diagnostic reporting.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 263 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setExceptionAutotracking | ( | boolean | exceptionAutotracking | ) |
Whether enable crash reporting.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 253 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setGeoLocationContext | ( | boolean | geoLocationContext | ) |
Whether geo-location context is sent with all the tracked events.
@apiNote Requires Location permissions as per the requirements of the various Android versions. Otherwise the whole context is skipped.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 183 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setInstallAutotracking | ( | boolean | installAutotracking | ) |
Whether enable automatic tracking of install event.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 243 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setLifecycleAutotracking | ( | boolean | lifecycleAutotracking | ) |
Whether enable automatic tracking of background and foreground transitions. @apiNote It needs the Foreground library installed.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 233 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setLoggerDelegate | ( | @Nullable LoggerDelegate | loggerDelegate | ) |
It sets the logger delegate that receive logs from the tracker.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 153 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setLogLevel | ( | @NonNull LogLevel | logLevel | ) |
It sets the log level of tracker logs.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 142 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setPlatformContext | ( | boolean | platformContext | ) |
Whether mobile/platform context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 173 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setScreenContext | ( | boolean | screenContext | ) |
Whether screen context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 213 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setScreenViewAutotracking | ( | boolean | screenViewAutotracking | ) |
Whether enable automatic tracking of ScreenView events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 223 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setSessionContext | ( | boolean | sessionContext | ) |
Whether session context is sent with all the tracked events.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 193 of file TrackerConfiguration.java.
void com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.setTrackerVersionSuffix | ( | @Nullable String | trackerVersionSuffix | ) |
Decorate the v_tracker field in the tracker protocol.
Implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface.
Definition at line 274 of file TrackerConfiguration.java.
TrackerConfiguration com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.trackerVersionSuffix | ( | @Nullable String | trackerVersionSuffix | ) |
Decorate the v_tracker field in the tracker protocol.
Definition at line 477 of file TrackerConfiguration.java.
String com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.appId |
Definition at line 26 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.applicationContext |
Definition at line 54 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.base64encoding |
Definition at line 37 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.deepLinkContext |
Definition at line 70 of file TrackerConfiguration.java.
DevicePlatform com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.devicePlatform |
Definition at line 32 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.diagnosticAutotracking |
Definition at line 94 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.exceptionAutotracking |
Definition at line 90 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.geoLocationContext |
Definition at line 62 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.installAutotracking |
Definition at line 86 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.lifecycleAutotracking |
Definition at line 82 of file TrackerConfiguration.java.
LoggerDelegate com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.loggerDelegate |
Definition at line 49 of file TrackerConfiguration.java.
LogLevel com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.logLevel |
Definition at line 43 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.platformContext |
Definition at line 58 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.screenContext |
Definition at line 74 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.screenViewAutotracking |
Definition at line 78 of file TrackerConfiguration.java.
boolean com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.sessionContext |
Definition at line 66 of file TrackerConfiguration.java.
|
static |
Definition at line 20 of file TrackerConfiguration.java.
String com.snowplowanalytics.snowplow.configuration.TrackerConfiguration.trackerVersionSuffix |
Definition at line 99 of file TrackerConfiguration.java.