Package io.appmetrica.analytics

Class AppMetricaConfig

java.lang.Object

io.appmetrica.analytics.AppMetricaConfig

public class AppMetricaConfig
extends Object

Contains configuration of analytic processing. Configuration created by AppMetricaConfig.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppMetricaConfig.Builder	Builds a new AppMetricaConfig object.

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,Object>	additionalConfig	Additional configs
final Boolean	advIdentifiersTracking	Indicates whether AppMetrica should include advertising identifiers withing its reports
final Boolean	anrMonitoring	Indicates whether ANR monitoring is enabled.
final Integer	anrMonitoringTimeout	The timeout in seconds at which the fact of ANR is recorded.
final String	apiKey	Unique identifier of app in AppMetrica
final Integer	appBuildNumber	Build number of application
final Map<String,String>	appEnvironment	Application environment to be set after initialization
final Boolean	appOpenTrackingEnabled	Whether app open auto tracking is enabled Default value is true.
final String	appVersion	Application version
final Boolean	crashReporting	Indicates whether to capture and send reports about crashes automatically
final ICrashTransformer	crashTransformer	Custom crash transformer.
final List<String>	customHosts	Custom hosts for startup config
final Boolean	dataSendingEnabled	Indicates whether data should be sent to the AppMetrica server.
final String	deviceType	The device type based on screen size.
final Integer	dispatchPeriodSeconds	Timeout for sending reports
final Map<String,String>	errorEnvironment	Error environment to be set after initialization
final Boolean	firstActivationAsUpdate	Indicates, whether first activation of AppMetrica should be considered as app update or new app install.
final android.location.Location	location	Location to be used as location for reports of AppMetrica
final Boolean	locationTracking	Indicates whether AppMetrica should include location information within its reports
final Boolean	logs	Indicates whether AppMetrica logging enabled
final Integer	maxReportsCount	Maximum buffer size for reports
final Integer	maxReportsInDatabaseCount	Maximum number of reports to store in database.
final Boolean	nativeCrashReporting	Indicates whether to capture and send reports about native crashes automatically
final PreloadInfo	preloadInfo	Preload info for tracking preloaded apps
final Boolean	revenueAutoTrackingEnabled	Whether revenue auto tracking is enabled Default value is true.
final Boolean	sessionsAutoTrackingEnabled	Indicates whether sessions auto tracking is enabled.
final Integer	sessionTimeout	Duration of AppMetrica session
final String	userProfileID	The ID of the user profile.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AppMetricaConfig(AppMetricaConfig source)	Clone constructor

Method Summary

Modifier and Type	Method	Description
static AppMetricaConfig	fromJson(String json)	Creates AppMetricaConfig from JSON string.
static AppMetricaConfig.Builder	newConfigBuilder(String apiKey)	Creates the new instance of AppMetricaConfig.Builder
String	toJson()	Serializes AppMetricaConfig to json

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

apiKey

@NonNull
public final String apiKey

Unique identifier of app in AppMetrica

See Also:

• newConfigBuilder(String)

appVersion

@Nullable
public final String appVersion

Application version

See Also:

• AppMetricaConfig.Builder.withAppVersion(String)

sessionTimeout

@Nullable
public final Integer sessionTimeout

Duration of AppMetrica session

See Also:

• AppMetricaConfig.Builder.withSessionTimeout(int)

crashReporting

@Nullable
public final Boolean crashReporting

Indicates whether to capture and send reports about crashes automatically

true if we need to send reports about crashes, otherwise false

See Also:

• AppMetricaConfig.Builder.withCrashReporting(boolean)

nativeCrashReporting

@Nullable
public final Boolean nativeCrashReporting

Indicates whether to capture and send reports about native crashes automatically

true if we need to send reports about native crashes, otherwise false

See Also:

• AppMetricaConfig.Builder.withNativeCrashReporting(boolean)

location

@Nullable
public final android.location.Location location

Location to be used as location for reports of AppMetrica

See Also:

• AppMetricaConfig.Builder.withLocation(Location)

locationTracking

@Nullable
public final Boolean locationTracking

Indicates whether AppMetrica should include location information within its reports

true if allow AppMetrica to record location information in reports, otherwise false

See Also:

• AppMetricaConfig.Builder.withLocationTracking(boolean)

advIdentifiersTracking

@Nullable
public final Boolean advIdentifiersTracking

Indicates whether AppMetrica should include advertising identifiers withing its reports

@{code true} if allow AppMetrica to record advertising identifiers in reports, otherwise false

logs

@Nullable
public final Boolean logs

Indicates whether AppMetrica logging enabled

true if enabled, false if not

See Also:

• AppMetricaConfig.Builder.withLogs()

preloadInfo

@Nullable
public final PreloadInfo preloadInfo

Preload info for tracking preloaded apps

See Also:

• AppMetricaConfig.Builder.withPreloadInfo(PreloadInfo)

firstActivationAsUpdate

@Nullable
public final Boolean firstActivationAsUpdate

Indicates, whether first activation of AppMetrica should be considered as app update or new app install.

