com.appsflyer

Class AppsFlyerLib

java.lang.Object

com.appsflyer.AppsFlyerLib

Direct Known Subclasses:

AppsFlyerLibCore

public abstract class AppsFlyerLib
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AppsFlyerLib()

Method Summary

Modifier and Type	Method and Description
abstract void	enableFacebookDeferredApplinks(boolean isEnabled) Enable the collection of Facebook Deferred AppLinks Requires Facebook SDK and Facebook app on target/client device.
abstract AppsFlyerLib	enableLocationCollection(boolean flag) Enable the AppsFlyer SDK to collect the last known location, Requires Manifest.permission#ACCESS_COARSE_LOCATION and Manifest.permission#ACCESS_FINE_LOCATION Manifest permissions.
abstract void	enableUninstallTracking(java.lang.String senderId) Deprecated. see documentation Manually set the sender ID for a Firebase / GCM project for Uninstall Tracking.
abstract java.lang.String	getAppsFlyerUID(android.content.Context context) Get AppsFlyer's unique device ID is created for every new install of an app.
abstract java.lang.String	getAttributionId(android.content.ContentResolver contentResolver) Deprecated. use getAttributionId(Context) instead.
abstract java.lang.String	getAttributionId(android.content.Context context) Get the Facebook attribution ID, if one exists.
abstract java.lang.String	getHostName() Get the host name used for tracking.
abstract java.lang.String	getHostPrefix() Get the custom set tracking host prefix.
static AppsFlyerLib	getInstance() Get the singleton instance of the AppsFlyerLib tracker object.
abstract java.lang.String	getOutOfStore(android.content.Context context) Get the current AF_STORE value.
abstract java.lang.String	getSdkVersion() Get the AppsFlyer SDK version used in app.
abstract AppsFlyerLib	init(java.lang.String key, AppsFlyerConversionListener conversionDataListener) Use this method to initialize AppsFlyer SDK.
abstract AppsFlyerLib	init(java.lang.String key, AppsFlyerConversionListener conversionDataListener, android.content.Context context) Same as init(String, AppsFlyerConversionListener) with additional argument Context to handle new install referrer
abstract boolean	isPreInstalledApp(android.content.Context context) Boolean indicator for preinstall by Manufacturer.
abstract boolean	isTrackingStopped() Was the stopTracking(boolean, Context) API set to true.
abstract void	onHandleReferrer(java.util.Map<java.lang.String,java.lang.String> referrer) Internal API.
abstract void	onPause(android.content.Context context) For Cocos2dx platform only Cocos2dx has his own applicationDidEnterBackground event.
abstract void	registerConversionListener(android.content.Context context, AppsFlyerConversionListener conversionDataListener) Register a Conversion Data Listener.
abstract void	registerValidatorListener(android.content.Context context, AppsFlyerInAppPurchaseValidatorListener validationListener) Register a validation listener for the validateAndTrackInAppPurchase(android.content.Context, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) API.
abstract void	reportTrackSession(android.content.Context ctx) If your app is a utility app running in the background you can use this API in your activity’s onCreate()
abstract void	sendDeepLinkData(android.app.Activity activity) Send tracking data from deep-linkable Activity.
abstract void	sendPushNotificationData(android.app.Activity activity) Allows you to measure push notifications as part of a retargeting campaign.
abstract void	setAdditionalData(java.util.HashMap<java.lang.String,java.lang.Object> customData) Set additional data to be sent to AppsFlyer.
abstract void	setAndroidIdData(java.lang.String aAndroidId) By default, IMEI and Android ID are not collected by the SDK if the OS version is higher than KitKat (4.4) and the device contains Google Play Services (on SDK versions 4.8.8 and below the specific app needed GPS).
abstract void	setAppId(java.lang.String id)
abstract void	setAppInviteOneLink(java.lang.String oneLinkId) Set the OneLink ID that should be used for User-Invite-tracking The link that is generated for the user invite will use this OneLink as the base link.
abstract void	setAppUserId(java.lang.String id) Deprecated. use setCustomerUserId(String) instead
abstract void	setCollectAndroidID(boolean isCollect) Opt-out of collection of Android ID.
abstract void	setCollectFingerPrint(boolean isCollect) Deprecated.
abstract void	setCollectIMEI(boolean isCollect) Opt-out of collection of IMEI.
abstract void	setCollectOaid(boolean isCollect) Opt-in of collection of OAID.
abstract void	setConsumeAFDeepLinks(boolean doConsume) Restrict the tracking of reengagement via deep-link to once per each unique deep-link.
abstract void	setCurrencyCode(java.lang.String currencyCode) Setting user local currency code for in-app purchases.
abstract void	setCustomerIdAndTrack(java.lang.String id, android.content.Context context) Use this API to provide the SDK with the relevant customer user id and trigger the SDK to begin its normal tracking.
abstract void	setCustomerUserId(java.lang.String id) Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs.
abstract void	setDebugLog(boolean shouldEnable) Enables Debug logs for the AppsFlyer SDK.
abstract void	setDeviceTrackingDisabled(boolean isDisabled) Anonymize user Data.
abstract void	setExtension(java.lang.String extension) SDK plugins and extensions will set this field
abstract void	setGCMProjectID(java.lang.String projectNumber) Deprecated. use enableUninstallTracking(String) instead.
abstract void	setGCMProjectNumber(android.content.Context context, java.lang.String projectNumber) Deprecated. use enableUninstallTracking(String) instead.
abstract void	setGCMProjectNumber(java.lang.String projectNumber) Deprecated. use enableUninstallTracking(String) instead.
abstract void	setHost(java.lang.String hostPrefixName, java.lang.String hostName) Set a custom host for tracking.
abstract void	setHostName(java.lang.String hostname) Deprecated.
abstract void	setImeiData(java.lang.String aImei) By default, IMEI and Android ID are not collected by the SDK if the OS version is higher than KitKat (4.4) and the device contains Google Play Services (on SDK versions 4.8.8 and below the specific app needed GPS).
abstract void	setIsUpdate(boolean isUpdate) Manually set that the application was updated.
abstract void	setLogLevel(AFLogger.LogLevel logLevel) Sets the SDK's Log Level.
abstract void	setMinTimeBetweenSessions(int seconds) Set a custom value for the minimum required time between sessions.
abstract void	setOaidData(java.lang.String oaid) By default, OAID is not collected by the SDK.
abstract void	setOneLinkCustomDomain(java.lang.String... domains)
abstract void	setOutOfStore(java.lang.String sourceName) Manually set the AF_STORE value.
abstract void	setPhoneNumber(java.lang.String phoneNumber) Will be sent as SHA-256
abstract void	setPluginDeepLinkData(android.content.Intent intent) SDK plugins and extensions will set this field
abstract void	setPreinstallAttribution(java.lang.String mediaSource, java.lang.String campaign, java.lang.String siteId) Specify the manufacturer or media source name to which the preinstall is attributed.
abstract void	setResolveDeepLinkURLs(java.lang.String... urls) Advertisers can wrap AppsFlyer OneLink within another Universal Link.
abstract void	setUserEmail(java.lang.String email) Deprecated. use setUserEmails(AppsFlyerProperties.EmailsCryptType, String...) instead
abstract void	setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod, java.lang.String... emails) Set the user emails and encrypt them.
abstract void	setUserEmails(java.lang.String... emails) Set the user emails
abstract void	startTracking(android.app.Application application) Use this method to start tracking the application, only if you call 'init' inside you Application class's onCreate method.
abstract void	startTracking(android.app.Application application, java.lang.String key) Use this method to start tracking the application.
abstract void	startTracking(android.app.Application application, java.lang.String key, AppsFlyerTrackingRequestListener onTrackingRequestListener) Use this method to start tracking the application.
abstract void	stopTracking(boolean isTrackingStopped, android.content.Context context) Once this API is invoked, our SDK no longer communicates with our servers and stops functioning.
abstract void	trackAppLaunch(android.content.Context ctx, java.lang.String devKey) Send an immediate launch event (regardless of lifecycle)
abstract void	trackEvent(android.content.Context context, java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> eventValues) Track an In-App Event.
abstract void	trackEvent(android.content.Context context, java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> eventValues, AppsFlyerTrackingRequestListener onTrackingRequestListener) Same as trackEvent(Context, String, Map) with AppsFlyerTrackingRequestListener.
abstract void	trackLocation(android.content.Context context, double latitude, double longitude) Manually track the location of the user
abstract void	unregisterConversionListener() Unregister a previously registered AppsFlyerConversionListener.
abstract void	updateServerUninstallToken(android.content.Context context, java.lang.String token) Manually pass the Firebase / GCM Device Token for Uninstall Tracking.
abstract void	validateAndTrackInAppPurchase(android.content.Context context, java.lang.String publicKey, java.lang.String signature, java.lang.String purchaseData, java.lang.String price, java.lang.String currency, java.util.Map<java.lang.String,java.lang.String> additionalParameters) API for server verification of in-app purchases.
abstract void	waitForCustomerUserId(boolean wait) It is possible to delay the SDK Initialization until the customerUserID is set.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppsFlyerLib

