s3eAppsFlyer

Marmalade extension for http://appsflyer.com SDK.
Supports iOS platforms.

On iOS used AppsFlyer iOS SDK v2.5.3.10

HOW TO USE

Add the following to the MKB file for your project:

options 
{
    #Adjust path as necessary:
    module_path="../s3eAppsFlyer" 
}

subprojects
{
    s3eAppsFlyer
}

Then add to your app.icf

[APPSFLYER]
appleAppId="Add your App Store application id here (for android this not needed)"
devKey="Add your AppsFlyer dev key here"
isHTTPS=true
autoStart=true
currencyCode="ISO currency code (optional)"

Where
isHTTPS key is optional. Default is false.
autoStart key is optional. Default is false.

If you set autoStart to true then this is all you need to start tracking installs, updates and sessions. (For Android you must also make sure you using right AndroidManifest.xml).
If you wish track additional in-app events beyond app installs (including in-app purchases, game levels, etc.) then you must use API.

If you don't want to use .icf file or you want to set your own custom user ID then you must call s3eAppsFlyerStartSession.

API Reference

Data Structures

typedef struct s3eAppsFlyerConversionData
{
    /// Keys from dictionary returned to onConversionDataReceived. The pointer is valid until your callback returns.
    char** m_Keys;

    /// Values from dictionary returned to onConversionDataReceived. The pointer is valid until your callback returns.
    char** m_Values;

    /// Number of keys and values in m_Keys and m_Values arrays. Will be zero if there was error.
    int m_Num;
};

This struct stores conversion data. This data kept valid until your callback returns.

Methods

s3eBool s3eAppsFlyerAvailable();

Returns S3E_TRUE if the AppsFlyer extension is available.

s3eResult s3eAppsFlyerStartSession(const char* appleAppId S3E_DEFAULT(NULL), const char* devKey S3E_DEFAULT(NULL), const char* currencyCode S3E_DEFAULT(NULL), s3eBool isHTTPS S3E_DEFAULT(S3E_FALSE), const char* customerUserID S3E_DEFAULT(NULL) );

Must be first method called. Initializes SDK. Called automatically if autoStart set to true.

void s3eAppsFlyerTrackEvent(const char* eventName, const char* value S3E_DEFAULT(NULL));

Allows you to send in-app events to AppsFlyer analytics. This method allows you to add events dynamically by adding them directly to the application code.
Params:

• eventName is any string to define the event name . For example: "registration" or "purchase"
• value is the sales value. For example: "0.99" or "0.79"

void s3eAppsFlyerSetHTTPS(s3eBool isHTTPS);

If you wish to force the SDK to use HTTPS at all times, please call s3eAppsFlyerSetHTTPS(S3E_FALSE)

void s3eAppsFlyerSetTrackingDisable(s3eBool _disable);

AppsFlyer provides you a method to opt-out specific users from AppsFlyer analytics.
This method complies with the latest privacy requirements and complies with Facebook data and privacy policies.

void s3eAppsFlyerSetCurrencyCode(const char* currencyCode);

Set currency code:
USD is default value. Acceptable ISO Currency codes here. Examples:
British Pound: s3eAppsFlyerSetCurrencyCode("GBP");
US Dollar:
s3eAppsFlyerSetCurrencyCode("USD");

void s3eAppsFlyerSetCustomerUserID(const char* customerUserID);

Set customer user ID with the SDK and reporting (used to match with the client internal ID's).
See section 8 of doc for more details.

const char * getAppsFlyerUID();

Get AppsFlyer's proprietary device ID. AppsFlyer device ID is the main ID used by AppsFlyer in the Reports and API's.

void s3eAppsFlyerLoadConversionData();

Gets conversion data using loadConversionDataWithDelegate method of AppsFlyer SDK.
Data returned in callback S3E_APPSFLYER_GOT_CONVERSION_DATA.