Package io.appmetrica.analytics

Class AppMetricaConfig.Builder

java.lang.Object

io.appmetrica.analytics.AppMetricaConfig.Builder

Enclosing class:

AppMetricaConfig

public static class AppMetricaConfig.Builder
extends Object

Builds a new AppMetricaConfig object.

Method Summary

Modifier and Type	Method	Description
AppMetricaConfig	build()	Creates instance of AppMetricaConfig
AppMetricaConfig.Builder	handleFirstActivationAsUpdate(boolean value)	Whether first activation of AppMetrica should be considered as app update or new app install.
AppMetricaConfig.Builder	withAdditionalConfig(String key, Object config)	Sets key - config data
AppMetricaConfig.Builder	withAdvIdentifiersTracking(boolean enabled)	Enables/disables including advertising identifiers like GAID, Huawei OAID within its reports.
AppMetricaConfig.Builder	withAnrMonitoring(boolean enabled)	Whether to capture and send reports about ANRs automatically.
AppMetricaConfig.Builder	withAnrMonitoringTimeout(int timeout)	The timeout in seconds at which the fact of ANR is recorded.
AppMetricaConfig.Builder	withAppBuildNumber(int appBuildNumber)	Sets the application build number, if missing, the application version is read from android:versionCode field AndroidManifest.xml file.
AppMetricaConfig.Builder	withAppEnvironmentValue(String key, String value)	Sets key - value pair to be used as additional information, associated with your application runtime's environment.
AppMetricaConfig.Builder	withAppOpenTrackingEnabled(boolean enabled)	Sets whether app open auto tracking is enabled.
AppMetricaConfig.Builder	withAppVersion(String appVersion)	Sets the application version.
AppMetricaConfig.Builder	withCrashReporting(boolean enabled)	Whether to capture and send reports about crashes automatically.
AppMetricaConfig.Builder	withCrashTransformer(ICrashTransformer crashTransformer)	Custom crash transformer which is applied to crashes.
AppMetricaConfig.Builder	withCustomHosts(List<String> hosts)	Sets the list of hosts.
AppMetricaConfig.Builder	withDataSendingEnabled(boolean value)	Enables/disables data sending to the AppMetrica server.
AppMetricaConfig.Builder	withDeviceType(String deviceType)	Sets size type of device based on screen size: phone, tablet, phablet, TV.
AppMetricaConfig.Builder	withDispatchPeriodSeconds(int dispatchPeriodSeconds)	Sets timeout for sending reports.
AppMetricaConfig.Builder	withErrorEnvironmentValue(String key, String value)	Sets key - value data to be used as additional information, associated with your unhandled exception and error reports.
AppMetricaConfig.Builder	withLocation(android.location.Location location)	Sets Location to be used as location for reports of AppMetrica.
AppMetricaConfig.Builder	withLocationTracking(boolean enabled)	Sets whether AppMetrica should include location information within its reports.
AppMetricaConfig.Builder	withLogs()	Enable AppMetrica logging.
AppMetricaConfig.Builder	withMaxReportsCount(int maxReportsCount)	Sets maximum buffer size for reports.
AppMetricaConfig.Builder	withMaxReportsInDatabaseCount(int value)	Sets maximum number of reports to store in database.
AppMetricaConfig.Builder	withNativeCrashReporting(boolean enabled)	Whether to capture and send reports about native crashes automatically.
AppMetricaConfig.Builder	withPreloadInfo(PreloadInfo preloadInfo)	Sets preload info for tracking preloaded apps
AppMetricaConfig.Builder	withRevenueAutoTrackingEnabled(boolean enabled)	Enables/disables auto tracking of inapp purchases.
AppMetricaConfig.Builder	withSessionsAutoTrackingEnabled(boolean enabled)	Sets whether sessions auto tracking is enabled.
AppMetricaConfig.Builder	withSessionTimeout(int sessionTimeout)	By default, the session times out if the app is inactive for 10 seconds.
AppMetricaConfig.Builder	withUserProfileID(String userProfileID)	Sets the ID of the user profile.

Methods inherited from class java.lang.Object

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

Method Details

withAppVersion

@NonNull
public AppMetricaConfig.Builder withAppVersion(@Nullable
 String appVersion)

Sets the application version. It is optional value. By default, the app version is set in field android:versionName of the AndroidManifest.xml file.

EXAMPLE: 1.0

Parameters:

appVersion - Application version

Returns:

the same AppMetricaConfig.Builder object.

Throws:

IllegalArgumentException - If appVersion is null/empty.

See Also:

• PackageInfo.versionName

withSessionTimeout

@NonNull
public AppMetricaConfig.Builder withSessionTimeout(int sessionTimeout)

By default, the session times out if the app is inactive for 10 seconds. To change this time limit, pass the builder.withSessionTimeout(int sessionTimeoutSeconds) method your time limit in seconds. The minimum acceptable value for the sessionTimeoutSeconds parameter is 10 seconds. If a value less than 10 is set, the value will automatically be 10 seconds.