public AppsFlyerLib()

Method Detail

getInstance

public static AppsFlyerLib getInstance()

Get the singleton instance of the AppsFlyerLib tracker object.

Returns:

AppsFlyerLib tracking object instance.

stopTracking

public abstract void stopTracking(boolean isTrackingStopped,
                                  android.content.Context context)

Once this API is invoked, our SDK no longer communicates with our servers and stops functioning. In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API

Parameters:

isTrackingStopped - should tracking be stopped.

context - Application / Activity context.

getSdkVersion

public abstract java.lang.String getSdkVersion()

Get the AppsFlyer SDK version used in app.

Returns:

AppsFlyer SDK version.

onPause

public abstract void onPause(android.content.Context context)

For Cocos2dx platform only Cocos2dx has his own applicationDidEnterBackground event. Therefore 'onPause' will be called from C++ by JNI

setGCMProjectID

@Deprecated
public abstract void setGCMProjectID(java.lang.String projectNumber)

Deprecated. use enableUninstallTracking(String) instead.

setGCMProjectNumber

@Deprecated
public abstract void setGCMProjectNumber(java.lang.String projectNumber)

Deprecated. use enableUninstallTracking(String) instead.

setGCMProjectNumber

@Deprecated
public abstract void setGCMProjectNumber(android.content.Context context,
                                                     java.lang.String projectNumber)

