Class MyTrackerConfig
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceInterface of provider that produces information about installed packages.static @interfaceValues for configuration of geolocation collection and tracking mode
Value isMyTrackerConfig.LocationTrackingMode.NONE,MyTrackerConfig.LocationTrackingMode.CACHED, orMyTrackerConfig.LocationTrackingMode.ACTIVEstatic interfaceInterface of OkHTTP provider -
Method Summary
Modifier and TypeMethodDescriptionReturn current anti-fraud configuration.Return apkPreinstallParamsStringintReturn buffering period.intReturn forcing period in seconds.getId()Return identifier that was provided inMyTracker.initTracker(String, Application).intReturn launch timeout in in seconds.intGet geolocation tracking mode recommended to use insteadMyTrackerConfig#isTrackingLocationEnabled()call.Deprecated.booleanReturn whether auto tracking purchases is enabled or not.booleanReturn whether kid-mode flag is enabled or not.booleanReturn tracking environment state.booleanReturn whether tracking application launches is enabled or not.booleanDeprecated.booleanReturn whether tracking preinstall of current application is enabled or not.booleanReturn whether tracking preinstall of current application with third party sources is enabled or not.voidsetAntiFraudConfig(AntiFraudConfig antiFraudConfig) Set anti-fraud configuration.setApkPreinstallParams(String apkPreinstallParams) Set apkPreinstallParamssetAutotrackingPurchaseEnabled(boolean autotrackingPurchaseEnabled) Enable or disable autotracking purchases.setBufferingPeriod(int bufferingPeriodSec) Set the buffering period.Deprecated.setForcingPeriod(int forcingPeriodSec) Set the forcing period.Set installed packages provider.setKidMode(boolean kidMode) Enable or disable kid-mode flag to control tracking information in kids applications.setLaunchTimeout(int seconds) Set the launch timeout.setLocationTrackingMode(int locationTrackingMode) Set geolocation tracking modeSet installed okHttpClient provider.setProxyHost(String proxyHost) Set the host to which all requests will be sent.setTrackingEnvironmentEnabled(boolean trackingEnvironmentEnabled) Enable or disable collecting environment information.setTrackingLaunchEnabled(boolean trackingLaunchEnabled) Enable or disable tracking application launches.setTrackingLocationEnabled(boolean trackingLocationEnabled) Deprecated.This method is deprecated and will be removed in future versions.setTrackingPreinstallEnabled(boolean trackingPreinstallEnabled) Enable or disable tracking preinstall.setTrackingPreinstallThirdPartyEnabled(boolean trackingPreinstallThirdPartyEnabled) Enable or disable tracking preinstall with third party sources.setVendorAppPackage(String vendorAppPackage) Deprecated.
-
Method Details
-
getId
Return identifier that was provided inMyTracker.initTracker(String, Application).- Returns:
- Your identifier.
-
getBufferingPeriod
public int getBufferingPeriod()Return buffering period. During this period every tracked event is stored in local storage.The value is in range [1 - 86400]. Default value is 900 seconds.
- Returns:
- Buffering period.
-
setBufferingPeriod
Set the buffering period.NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
bufferingPeriodSec- Buffering period in seconds. The value should be in range [1 - 86400]. Otherwise it will be rejected.- Returns:
- The current instance of
MyTrackerConfig.
-
getAntiFraudConfig
Return current anti-fraud configuration.- Returns:
- The current instance of
AntiFraudConfig.
-
setAntiFraudConfig
Set anti-fraud configuration.- Parameters:
antiFraudConfig- Implementation ofOkHttpClientProvider
-
getForcingPeriod
public int getForcingPeriod()Return forcing period in seconds. During this period every tracked event leads to flushing tracker. The start of the period is install or update of application.The value is in range [0 - 432000]. Default value is 0. It means, that forcing period is disabled by default.
- Returns:
- Forcing period.
-
setForcingPeriod
Set the forcing period.NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
forcingPeriodSec- Forcing period in seconds. The value should be in range [0 - 432000]. Otherwise it will be rejected.- Returns:
- The current instance of
MyTrackerConfig.
-
getLaunchTimeout
public int getLaunchTimeout()Return launch timeout in in seconds. During this period start of the application after it close wont't be considered as new launch.The value is in range [30 - 7200]. Default value is 30.
- Returns:
- Launch timeout.
-
setLaunchTimeout
Set the launch timeout.NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
seconds- Launch timeout in seconds.- Returns:
- The current instance of
MyTrackerConfig.
-
setProxyHost
Set the host to which all requests will be sent.Only host is allowed here (scheme, userinfo, path, query and fragment parts will be deleted), https schema is using anytime
Example:
[ok] exampleHost
[ok] exampleHost:examplePort
[ok] exampleHost.com
[ok] exampleHost.com:examplePort
[not ok] www.exampleHost.com (see note below)
[not ok] ftp://exampleHost.com (https://exampleHost.com will be used)
[not ok] exampleHost.com/examplePath (exampleHost.com will be used)
[not ok] exampleUser:examplePass@exampleHost.com (exampleHost.com will be used)
To reset proxy host to default call the method with null parameter.
NOTE: it's mandatory to call this method before
MyTracker.initTracker(String, Application)call.NOTE: we using subdomains for some of our queries. It means that for some cases result url can be 'subdomain.exampleHost.com'. Please don't use 'www' in proxy host, because result url will be 'subdomain.www.exampleHost.com' which is probably you don't want
- Parameters:
proxyHost- Proxy host.- Returns:
- The current instance of
MyTrackerConfig.
-
getVendorAppPackage
Deprecated. -
setVendorAppPackage
Deprecated. -
setDefaultVendorAppPackage
Deprecated. -
setInstalledPackagesProvider
public MyTrackerConfig setInstalledPackagesProvider(MyTrackerConfig.InstalledPackagesProvider provider) Set installed packages provider.- Parameters:
provider- Implementation ofMyTrackerConfig.InstalledPackagesProvider- Returns:
- The current instance of
MyTrackerConfig.
-
isTrackingEnvironmentEnabled
public boolean isTrackingEnvironmentEnabled()Return tracking environment state. Enabled state means that information about Wi-Fi and mobile networks will be collected.NOTE: this information are collected while sending request to the server. The impact to the battery is minimal.
- Returns:
- Tracking environment state.
-
setTrackingEnvironmentEnabled
Enable or disable collecting environment information.NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
trackingEnvironmentEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
isTrackingLaunchEnabled
public boolean isTrackingLaunchEnabled()Return whether tracking application launches is enabled or not.- Returns:
- The state of tracking launches feature.
-
setTrackingLaunchEnabled
Enable or disable tracking application launches.NOTE: it's mandatory to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
trackingLaunchEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
isTrackingLocationEnabled
Deprecated.This method is deprecated and will be removed in future versions.UseMyTrackerConfig#getLocationTrackingMode()} instead.NOTE: this information are collected while sending request to the server. The impact to the battery is minimal.
- Returns:
- The result of the MyTrackerConfig.getLocationTrackingMode() != LocationTrackingMode.NONE
-
setTrackingLocationEnabled
Deprecated.This method is deprecated and will be removed in future versions. UseMyTrackerConfig#setLocationTrackingMode(int)()}} instead. Now this works like setLocationTrackingMode(CACHED) or setLocationTrackingMode(NONE)NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
trackingLocationEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
getLocationTrackingMode
public int getLocationTrackingMode()Get geolocation tracking mode recommended to use insteadMyTrackerConfig#isTrackingLocationEnabled()call.- Returns:
- current locationTrackingMode value
LocationTrackingMode. Possible values isLocationTrackingMode#NONE,LocationTrackingMode#CACHED,LocationTrackingMode#ACTIVEValue isMyTrackerConfig.LocationTrackingMode.NONE,MyTrackerConfig.LocationTrackingMode.CACHED, orMyTrackerConfig.LocationTrackingMode.ACTIVE
-
setLocationTrackingMode
Set geolocation tracking modeNOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)and to use insteadMyTrackerConfig#setTrackingLocationEnabled(boolean)call.- Parameters:
locationTrackingMode- valueLocationTrackingMode. Possible values isLocationTrackingMode#NONE,LocationTrackingMode#CACHED,LocationTrackingMode#ACTIVEValue isMyTrackerConfig.LocationTrackingMode.NONE,MyTrackerConfig.LocationTrackingMode.CACHED, orMyTrackerConfig.LocationTrackingMode.ACTIVE
-
isAutotrackingPurchaseEnabled
public boolean isAutotrackingPurchaseEnabled()Return whether auto tracking purchases is enabled or not.If it's enabled: - The methods
MyTracker.onActivityResult(int, Intent)andMyTracker.onPurchasesUpdated(int, List)are available for tracking. - The methodsMyTracker.trackPurchaseEvent(JSONObject, JSONObject, String)andMyTracker.trackPurchaseEvent(JSONObject, JSONObject, String, Map)are disabled.If it's disabled: - The methods
MyTracker.onActivityResult(int, Intent)andMyTracker.onPurchasesUpdated(int, List)are unavailable. for tracking. - The methodsMyTracker.trackPurchaseEvent(JSONObject, JSONObject, String)andMyTracker.trackPurchaseEvent(JSONObject, JSONObject, String, Map)are enabled for tracking.- Returns:
- The state of autotracking feature.
-
setAutotrackingPurchaseEnabled
Enable or disable autotracking purchases.NOTE: it's recommended to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
autotrackingPurchaseEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
isTrackingPreinstallEnabled
public boolean isTrackingPreinstallEnabled()Return whether tracking preinstall of current application is enabled or not.- Returns:
- The state of tracking preinstall feature.
-
setTrackingPreinstallEnabled
Enable or disable tracking preinstall.NOTE: it's mandatory to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
trackingPreinstallEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
isTrackingPreinstallThirdPartyEnabled
public boolean isTrackingPreinstallThirdPartyEnabled()Return whether tracking preinstall of current application with third party sources is enabled or not.- Returns:
- The state of tracking preinstall feature.
-
setTrackingPreinstallThirdPartyEnabled
public MyTrackerConfig setTrackingPreinstallThirdPartyEnabled(boolean trackingPreinstallThirdPartyEnabled) Enable or disable tracking preinstall with third party sources.NOTE: it's mandatory to call this method before
MyTracker.initTracker(String, Application)call.- Parameters:
trackingPreinstallThirdPartyEnabled- The enable or disable state.- Returns:
- The current instance of
MyTrackerConfig.
-
isKidMode
public boolean isKidMode()Return whether kid-mode flag is enabled or not.- Returns:
- The state of kid-mode flag.
- See Also:
-
setKidMode
Enable or disable kid-mode flag to control tracking information in kids applications.NOTE: if your app solely target children then you must remove com.google.android.gms.permission.AD_ID permission from application manifest with tools:node="remove" attribute.
- Parameters:
kidMode- The enable or disable state.truewill disable unique ids tracking (GAID, etc..).- Returns:
- The current instance of
MyTrackerConfig.
-
setOkHttpClientProvider
Set installed okHttpClient provider.- Parameters:
provider- Implementation ofOkHttpClientProvider- Returns:
- The current instance of
MyTrackerConfig.
-
getApkPreinstallParams
Return apkPreinstallParamsString -
setApkPreinstallParams
Set apkPreinstallParams- Parameters:
apkPreinstallParams-String- Returns:
- The current instance of
MyTrackerConfig.
-
MyTrackerConfig#getLocationTrackingMode()} instead.