Under the duration of sessions, in the concept of AppMetrica, means the following (see example):

EXAMPLE: Let the duration of sessions is 2 minutes. Then, if interaction with your application started after 2 minutes of inactivity with the application, then a new session will be created, otherwise the session will continue.

Parameters:

sessionTimeout - Timeout in seconds.

Returns:

the same AppMetricaConfig.Builder object.

withCrashReporting

@NonNull
public AppMetricaConfig.Builder withCrashReporting(boolean enabled)

Whether to capture and send reports about crashes automatically.

NOTE: Default value is true

Parameters:

enabled - true if we need to send reports about crashes, otherwise false. In the case of false you can still send information about crashes via AppMetrica.reportUnhandledException(Throwable) method.

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• (boolean)

withNativeCrashReporting

@NonNull
public AppMetricaConfig.Builder withNativeCrashReporting(boolean enabled)

Whether to capture and send reports about native crashes automatically.

NOTE: Default value is true

Parameters:

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

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• withCrashReporting(boolean)

withLogs

@NonNull
public AppMetricaConfig.Builder withLogs()

Enable AppMetrica logging. Should be called before activation.

Returns:

the same AppMetricaConfig.Builder object.

withLocation

@NonNull
public AppMetricaConfig.Builder withLocation(@Nullable
 android.location.Location location)

Sets Location to be used as location for reports of AppMetrica.

If location is set using this method, it will be used instead of auto collected location.

NOTE: Permissions: Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION improve the quality of auto collected location.

Parameters:

location - location to be used for reports

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• withLocationTracking(boolean)
• AppMetrica.setLocation(Location)
• AppMetrica.setLocationTracking(boolean)

withLocationTracking

@NonNull
public AppMetricaConfig.Builder withLocationTracking(boolean enabled)

Sets whether AppMetrica should include location information within its reports.

NOTE: Default value is false

Parameters:

enabled - true to allow AppMetrica to record location information in reports, otherwise false.

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• withLocation(Location)
• AppMetrica.setLocationTracking(boolean)
• AppMetrica.setLocation(Location)

withAdvIdentifiersTracking

@NonNull
public AppMetricaConfig.Builder withAdvIdentifiersTracking(boolean enabled)

Enables/disables including advertising identifiers like GAID, Huawei OAID within its reports.

NOTE: Default value is true.

Parameters:

enabled - true to allow AppMetrica to record advertising identifiers information in reports, otherwise false.

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• AppMetrica.setAdvIdentifiersTracking(boolean)
• AppMetricaConfig.advIdentifiersTracking

withPreloadInfo

@NonNull
public AppMetricaConfig.Builder withPreloadInfo(@Nullable
 PreloadInfo preloadInfo)

Sets preload info for tracking preloaded apps

Parameters:

preloadInfo - instance of PreloadInfo

Returns:

the same AppMetricaConfig.Builder object

handleFirstActivationAsUpdate

@NonNull
public AppMetricaConfig.Builder handleFirstActivationAsUpdate(boolean value)

Whether first activation of AppMetrica should be considered as app update or new app install.

Parameters:

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

Returns:

the same AppMetricaConfig.Builder object

withDataSendingEnabled

@NonNull
public AppMetricaConfig.Builder withDataSendingEnabled(boolean value)

Enables/disables data sending to the AppMetrica server. By default, the sending is enabled.

NOTE: Disabling this option also turns off data sending from the reporters that initialized for different apiKey.

Parameters:

value - true to allow AppMetrica sending data, otherwise false.

Returns:

the same AppMetricaConfig.Builder object

withMaxReportsInDatabaseCount

@NonNull
public AppMetricaConfig.Builder withMaxReportsInDatabaseCount(int value)

Sets maximum number of reports to store in database. If this number is exceeded, some reports will be removed.

NOTE: Default value is 1000

Parameters:

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

Returns:

the same AppMetricaConfig.Builder object.

withErrorEnvironmentValue

@NonNull
public AppMetricaConfig.Builder withErrorEnvironmentValue(@NonNull
 String key,
 @Nullable
 String value)

Sets key - value data to be used as additional information, associated with your unhandled exception and error reports.

Parameters:

key - the environment key.

value - the environment value. To remove pair from environment pass null value.

Returns:

the same AppMetricaConfig.Builder object

withUserProfileID

@NonNull
public AppMetricaConfig.Builder withUserProfileID(@Nullable
 String userProfileID)

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

Parameters:

userProfileID - The custom user profile ID.

Returns:

the same AppMetricaConfig.Builder object

See Also:

• AppMetrica.setUserProfileID(String)

withRevenueAutoTrackingEnabled

@NonNull
public AppMetricaConfig.Builder withRevenueAutoTrackingEnabled(boolean enabled)

Enables/disables auto tracking of inapp purchases. Default value is true.

Parameters:

enabled - true to allow inapp purchases auto tracking, otherwise false.

Returns:

the same AppMetricaConfig.Builder object

withSessionsAutoTrackingEnabled