Deprecated. use enableUninstallTracking(String) instead.

enableUninstallTracking

@Deprecated
public abstract void enableUninstallTracking(java.lang.String senderId)

Deprecated. see documentation
Manually set the sender ID for a Firebase / GCM project for Uninstall Tracking.

Parameters:

senderId - Firebase / GCM Sender ID.

updateServerUninstallToken

public abstract void updateServerUninstallToken(android.content.Context context,
                                                java.lang.String token)

Manually pass the Firebase / GCM Device Token for Uninstall Tracking.

Parameters:

context - Application / Activity context.

token - Firebase / GCM Device Token.

setDebugLog

public abstract void setDebugLog(boolean shouldEnable)

Enables Debug logs for the AppsFlyer SDK. Should only be set to true in development / debug.

Parameters:

shouldEnable - boolean.

setImeiData

public abstract void setImeiData(java.lang.String aImei)

By default, IMEI and Android ID are not collected by the SDK if the OS version is higher than KitKat (4.4) and the device contains Google Play Services (on SDK versions 4.8.8 and below the specific app needed GPS). Use this API to explicitly send IMEI to AppsFlyer.

Parameters:

aImei - device's IMEI.

setOaidData

public abstract void setOaidData(java.lang.String oaid)

By default, OAID is not collected by the SDK. Use this API to explicitly send OAID to AppsFlyer.

Parameters:

oaid - device's OAID.

setAndroidIdData

public abstract void setAndroidIdData(java.lang.String aAndroidId)