true if first call of AppMetrica.activate(android.content.Context, io.appmetrica.analytics.AppMetricaConfig) should be considered as app update, false otherwise.

dataSendingEnabled

@Nullable
public final Boolean dataSendingEnabled

Indicates whether data should be sent to the AppMetrica server.

maxReportsInDatabaseCount

@Nullable
public final Integer maxReportsInDatabaseCount

Maximum number of reports to store in database. Default value is 1000. Must be in range [100; 10000]. If not, closest possible value will be used.

See Also:

• AppMetricaConfig.Builder.withMaxReportsInDatabaseCount(int)

errorEnvironment

@Nullable
public final Map<String,String> errorEnvironment

Error environment to be set after initialization

See Also:

• AppMetricaConfig.Builder.withErrorEnvironmentValue(String, String)

userProfileID

@Nullable
public final String userProfileID

The ID of the user profile. NOTE: The string value can contain up to 200 characters.

See Also:

• AppMetricaConfig.Builder.withUserProfileID(String)

revenueAutoTrackingEnabled

@Nullable
public final Boolean revenueAutoTrackingEnabled

Whether revenue auto tracking is enabled Default value is true.

See Also:

• AppMetricaConfig.Builder.withRevenueAutoTrackingEnabled(boolean)

sessionsAutoTrackingEnabled

@Nullable
public final Boolean sessionsAutoTrackingEnabled

Indicates whether sessions auto tracking is enabled.

Setting this flag to true is equivalent to invoking AppMetrica.enableActivityAutoTracking(android.app.Application) Default value is true.

appOpenTrackingEnabled

@Nullable
public final Boolean appOpenTrackingEnabled

Whether app open auto tracking is enabled Default value is true. Set this flag to true instead of reporting deeplinks manually from Activity.onCreate(android.os.Bundle) via AppMetrica.reportAppOpen(android.app.Activity) NOTE: Auto tracking will only capture links that open activity. Those that are clicked on while activity is opened will be ignored. To track them call AppMetrica.reportAppOpen(android.content.Intent) from Activity.onNewIntent(android.content.Intent)

See Also:

• AppMetricaConfig.Builder.withAppOpenTrackingEnabled(boolean)

deviceType

@Nullable
public final String deviceType

The device type based on screen size.

Allowed values are from PredefinedDeviceTypes. Using other values may cause events to not appear in AppMetrica reports. Other values are only allowed if explicitly supported by official documentation.

See Also:

• PredefinedDeviceTypes

appBuildNumber

@Nullable
public final Integer appBuildNumber

Build number of application

See Also:

• AppMetricaConfig.Builder.withAppBuildNumber(int)

dispatchPeriodSeconds

@Nullable
public final Integer dispatchPeriodSeconds

Timeout for sending reports

See Also:

• AppMetricaConfig.Builder.withDispatchPeriodSeconds(int)

maxReportsCount

@Nullable
public final Integer maxReportsCount

Maximum buffer size for reports

See Also:

• AppMetricaConfig.Builder.withMaxReportsCount(int)

appEnvironment

@Nullable
public final Map<String,String> appEnvironment

Application environment to be set after initialization

See Also:

• AppMetricaConfig.Builder.withAppEnvironmentValue(String, String)
• AppMetrica.putAppEnvironmentValue(String, String)

crashTransformer

@Nullable
public final ICrashTransformer crashTransformer

Custom crash transformer. Applied to crashes before reporting. If null, crashes are not transformed.

anrMonitoring

@Nullable
public final Boolean anrMonitoring

Indicates whether ANR monitoring is enabled.

true if enabled, otherwise, false

anrMonitoringTimeout

@Nullable
public final Integer anrMonitoringTimeout

The timeout in seconds at which the fact of ANR is recorded.

Minimal value is 5. Default value is 5.

customHosts

@Nullable
public final List<String> customHosts

Custom hosts for startup config

See Also:

• AppMetricaConfig.Builder.withCustomHosts(List)

additionalConfig

@NonNull
public final Map<String,Object> additionalConfig

Additional configs

See Also:

• AppMetricaConfig.Builder.withAdditionalConfig(String, Object)

Constructor Details

AppMetricaConfig

protected AppMetricaConfig(@NonNull
 AppMetricaConfig source)

Clone constructor

Parameters:

source - AppMetricaConfig to clone

Method Details

newConfigBuilder

@NonNull
public static AppMetricaConfig.Builder newConfigBuilder(@NonNull
 String apiKey)

Creates the new instance of AppMetricaConfig.Builder

Parameters:

apiKey - API_KEY - unique identifier of app in AppMetrica.

Returns:

builder of AppMetricaConfig

Throws:

IllegalArgumentException - if apiKey is null, empty or has invalid format.

See Also:

• AppMetrica SDK documentation

fromJson

@Nullable
public static AppMetricaConfig fromJson(String json)

Creates AppMetricaConfig from JSON string.

Parameters:

json - String representing AppMetricaConfig

Returns:

AppMetricaConfig parsed from giver json

toJson

public String toJson()

Serializes AppMetricaConfig to json

Returns:

String representing this AppMetricaConfig