@NonNull
public AppMetricaConfig.Builder withSessionsAutoTrackingEnabled(boolean enabled)

Sets whether sessions auto tracking is enabled.

Parameters:

enabled - true if auto tracking should be enabled, false otherwise

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• Default value is true.

withAppOpenTrackingEnabled

@NonNull
public AppMetricaConfig.Builder withAppOpenTrackingEnabled(boolean enabled)

Sets whether app open auto tracking is enabled. Default value is true.

Parameters:

enabled - true if auto tracking should be enabled, false otherwise

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• Set this flag to true instead of reporting deeplinks manually from android.app.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 android.app.Activity#onNewIntent(android.content.Intent)

withAdditionalConfig

@NonNull
public AppMetricaConfig.Builder withAdditionalConfig(@NonNull
 String key,
 @Nullable
 Object config)

Sets key - config data

Parameters:

key - the config key.

config - the config value.

Returns:

the same AppMetricaConfig.Builder object.

withDeviceType

@NonNull
public AppMetricaConfig.Builder withDeviceType(@Nullable
 String deviceType)

Sets size type of device based on screen size: phone, tablet, phablet, TV.

Parameters:

deviceType - type of device. Some common-used types are listed in PredefinedDeviceTypes class. One can find complete list in the official documentation.

Returns:

the same AppMetricaConfig.Builder object.

withAppBuildNumber

@NonNull
public AppMetricaConfig.Builder withAppBuildNumber(int appBuildNumber)

Sets the application build number, if missing, the application version is read from android:versionCode field AndroidManifest.xml file.

EXAMPLE: 1

Parameters:

appBuildNumber - Application version code.

Returns:

the same AppMetricaConfig.Builder object.

Throws:

IllegalArgumentException - if appBuildNumber < 0

See Also:

• PackageInfo.versionCode

withDispatchPeriodSeconds

@NonNull
public AppMetricaConfig.Builder withDispatchPeriodSeconds(int dispatchPeriodSeconds)

Sets timeout for sending reports.

NOTE: Default value is 90. If you set a non-positive value, then automatic sending by timer will be disabled.

Parameters:

dispatchPeriodSeconds - Timeout in seconds to automatically send reports.

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• withMaxReportsCount(int)
• AppMetrica.sendEventsBuffer()

withMaxReportsCount

@NonNull
public AppMetricaConfig.Builder withMaxReportsCount(int maxReportsCount)

Sets maximum buffer size for reports.

NOTE: Default value is 7. If you set a non-positive value, then automatic sending will be disabled for the situation when the events buffer is full.

Parameters:

maxReportsCount - Max number of items/reports to automatically send reports.

Returns:

the same AppMetricaConfig.Builder object.

See Also:

• withDispatchPeriodSeconds(int)
• AppMetrica.sendEventsBuffer()

withAppEnvironmentValue

@NonNull
public AppMetricaConfig.Builder withAppEnvironmentValue(@NonNull
 String key,
 @Nullable
 String value)

Sets key - value pair to be used as additional information, associated with your application runtime's environment. This environment is unique for every unique APIKey and shared between processes. Application's environment persists to storage and retained between application launches. To reset environment use AppMetrica.clearAppEnvironment() Pairs added to config builder, will be set right after metrica initialization.

WARNING: Application's environment is a global permanent state and can't be changed too often. For frequently changed parameters use extended reportMessage methods.

Parameters:

key - the environment key.

value - the environment value. To remove pair from environment pass null value.

Returns:

the same AppMetricaConfig.Builder object

See Also:

• AppMetrica.putAppEnvironmentValue(String, String)

withCrashTransformer

@NonNull
public AppMetricaConfig.Builder withCrashTransformer(@Nullable
 ICrashTransformer crashTransformer)

Custom crash transformer which is applied to crashes.

Parameters:

crashTransformer - ICrashTransformer implementation to be applied.

Returns:

the same AppMetricaConfig.Builder object.

withAnrMonitoring

@NonNull
public AppMetricaConfig.Builder withAnrMonitoring(boolean enabled)

Whether to capture and send reports about ANRs automatically.

NOTE: Default value is false.

Parameters:

enabled - true if we need to send reports about ANRs, otherwise false.

Returns:

the same AppMetricaConfig.Builder object.

withAnrMonitoringTimeout

@NonNull
public AppMetricaConfig.Builder withAnrMonitoringTimeout(int timeout)

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

Minimal value is 5. Default value is 5.

Parameters:

timeout - the timeout in seconds at which the fact of ANR is recorded

Returns:

the same AppMetricaConfig.Builder object.

withCustomHosts

@NonNull
public AppMetricaConfig.Builder withCustomHosts(@NonNull
 List<String> hosts)

Sets the list of hosts. This is optional value.

Parameters:

hosts - non-empty host list.

Returns:

the same AppMetricaConfig.Builder object.

build

@NonNull
public AppMetricaConfig build()

Creates instance of AppMetricaConfig

Returns:

AppMetricaConfig object