By default, IMEI and Android ID are not collected by the SDK if the OS version is higher than KitKat (4.4) and the device contains Google Play Services (on SDK versions 4.8.8 and below the specific app needed GPS). Use this API to explicitly send Android ID to AppsFlyer.

Parameters:

aAndroidId - device's Android ID.

enableLocationCollection

public abstract AppsFlyerLib enableLocationCollection(boolean flag)

Enable the AppsFlyer SDK to collect the last known location, Requires Manifest.permission#ACCESS_COARSE_LOCATION and Manifest.permission#ACCESS_FINE_LOCATION Manifest permissions.

Parameters:

flag - boolean.

setAppUserId

@Deprecated
public abstract void setAppUserId(java.lang.String id)

Deprecated. use setCustomerUserId(String) instead

setCustomerUserId

public abstract void setCustomerUserId(java.lang.String id)

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with Postback APIs for cross-referencing with your internal IDs.

Parameters:

id - Customer ID for client.

setPhoneNumber

public abstract void setPhoneNumber(java.lang.String phoneNumber)

Will be sent as SHA-256

waitForCustomerUserId

public abstract void waitForCustomerUserId(boolean wait)

It is possible to delay the SDK Initialization until the customerUserID is set. This feature makes sure that the SDK doesn't begin functioning until the customerUserID is provided. If this API is used, all in-app events and any other SDK API calls are discarded, until the customerUserID is provided and tracked.

Parameters:

wait - boolean.

setCustomerIdAndTrack

public abstract void setCustomerIdAndTrack(java.lang.String id,
                                           android.content.Context context)

Use this API to provide the SDK with the relevant customer user id and trigger the SDK to begin its normal tracking.

Parameters:

id - Customer ID for client.

context - Application / Activity context.

getOutOfStore

public abstract java.lang.String getOutOfStore(android.content.Context context)

Get the current AF_STORE value.

Parameters:

context - Application / Activity context.

Returns:

AF_Store value.

setOutOfStore

public abstract void setOutOfStore(java.lang.String sourceName)

Manually set the AF_STORE value.

Parameters:

sourceName - value to be set.

setAppInviteOneLink

public abstract void setAppInviteOneLink(java.lang.String oneLinkId)

Set the OneLink ID that should be used for User-Invite-tracking The link that is generated for the user invite will use this OneLink as the base link.

Parameters:

oneLinkId - OneLink ID obtained from the AppsFlyer Dashboard.

setAdditionalData

public abstract void setAdditionalData(java.util.HashMap<java.lang.String,java.lang.Object> customData)

Set additional data to be sent to AppsFlyer.

Parameters:

customData - additional data HashMap.

sendDeepLinkData

public abstract void sendDeepLinkData(android.app.Activity activity)

Send tracking data from deep-linkable Activity. use with each activity that may be used for deep linking (including the main activity if needed).

Parameters:

activity - The Activity used for deep linking.

sendPushNotificationData

public abstract void sendPushNotificationData(android.app.Activity activity)

Allows you to measure push notifications as part of a retargeting campaign. To enable this feature, call the next method inside the onCreate method of every Activity which will be launched upon clicking the notification.

Parameters:

activity - The Activity which will be launched upon clicking the notification.

setUserEmail

@Deprecated
public abstract void setUserEmail(java.lang.String email)

Deprecated. use setUserEmails(AppsFlyerProperties.EmailsCryptType, String...) instead

setUserEmails

public abstract void setUserEmails(java.lang.String... emails)

Set the user emails

Parameters:

emails - User emails.

setUserEmails

public abstract void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
                                   java.lang.String... emails)

Set the user emails and encrypt them.

Parameters:

cryptMethod - Encryption method: AppsFlyerProperties.EmailsCryptType.NONE, AppsFlyerProperties.EmailsCryptType.SHA1, AppsFlyerProperties.EmailsCryptType.MD5, AppsFlyerProperties.EmailsCryptType.SHA256

emails - User emails.

setCollectAndroidID

public abstract void setCollectAndroidID(boolean isCollect)

