Package 

Class AppsFlyerLib

    • Method Detail

      • stop

         abstract void stop(boolean shouldStop, 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 logging due to legal and privacy compliance.This can be achieved with the isStopped API

        Parameters:
        shouldStop - should logging be stopped.
        context - Application / Activity context.

      • onPause

         abstract void onPause(Context context)

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

      • updateServerUninstallToken

         abstract void updateServerUninstallToken(Context context, String token)

        Manually pass the Firebase Device Token for Uninstall Measurement.

        Parameters:
        context - Application / Activity context.
        token - Firebase Device Token.

      • setDebugLog

         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

         abstract void setImeiData(String imei)

        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:
        imei - device's IMEI.

      • setOaidData

         abstract void setOaidData(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

         abstract void setAndroidIdData(String androidId)

        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:
        androidId - device's Android ID.

      • setCustomerUserId

         abstract void setCustomerUserId(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.

      • waitForCustomerUserId

         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 logged.

        Parameters:
        wait - boolean.

      • setCustomerIdAndLogSession

         abstract void setCustomerIdAndLogSession(String id, @NonNull() Context context)

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

        Parameters:
        id - Customer ID for client.
        context - Application / Activity context.

      • getOutOfStore

         abstract String getOutOfStore(Context context)

        Get the current AF_STORE value.

        Parameters:
        context - Application / Activity context.

      • setOutOfStore

         abstract void setOutOfStore(String sourceName)

        Manually set the AF_STORE value.

        Parameters:
        sourceName - value to be set.

      • setAppInviteOneLink

         abstract void setAppInviteOneLink(String oneLinkId)

        Set the OneLink ID that should be used for User-Invite-loggingThe 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

         abstract void setAdditionalData(Map<String, Object> customData)

        Set additional data to be sent to AppsFlyer.

        Parameters:
        customData - additional data HashMap.

      • sendPushNotificationData

         abstract void sendPushNotificationData(Activity activity)

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

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

      • setUserEmails

         abstract void setUserEmails(Array<String> emails)

        Set the user emails

        Parameters:
        emails - User emails.

      • setUserEmails

         abstract void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod, Array<String> emails)

        Set the user emails and encrypt them.

        Parameters:
        cryptMethod - Encryption method:AppsFlyerProperties.EmailsCryptType.NONE,AppsFlyerProperties.EmailsCryptType.SHA1,AppsFlyerProperties.EmailsCryptType.MD5,AppsFlyerProperties.EmailsCryptType.
        emails - User emails.

      • setCollectAndroidID

         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

         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.

      • setResolveDeepLinkURLs

         abstract void setResolveDeepLinkURLs(Array<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 resolveprovided urls, to be able to deep link from a OneLinkwrapped within another Universal Link and also log this retargetingconversion.

        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

         abstract void setOneLinkCustomDomain(Array<String> domains)

        In order for AppsFlyer SDK to successfully resolve hidden (decoded in shortlink ID)attribution params any domain that is configured as branded domain in AppsFlyer Dashboard should be provided in this API

        Parameters:
        domains - Array of domains that should be treated by SDK as branded (SDK will try toresolve them as Onelinks)

      • init

         abstract AppsFlyerLib init(@NonNull() String key, AppsFlyerConversionListener conversionDataListener, @NonNull() Context context)

        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 AppsFlyeraccount, under 'App Settings' in the dashboard.
        conversionDataListener - (Optional) implement the ConversionDataListener toaccess AppsFlyer's conversion data.
        context - to handle new install referrer

      • setExtension

         abstract void setExtension(String extension)

        SDK plugins and extensions will set this field

      • setIsUpdate

         abstract void setIsUpdate(boolean isUpdate)

        Manually set that the application was updated.

        Parameters:
        isUpdate - boolean value

      • setCurrencyCode

         abstract void setCurrencyCode(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

      • logLocation

         abstract void logLocation(Context context, double latitude, double longitude)

        Manually log the location of the user

        Parameters:
        context - Application / Activity context
        latitude - latitude as double
        longitude - longitude as double

      • logSession

         abstract void logSession(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

      • logEvent

         abstract void logEvent(Context context, String eventName, Map<String, Object> eventValues)

        Log 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

      • anonymizeUser

         abstract void anonymizeUser(boolean shouldAnonymize)

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

        Parameters:
        shouldAnonymize - boolean

      • enableFacebookDeferredApplinks

         abstract void enableFacebookDeferredApplinks(boolean isEnabled)

        Enable the collection of Facebook Deferred AppLinksRequires 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

         abstract void registerConversionListener(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 withonConversionDataSuccess and onAppOpenAttribution callback methods.

      • setPreinstallAttribution

         abstract void setPreinstallAttribution(String mediaSource, String campaign, 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

         abstract boolean isPreInstalledApp(Context context)

        Boolean indicator for preinstall by Manufacturer.

        Parameters:
        context - Application / Activity context.

      • getAppsFlyerUID

        @Nullable() abstract String getAppsFlyerUID(@NonNull() Context context)

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

        Parameters:
        context - Application / Activity context.

      • validateAndLogInAppPurchase

         abstract void validateAndLogInAppPurchase(Context context, String publicKey, String signature, String purchaseData, String price, String currency, Map<String, String> additionalParameters)

        API for server verification of in-app purchases.An af_purchase event with the relevant values will be automatically logged 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 logged with the purchase (if validated).

      • isStopped

         abstract boolean isStopped()

        Was the stop API set to true.

      • setMinTimeBetweenSessions

         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

         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

         abstract void setHost(@Nullable() String hostPrefixName, @NonNull() String hostName)

        Set a custom host.

        Parameters:
        hostPrefixName - Host prefix.
        hostName - Host name.

      • getHostName

         abstract String getHostName()

        Get the host name.Default value is "appsflyer.com"

      • setSharingFilter

        @Deprecated() abstract void setSharingFilter(@NonNull() Array<String> partners)

        Block events from being shared with ad networks and other 3rd party integrations

        Parameters:
        partners - must only include letters/digits and underscore, maximum length: 45

      • performOnDeepLinking

         abstract void performOnDeepLinking(@NonNull() Intent intent, @NonNull() Context context)

        Manual way of enabling Unified Deep Linking API without calling startIf DeepLinkListener is registered - supports both deferred (first launch only)and direct deep linkingIf AppsFlyerConversionListener is registered only supports direct deep linkingRecommended to call this from onResume of every activity that can belaunched via deep linkNotes:- Duplicate calls with the same intent containing the deep link will be deduplicated- Proper deep linking intent must have ACTION_VIEW and Uri data- Direct deep links processed by this API will not be reported to the server as of SDKv6.3.2. This may affect install attribution or re-engagement records.

      • addPushNotificationDeepLinkPath

         abstract void addPushNotificationDeepLinkPath(Array<String> deepLinkPath)

        Resolve deep links from the push notification.

        Specify path to deeplink url in the data part of the push notification payloadin order to get them resolved to 1 of the the callbacks when app is opened by a clickon a notification:

        onDeepLinkingonAppOpenAttribution
        Parameters:
        deepLinkPath - List of path elements in correct order

      • setPartnerData

         abstract void setPartnerData(@NonNull() String partnerId, Map<String, Object> data)

        Allows sending custom data for partner integration purposes.

        Parameters:
        partnerId - ID of the partner (usually has "_int" suffix)
        data - customer data, depends on the integration nature with specific partner

      • setDisableAdvertisingIdentifiers

         abstract void setDisableAdvertisingIdentifiers(boolean disable)

        Disable collection of Google, Amazon and Open advertising ids (GAID, AAID, OAID).By default collection is enabled.

      • setDisableNetworkData

         abstract void setDisableNetworkData(boolean disable)

        Use this API to prevent the SDK from collecting the network operator name (carrier) and simoperator name from the deviceBy default collection is enabled.

      • setSharingFilterForPartners

         abstract void setSharingFilterForPartners(Array<String> partners)

        Block events from being shared with ad networks and other 3rd party integrations.String "all" will block events from being shared with any partner.

        Parameters:
        partners - must only include letters/digits and underscore, maximum length: 45

      • sendPurchaseData

         abstract void sendPurchaseData(Context context, Map<String, Object> requestData, PurchaseHandler.PurchaseValidationCallback callback)

        Send ars purchase data for validation and reporting. Not intended for public usage, to be usedonly from AppsFlyer Purchase Connector module

        Parameters:
        context - Application context
        requestData - ars purchase data for validation
        callback - to return the validation result

      • sendInAppPurchaseData

         abstract void sendInAppPurchaseData(Context context, Map<String, Object> requestData, PurchaseHandler.PurchaseValidationCallback callback)

        Send in app purchase data for validation and reporting. Not intended for public usage, to be usedonly from AppsFlyer Purchase Connector module

        Parameters:
        context - Application context
        requestData - in app purchase data for validation
        callback - to return the validation result

      • setPluginInfo

         abstract void setPluginInfo(@NonNull() PluginInfo pluginInfo)

        Internal API. Please don't use.Throws: NullPointerException – if pluginInfo is null.