Opt-out of collection of Android ID. If the app does NOT contain Google Play Services, Android ID is collected by the SDK. However, apps with Google play services should avoid Android ID collection as this is in violation of the Google Play policy.

Parameters:

isCollect - boolean, false to opt-out.

setCollectIMEI

public abstract void setCollectIMEI(boolean isCollect)

Opt-out of collection of IMEI. If the app does NOT contain Google Play Services, device IMEI is collected by the SDK. However, apps with Google play services should avoid IMEI collection as this is in violation of the Google Play policy.

Parameters:

isCollect - boolean, false to opt-out.

setCollectOaid

public abstract void setCollectOaid(boolean isCollect)

Opt-in of collection of OAID. To collect OAID the Huawei OAID Jar must be included.

Parameters:

isCollect - boolean, true to opt-in.

setCollectFingerPrint

@Deprecated
public abstract void setCollectFingerPrint(boolean isCollect)

Deprecated.

setResolveDeepLinkURLs

public abstract void setResolveDeepLinkURLs(java.lang.String... urls)

Advertisers can wrap AppsFlyer OneLink within another Universal Link. This Universal Link will invoke the app but any deep linking data will not propagate to AppsFlyer.

setResolveDeepLinkURLs API allows to Appsflyer SDK to resolve provided urls, to be able to deep link from a OneLink wrapped within another Universal Link and also track this retargeting conversion.

For example:

• "example.com"
• "example.com/param1"
• "example.com/param1/param2"

Note, if "example.com" is provided, the App link "my.example.com" will not match because of prefix "my." Be sure to provide explicit url names

Parameters:

urls - - Array of urls

setOneLinkCustomDomain

public abstract void setOneLinkCustomDomain(java.lang.String... domains)

init

public abstract AppsFlyerLib init(java.lang.String key,
                                  AppsFlyerConversionListener conversionDataListener)

Use this method to initialize AppsFlyer SDK. This API should be called inside your Application class's onCreate method.

Parameters:

key - AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account, under 'App Settings' in the dashboard.

conversionDataListener - (Optional) implement the ConversionDataListener to access AppsFlyer's conversion data. Can be null.

init

public abstract AppsFlyerLib init(java.lang.String key,
                                  AppsFlyerConversionListener conversionDataListener,
                                  android.content.Context context)

Same as init(String, AppsFlyerConversionListener) with additional argument Context to handle new install referrer

startTracking

public abstract void startTracking(android.app.Application application)

Use this method to start tracking the application, only if you call 'init' inside you Application class's onCreate method. AppsFlyer's Dev-Key must be provided in the 'init' method, or in the legacy API: startTracking(Application, String)

Parameters:

application - the Application object which is used for registering for the app's life-cycle

startTracking

public abstract void startTracking(android.app.Application application,
                                   java.lang.String key)

Use this method to start tracking the application. This call can initialize tracking without previously setting the dev key via the init method and without specifying a onTrackingRequestListener.

Parameters:

application - the Application object which is used for registering for the app's life-cycle

key - AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account, under 'App Settings' in the dashboard.

startTracking

public abstract void startTracking(android.app.Application application,
                                   java.lang.String key,
                                   AppsFlyerTrackingRequestListener onTrackingRequestListener)

Use this method to start tracking the application. Notice that AppsFlyer's Dev-Key must be provided.

Parameters:

application - the Application object which is used for registering for the app's life-cycle

key - AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account, under 'App Settings' in the dashboard.

onTrackingRequestListener - An optional listener for getting the request status - A 200 OK response from server will invoke the onTrackingRequestSuccess() method onTrackingRequestFailure(String error) will return the error in case one occurs

setAppId

public abstract void setAppId(java.lang.String id)

setExtension

public abstract void setExtension(java.lang.String extension)

SDK plugins and extensions will set this field

setIsUpdate

public abstract void setIsUpdate(boolean isUpdate)

Manually set that the application was updated.

Parameters:

isUpdate - boolean value

setCurrencyCode

public abstract void setCurrencyCode(java.lang.String currencyCode)

Setting user local currency code for in-app purchases. The currency code should be a 3 character ISO 4217 code. (default is USD). You can set the currency code for all events by calling the following method

Parameters:

currencyCode - 3 character ISO 4217 code

trackLocation

public abstract void trackLocation(android.content.Context context,
                                   double latitude,
                                   double longitude)

Manually track the location of the user

Parameters:

context - Application / Activity context

latitude - latitude as double

longitude - longitude as double

trackAppLaunch

public abstract void trackAppLaunch(android.content.Context ctx,
                                    java.lang.String devKey)

Send an immediate launch event (regardless of lifecycle)

Parameters:

ctx - Application / Activity context

devKey - AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account, under 'App Settings' in the dashboard.

setPluginDeepLinkData

public abstract void setPluginDeepLinkData(android.content.Intent intent)

SDK plugins and extensions will set this field

Parameters:

intent - Activity intent

reportTrackSession

public abstract void reportTrackSession(android.content.Context ctx)

If your app is a utility app running in the background you can use this API in your activity’s onCreate()

Parameters:

ctx - Application / Activity context

trackEvent

public abstract void trackEvent(android.content.Context context,
                                java.lang.String eventName,
                                java.util.Map<java.lang.String,java.lang.Object> eventValues)

Track an In-App Event. In-App Events provide insight on what is happening in your app.

Parameters:

context - Application / Activity context

eventName - Event Name as String

eventValues - Event Values as Map

trackEvent

public abstract void trackEvent(android.content.Context context,
                                java.lang.String eventName,
                                java.util.Map<java.lang.String,java.lang.Object> eventValues,
                                AppsFlyerTrackingRequestListener onTrackingRequestListener)

Same as trackEvent(Context, String, Map) with AppsFlyerTrackingRequestListener. HttpURLConnection.HTTP_OK from server will invoke the AppsFlyerTrackingRequestListener.onTrackingRequestSuccess() method. AppsFlyerTrackingRequestListener.onTrackingRequestFailure(String) will return the error in case one occurs

setDeviceTrackingDisabled

public abstract void setDeviceTrackingDisabled(boolean isDisabled)

Anonymize user Data. Use this API during the SDK Initialization to explicitly anonymize a user's installs, events and sessions. Default is false

Parameters:

isDisabled - boolean

enableFacebookDeferredApplinks

public abstract void enableFacebookDeferredApplinks(boolean isEnabled)

Enable the collection of Facebook Deferred AppLinks Requires Facebook SDK and Facebook app on target/client device. This API must be invoked prior to initializing the AppsFlyer SDK in order to function properly.

Parameters:

isEnabled - should Facebook's deferred app links be processed by the AppsFlyer SDK.

registerConversionListener

public abstract void registerConversionListener(android.content.Context context,
                                                AppsFlyerConversionListener conversionDataListener)

Register a Conversion Data Listener. Allows the developer to access the user attribution data in real-time for every new install, directly from the SDK level. By doing this you can serve users with personalized content or send them to specific activities within the app, which can greatly enhance their engagement with your app.

Parameters:

context - Application / Activity context

conversionDataListener - AppsFlyerConversionListener interface with onInstallConversionDataLoaded and onAppOpenAttribution callback methods.

unregisterConversionListener

public abstract void unregisterConversionListener()

Unregister a previously registered AppsFlyerConversionListener.

registerValidatorListener

public abstract void registerValidatorListener(android.content.Context context,
                                               AppsFlyerInAppPurchaseValidatorListener validationListener)

Register a validation listener for the validateAndTrackInAppPurchase(android.content.Context, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) API.

Parameters:

context - Application / Activity context.

validationListener - AppsFlyerInAppPurchaseValidatorListener interface with \ onValidateInApp and onValidateInAppFailure callback methods

setConsumeAFDeepLinks

public abstract void setConsumeAFDeepLinks(boolean doConsume)

Restrict the tracking of reengagement via deep-link to once per each unique deep-link. Otherwise deep re-occurring deep-links will be permitted for non-singleTask Activities and deep-linking via AppsFlyer deep-links. The default value is false

Parameters:

doConsume - boolean

setPreinstallAttribution

public abstract void setPreinstallAttribution(java.lang.String mediaSource,
                                              java.lang.String campaign,
                                              java.lang.String siteId)

Specify the manufacturer or media source name to which the preinstall is attributed.

Parameters:

mediaSource - Manufacturer or media source name for preinstall attribution.

campaign - Campaign name for preinstall attribution.

siteId - Site ID for preinstall attribution.

isPreInstalledApp

public abstract boolean isPreInstalledApp(android.content.Context context)

Boolean indicator for preinstall by Manufacturer.

Parameters:

context - Application / Activity context.

Returns:

boolean.

getAttributionId

public abstract java.lang.String getAttributionId(android.content.Context context)

Get the Facebook attribution ID, if one exists.

getAttributionId

@Deprecated
public abstract java.lang.String getAttributionId(android.content.ContentResolver contentResolver)

Deprecated. use getAttributionId(Context) instead.

Get the Facebook attribution ID, if one exists.

Parameters:

contentResolver - ContentResolver, applications access to the content model.

Returns:

Facebook attribution ID.

getAppsFlyerUID

public abstract java.lang.String getAppsFlyerUID(android.content.Context context)

Get AppsFlyer's unique device ID is created for every new install of an app.

Parameters:

context - Application / Activity context.

Returns:

AppsFlyer's unique device ID.

validateAndTrackInAppPurchase

public abstract void validateAndTrackInAppPurchase(android.content.Context context,
                                                   java.lang.String publicKey,
                                                   java.lang.String signature,
                                                   java.lang.String purchaseData,
                                                   java.lang.String price,
                                                   java.lang.String currency,
                                                   java.util.Map<java.lang.String,java.lang.String> additionalParameters)

API for server verification of in-app purchases. An af_purchase event with the relevant values will be automatically tracked if the validation is successful.

Parameters:

context - Application / Activity context.

publicKey - License Key obtained from the Google Play Console.

signature - data.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data)

purchaseData - data.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data)

price - Purchase price, should be derived from skuDetails.getStringArrayList("DETAILS_LIST")

currency - Purchase currency, should be derived from skuDetails.getStringArrayList("DETAILS_LIST")

additionalParameters - Freehand parameters to be tracked with the purchase (if validated).

onHandleReferrer

public abstract void onHandleReferrer(java.util.Map<java.lang.String,java.lang.String> referrer)

Internal API.

Parameters:

referrer - NA.

isTrackingStopped

public abstract boolean isTrackingStopped()

Was the stopTracking(boolean, Context) API set to true.

Returns:

boolean.

setMinTimeBetweenSessions

public abstract void setMinTimeBetweenSessions(int seconds)

Set a custom value for the minimum required time between sessions. By default, at least 5 seconds must lapse between 2 app launches to count as separate 2 sessions.

Parameters:

seconds - minimum time between 2 separate sessions in seconds.

setLogLevel

public abstract void setLogLevel(AFLogger.LogLevel logLevel)

Sets the SDK's Log Level.

Parameters:

logLevel - logLevel as String: AFLogger.LogLevel.NONE, AFLogger.LogLevel.ERROR, AFLogger.LogLevel.WARNING, AFLogger.LogLevel.INFO, AFLogger.LogLevel.DEBUG, AFLogger.LogLevel.VERBOSE.

setHost

public abstract void setHost(java.lang.String hostPrefixName,
                             java.lang.String hostName)

Set a custom host for tracking.

Parameters:

hostPrefixName - Host prefix.

hostName - Host name.

getHostName

public abstract java.lang.String getHostName()

Get the host name used for tracking. Default value is "appsflyer.com"

Returns:

Host name.

getHostPrefix

public abstract java.lang.String getHostPrefix()

Get the custom set tracking host prefix.

Returns:

Host prefix.

setHostName

@Deprecated
public abstract void setHostName(java.lang.String hostname)

Deprecated.