Android V3.0.X

Introduction

SDK overview

Welcome to the Flagship Android SDK documentation!

The following article will guide you through the steps to get Flagship up and running on your native Android app using our client library with preconfigured methods to implement the Decision API.

Feel free to contact us if you have any questions regarding this documentation.

Release notes

See here

SDK features

This SDK version will help you:

Prerequisites

  • Your app must be a native Android app written in Kotlin or Java

  • Your app must at least be compatible with Android API version 21 (Android 5.0) OR version 16 (Android 4.1) if you use the compatibility version of our library. See dependencies

    The minSdkVersion value in your app module's build.gradle file must be greater than or equal to 21:

android {
    compileSdkVersion 28
    defaultConfig {
        minSdkVersion 21
        ...
    }
}
  • Your app must have the necessary permissions to use the Internet

    Internet permission must be enabled in the <application> tag of your app's AndroidManifest.xml file:

<?xml version="1.0" encoding="utf-8"?>
<manifest>
    <uses-permission android:name="android.permission.INTERNET" />
    <!-- [...] -->
</manifest>
  • Your app must have AndroidX enabled

Good to know

Getting Started

Installation

To install the library, start by adding the following repository in the main build.gradle file of your Android project so that Gradle can find and build with the library:

https://abtasty.jfrog.io/artifactory/flagship-android/

allprojects {
    repositories {
        maven {
            url 'https://abtasty.jfrog.io/artifactory/flagship-android/'
        }
    }
}

Then add the following library dependency in the build.gradle file of your app module:

com.abtasty:flagship-android:x.x.x

📘

Replace x.x.x with the desired version of the Flagship SDK.

dependencies {
    implementation 'com.abtasty:flagship-android:3.0.0
}

🚧

If you need to target Android versions from Android 4.1+ API level 16+, use the following code, starting at version 1.2.1 of the Flagship Android SDK:

com.abtasty:flagship-android-compat:x.x.x

Available from the maven repository url:

https://abtasty.jfrog.io/artifactory/flagship-android-compat/

This version ensures TLS 1.2 compatibility between our servers and Android 4.1+, but we do not recommand using it due to lack of TLS 1.2 support by these platforms.

Initialization

To initialize and start the library, just call the start() function of the Flagship class in the most appropriate location for your application.

class MyActivity : Activity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        Flagship.start(getApplication(),"_ENV_ID_", "_API_KEY_", FlagshipConfig.DecisionApi()
    }
}

fun start(application : Application, envId: String, apiKey: String, config: FlagshipConfig<*>)

ParameterTypeDescription
applicationApplicationyour Android application base class.
envIdStringEnvironment id provided by Flagship.
apiKeyStringApi authentication key provided by Flagship.
configFlagshipConfig<*>Flagship configuration to use.

📘

You can find your apiKey and your environmentId on your Flagship account, in Parameters > Environment & Security.

Flagship configuration : FlagshipConfig.

This class aims to help you to configure the SDK via the following two available config implementations: DecisionApi and Bucketing. See Decision Mode section.

//Start the Flagship SDK in Api mode.
Flagship.start(getApplication(), "_ENV_ID_", "_API_KEY_", FlagshipConfig.DecisionApi()
            .withStatusListener { status -> }
            .withLogLevel(LogManager.Level.ALL)
            .withTimeout(500)
            .withCacheManager(customCacheManager)
            .withLogManager(customLogManager)
        )


//Start the Flagship SDK in Bucketing mode.
Flagship.start(getApplication(), "_ENV_ID_", "_API_KEY_", FlagshipConfig.Bucketing()
            .withStatusListener { status -> }
            .withLogLevel(LogManager.Level.ALL)
            .withTimeout(500)
            .withCacheManager(customCacheManager)
            .withLogManager(customLogManager)
            .withPollingIntervals(5, TimeUnit.MINUTES)
        )

  • fun withStatusListener(listener: ((Flagship.Status) -> Unit)): T

    This method defines a new lambda in order to get a callback when the SDK status has changed.
    
    Parameter | Type    | Description
    --------- | ------- | -----------
    listener     | Flagship.Status -> Unit   |  lambda to invoke when SDK status have changed. **See [SDK status](./v3.0#status) section**.
    

  • fun withLogLevel(level: LogManager.Level): T

    Specifies a log level to filter logs emitted by the SDK.

    ParameterTypeDescription
    levelLogManager.Level levelThe levels in ascending order are : NONE(0), EXCEPTIONS(1), ERROR(2), WARNING(3), DEBUG(4), INFO(5), ALL(6).

  • fun withTimeout(timeout: Int): T

    Specifies timeout for api requests.

    ParameterTypeDescription
    timeoutintMilliseconds for connect and read timeouts. Default is 2000 ms.

  • fun withCacheManager(customCacheManager: CacheManager): T

    Specifies a custom cache manager implementation. See Cache management section
    Parameter | Type | Description
    --------- | ------- | -----------
    customCacheManager | CacheManager | Custom implementation.


  • fun withLogManager(customLogManager: LogManager): T

    Specifies a custom implementation of LogManager in order to receive logs from the SDK.

    ParameterTypeDescription
    customLogManagerLogManagerCustom implementation of LogManager.

Only available for Bucketing Mode:

  • fun withPollingIntervals(time: Long, timeUnit: TimeUnit): Bucketing

    Define time interval between two bucketing updates. Default is 60 seconds. MICROSECONDS and NANOSECONDS Unit are ignored.

    ParameterTypeDescription
    timeLongtime value.
    timeUnitTimeUnittime unit. Must be greater or equal to MILLISECONDS

Decision Mode

DecisionApi Mode

When the SDK is running in DecisionApi mode, the campaign assignments and targeting validation take place server-side. In this mode, each call to the fetchFlags method to refresh the flags will create an HTTP request.

Bucketing Mode

When the SDK is running in Bucketing mode, the SDK downloads all the campaigns configurations at once in a single bucketing file so that variation assignment can be computed client-side by the SDK. This bucketing file is stored in cache and will only be downloaded again when campaign configurations are modified in the Flagship interface. Learn more


SDK Status

List of the possible SDK status :

StatusDescription
NOT_INITIALIZEDFlagship SDK has not been started or initialized successfully.
STARTINGFlagship SDK is starting.
POLLINGFlagship SDK has been started successfully but is still polling campaigns. (Only when Bucketing mode is used)
PANICFlagship SDK is ready but is running in Panic mode: All visitor's features are disabled except 'fetchFlags' which refreshes this status.
READYFlagship SDK is ready to use.

It is possible to get the current status via the method getStatus() from the Flagship class.

  • fun getStatus(): Status

    Return the current SDK status


Create a new visitor


The visitor instance is a helper object that lets you manage the context and campaigns for a user identified by a unique ID.

The user context is a property dataset that defines the current user of your app. This dataset is sent and used by the Flagship Decision API as targeting criteria for campaign assignment.

For example, if you want to enable or disable a specific feature based on VIP status, you would pass this attribute as a key-value pair in the user context so that the Decision API can enable or disable the corresponding feature flag for the user.

val visitor1 = Flagship.newVisitor("visitor_1")
            .context(hashMapOf("age" to "32", "isVIP" to true))
            .hasConsented(true)
            .isAuthenticated(true)
            .build()

  • fun newVisitor(visitorId: String, instanceType: Visitor.Instance = Visitor.Instance.SINGLE_INSTANCE): Visitor.Builder

    Return a Visitor Builder class which aims to help creating new visitors.

    ParameterTypeDescription
    visitorIdStringUnique visitor identifier.
    instanceTypeVisitor.InstanceHow Flagship SDK should handle the newly created visitor instance. (Default is SINGLE_INSTANCE)

    SINGLE_INSTANCE :
    The newly created visitor instance will be returned and saved into the Flagship singleton. Call Flagship.getVisitor() to retrieve the instance. This option should be adopted on applications that handle only one visitor at the same time.

    NEW_INSTANCE:
    The newly created visitor instance wont be saved and will simply be returned. Any previous visitor instance will have to be recreated. This option should be adopted on applications that handle multiple visitors at the same time.
      
    

Visitor Builder methods :

  • fun isAuthenticated(isAuthenticated: Boolean): Builder

    Specify if the visitor is authenticated or anonymous. Default value is false.

Parameter

Type

Default Value

Description

isAuthenticated

Boolean

false

True for authenticated user, false for anonymous.

  • fun hasConsented(hasConsented: Boolean): Builder

    Specify if the visitor has consented to personal data usage. When false some features will be deactivated, cache will be deactivated and cleared. Default value is True.

Parameter

Type

Default Value

Description

hasConsented

Boolean

true

True when user has given consent, false otherwise.

  • fun context(context: HashMap<String, Any>): Builder

    Specifies visitor initial context key / values used for targeting.
    Context keys must be String, and values types must be one of the following: Number, Boolean, String.

    ParameterTypeDescription
    contextHashMap<String, Any>Initial context.

🚧

  • User context keys must have a type of String
  • User context values must have a type of String, Boolean, Number.

  • public Visitor build()

    Return the newly created visitor.



Updating the visitor context


The user context is a property dataset that defines the current user of your app. This dataset is sent and used by the Flagship Decision API as targeting criteria for campaign assignment.

The following method from the Visitor instance allows you to set new context values matching the given keys.

val visitor1 = Flagship.newVisitor("visitor_1")
            .context(hashMapOf("age" to "32", "isVIP" to true))
            .hasConsented(true)
            .isAuthenticated(true)
            .build()

visitor1.updateContext("lastPurchaseDate", 1615384464)

fun <T> updateContext(key: String, value: T)

Upsert the visitor context values, matching the given keys, used for targeting. Only String, Boolean, Number typed values are accepted.

ParameterTypeDescription
keyStringContext key.
valueTContext value.

fun updateContext(context: HashMap<String, Any>)

Upsert the visitor context values, matching the given keys, used for targeting. Only String, Boolean, Number typed values are accepted.

ParameterTypeDescription
contextHashMap<String, Object>HashMap of keys, values.

🚧

  • User context keys must have a type of String
  • User context values must have a type of String, Boolean, Number.

fun <T> updateContext(flagshipContext: FlagshipContext<T>, value: T)

Upsert the visitor context values with Flagship predefined context key. **See FlagshipContext

ParameterTypeDescription
flagshipContextFlagshipContextPredefined context key
valueTvalue to add.


fun clearContext()

Clear all the visitor context values used for targeting.

val visitor1 = Flagship.newVisitor("visitor_1")
            .context(hashMapOf("age" to "32", "isVIP" to true))
            .hasConsented(true)
            .isAuthenticated(true)
            .build()

visitor1.clearContext()

getContext(): HashMap<String, Any>

Get visitor current context key / values.

val visitor1 = Flagship.newVisitor("visitor_1")
            .context(hashMapOf("age" to "32", "isVIP" to true))
            .hasConsented(true)
            .isAuthenticated(true)
            .build()

val context = visitor1.getContext()


Managing visitor campaigns and their flags


Fetching Flags

The fetchFlags() method of the visitor instance automatically updates the campaign assignments according to the current user context and retrieves applicable flags.

These flags are then stored in the SDK and updated asynchronously when fetchFlags() is called.


val visitor1 = Flagship.newVisitor("visitor_1").build()

visitor1.updateContext("postcode", "31200");

visitor1.fetchFlags().await()

fun fetchFlags(): Deferred<Unit>

This function will call the decision api and update all the campaigns flags from the server according to the visitor context.

ReturnDescription
Deferred<Unit>Return a Deferred to manage sync/async call.

Getting flags

Once the campaign has been assigned and fetched, all the flags are stored in the SDK. You can retrieve these flags using the following functions from the Visitor instance:


val visitor1 = Flagship.newVisitor("visitor_1").build()
visitor1.updateContext("isVip", true)
visitor1.fetchFlags().invokeOnCompletion { 
    val displayVipFeatureFlag = visitor1.getFlag("displayVipFeature", false)
}

fun <T> getFlag(key: String, defaultValue: T?): Flag

Retrieve a Flag object by its key. If no flag match the given key an empty flag will be returned. Call exists() to check if the flag has been found.

ParameterTypeDescription
keyStringkey associated to the flag.
defaultValueTflag default value.

🚧

  • Default value must be one of the following type : String, Boolean, Number, JSONArray, 'JSONObject'.

Getting flags current values

To retrieve flag current value, simply call value() method of the Flag object.

val visitor1 = Flagship.newVisitor("visitor_1").build()
visitor1.updateContext("isVip", true)
visitor1.fetchFlags().invokeOnCompletion { 
    val displayVipFeatureFlag = visitor1.getFlag("displayVipFeature", false).value()
        // display or not the vip feature
}

fun value(userExposed: Boolean = true): T?

Returns the value from the assigned campaign variation or the Flag default value if the Flag does not exist, or if types are different.

Parameter

Type

Default Value

Description

userExposed

Boolean

true

Tells Flagship the user have been exposed and have seen this flag. This will increment the visits for the current variation on your campaign reporting.
If needed it is possible to set this param to false and call userExposed() afterward when the user sees it.

Getting flags campaigns metadata

You may need to send campaign IDs or variation IDs to a third party for reporting and/or analytics purposes. It is possible to retrieve campaigns metadata for a specific Flag.

val visitor1 = Flagship.newVisitor("visitor_1").build()
visitor1.updateContext("isVip", true)
visitor1.fetchFlags().invokeOnCompletion { 
  val campaignMetadata = visitor1.getFlag("displayVipFeature", false).metadata()
}

fun metadata() : FlagMetadata

Return the campaign information metadata or an empty object if the Flag doesn't exist or if the default value type does not correspond to the Flag type in Flagship.

FlagMetadata

Field

Type

Description

campaignId

String

Campaign identifier the flag belongs to.

variationGroupId

String

Variation group identifier the flag belongs to.

variationId

String

Variation identifier the flag belongs to.

isReference

Boolean

Is the flag from the original variation.

campaignType

String

Type of the flag campaign.

slug

String

Campaign custom id.

Report a Flag exposition

By default when the method value() is called, The SDK considers that the user have seen the effets of your Flag, unless you pass false to value(). In this case you will have to call userExposed().

There are two options for exposing a user to a flag:

  1. Pass an userExposed=true parameter to the value() method.
  2. Use the following userExposed() method from the Flag instance.

val visitor1 = Flagship.newVisitor("visitor_1").build()
visitor1.updateContext("isVip", true)
visitor1.fetchFlags().invokeOnCompletion { 
    val displayVipFeature = visitor1.getFlag("displayVipFeature", true).value() // userExposed true by default
  
    // or
 
    val displayVipFeature = visitor1.getFlag("displayVipFeature", false).value(false)
  visitor1.userExposed();
    
}

fun userExposed()

Tells Flagship the user have been exposed and have seen this flag. This will increment the visits for the current variation on your campaign reporting. No user exposition will be sent if the Flag doesn't exist or if the default value type do not correspond to the Flag type in Flagship.


Check if a Flag exists

fun exists()

This method will return true if a Flag exists in Flagship

val visitor1 = Flagship.newVisitor("visitor_1").build()
visitor1.updateContext("isVip", true)
visitor1.fetchFlags().invokeOnCompletion { 
  val isDisplayVipFeatureExists = visitor1.getFlag("do_not_exists", false).exists()
}


Managing visitor consent

The Visitor class provides a method to let you manage visitor consent for data privacy usage. When False, campaign activation and hits will be disabled and cache cleared.

fun setConsent(hasConsented: Boolean)

Parameter

Type

Default Value

Description

hasConsented

Boolean

true

Set visitor consent for private data usage. When false some features will be deactivated, cache will be deactivated and cleared.

val visitor1 = Flagship.newVisitor("visitor_1").build()
  visitor1.setConsent(false);

🚧

When consent is not given: Hits, Activations will be deactivated and all the cached visitor data will be cleared until consent is given again.
Only consent tracking requests will enabled in order to clear server-side cached data.



Managing visitor cache

By default the Flagship Android SDK provide a default cache manager implementation. This helps to cache visitors data, to cache non sent hits due to internet failures or server errors, to cache campaign assignations for offline mode and to prevent reallocation in Bucketing mode. Indeed as the assignation is made on local device in bucketing mode, changing campaign allocation in the platform would make visitors to see different campaigns.

The default cache manager use a local database.

It is possible to provide a custom cache implementation using the following abstract class and the specific interfaces :

Flagship.start(getApplication(), "_ENV_ID_", "_API_KEY_", FlagshipConfig.DecisionApi()
            .withCacheManager(CacheManager.Builder()
                .withVisitorCacheLookupTimeout(200)
                .withHitCacheLookupTimeout(200)
                .withVisitorCacheImplementation(object : IVisitorCacheImplementation {
                    override fun cacheVisitor(visitorId: String, data: JSONObject) {
                        // Upsert in your database
                    }

                    override fun lookupVisitor(visitorId: String): JSONObject {
                        // Load & delete from your database
                        return JSONObject()
                    }

                    override fun flushVisitor(visitorId: String) {
                        // Clear from your database
                    }
                })
                .withHitCacheImplementation(object : IHitCacheImplementation {
                    override fun cacheHit(visitorId: String, data: JSONObject) {
                        // Insert in your database
                    }

                    override fun lookupHits(visitorId: String): JSONArray {
                        // Delete and load from your database
                        return JSONArray()
                    }

                    override fun flushHits(visitorId: String) {
                        // Clear from your database
                    }

                })
                .build())
        )


interface IVisitorCacheImplementation


This interface specifies the methods to implement in order to cache visitors information.


fun cacheVisitor(visitorId : String, data : JSONObject)

This method is called when the SDK needs to cache visitor information in your database.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which data need to be cached.
dataJSONObjectdata to cache

fun lookupVisitor(visitorId: String) : JSONObject

This method is called when the SDK needs to get visitor information from your database. This method will block the current thread so it will be called with a configurable timeout. See Cache format section.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which data need to be loaded.

Return : visitor information json respecting the expected format.


fun flushVisitor(visitorId: String)

This method is called when the SDK needs to flush visitor information in your database. For example when the user hasn't given his consent this method will be called.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which data need to be cleared.


interface IHitCacheImplementation


This interface specifies the methods to implement in order to cache visitors hits when they failed to be sent.


fun cacheHit(visitorId : String, data : JSONObject)

This method is called when the SDK needs to cache visitor hits in your database.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which hits need to be cached.
dataJSONObjectdata to cache

fun lookupHits(visitorId: String) : JSONObject

This method is called when the SDK needs to get visitor hits from your database in order to send them again. This method will block the current thread so it will be called with a configurable timeout. See Cache format section.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which hits need to be loaded.

Return : visitor hits json array respecting the expected format.

🚧

Hits must be deleted

Cached hits must be deleted before being returned from lookupHits so it prevents hits cache duplication if they failed to be sent again.


fun flushHits(visitorId: String)

This method is called when the SDK needs to flush visitor hits in your database. For example when the user hasn't given his consent this method will be called.

ParameterTypeDescription
visitorIdStringVisitor unique identifier from which hits need to be cleared.


Experience Continuity

In some situations, you may want experience consistency between an anonymous visitor and an authenticed visitor. Flagship provides the following two methods in order to help you to specify when a visitor is authenticated or not.

Authenticate

fun authenticate(visitorId: String)

ParameterTypeDescription
visitorIdStringid of the new authenticated visitor.

Unauthenticate

fun unauthenticate()

Code example

val visitor1 = Flagship.newVisitor("visitor_1").build() // anonymous visitor lands on your app.

// Once the visitor log in and is authenticated on your app.
visitor1.authenticate("visitor_id");


// Once the visitor log out and is unauthenticed on your app.
visitor1.unauthenticate();


Hit Tracking


This section helps you track your users in your application and learn how to build hits in order to feed campaign goals. For more information about our measurement protocol, read our Universal Collect documentation.

There are four different types of Hits available:

  • Page
  • Screen
  • Transaction
  • Item
  • Event

They must all be built and sent with the following function from the Visitor instance:


visitor1.sendHit(Page("https://www.my_domain_com/my_page"))

fun <T> sendHit(hit: Hit<T>)

Send hits as objectives in your campaign reporting.

ParameterTypeDescription
hitHitHit to send.

Hit common optional parameters


val screen = Screen("screen location")
                .withResolution(200, 100)
                .withLocale("fr_FR")
                .withIp("127.0.0.1")
                .withSessionNumber(2)
 visitor.sendHit(screen)

ParameterTypeDescription
withIpStringOptional. User IP
withResolutionint, intOptional. Screen resolution.
withLocaleStringOptional. User language
withSessionNumberintOptional. Session number

Page


This hit should be sent each time a visitor arrives on a new page on the server side.

val page = Page("https://www.my_domain_com/my_page")

visitor1.sendHit(page);

`class Page(location : String)

Builder ParameterTypeDescription
locationStringValid url.

Screen


This hit should be sent each time a visitor arrives on an interface on the client side.

val screen = Screen("your_screen_name")

visitor1.sendHit(screen)

class Screen(location : String)

Builder ParameterTypeDescription
locationStringInterface name.

Transaction


This hit should be sent when a user complete a Transaction.

val transaction = Transaction("#12345", "affiliation")
                .withCouponCode("code")
                .withCurrency("EUR")
                .withItemCount(1)
                .withPaymentMethod("creditcard")
                .withShippingCosts(9.99f)
                .withTaxes(19.99f)
                .withTotalRevenue(199.99f)
                .withShippingMethod("1day")
visitor1.sendHit(transaction)

class Transaction(transactionId : String, affiliation : String)

Builder ParameterTypeDescription
transactionIdStringUnique identifier for your transaction.
affiliationStringThe name of the KPI that you will have inside your reporting. Learn more
withTotalRevenuefloat(optional) Specifies the total revenue associated with the transaction. This value should include any shipping and/or tax amounts.
withShippingCostsfloat(optional) The total shipping cost of your transaction.
withShippingMethodString(optional) The shipping method for your transaction.
withTaxesfloat(optional) Specifies the total amount of taxes in your transaction.
withCurrencyString(optional) Specifies the currency of your transaction. NOTE: This value should be a valid ISO 4217 currency code.
withPaymentMethodString(optional) Specifies the payment method used for your transaction.
withItemCountint(optional) Specifies the number of items in your transaction.
withCouponCodeString(optional) Specifies the coupon code used by the customer in your transaction.

Item


This hit is used to link an item with a transaction. It must be sent after the corresponding transaction hit.

val item = Item("#12345", "product", "sku123")
                .withItemCategory("test")
                .withItemPrice(199.99f)
                .withItemQuantity(1)
visitor1.sendHit(item)

class Item(transactionId : String, productName : String, productSku : String)

Builder ParameterTypeDescription
transactionIdStringUnique identifier for your transaction.
productNameStringName of your item.
productSkuStringSpecifies the SKU or item code.
withItemCategoryString(optional) Specifies the category that the item belongs to.
withItemPricefloat(optional) Specifies the price for a single item/unit.
withItemQuantityint(optional) Specifies the number of items purchased.

📘

The Item hit isn't available yet in the Flagship reporting view.


Event

This hit can be used for any event (e.g. Add To Cart click, newsletter subscription).


val event = Event(Event.EventCategory.USER_ENGAGEMENT, "action")
                .withEventLabel("label")
                .withEventValue(100)
visitor1.sendHit(event)

class Event(val category: EventCategory, val action : String)

Builder ParameterTypeDescription
categoryEventCategorySpecifies the category of your event. NOTE: This value must be either 'ACTION_TRACKING' or 'USER_ENGAGEMENT'.
actionStringEvent name that will also serve as the KPI that you will have inside your reporting. Learn more
withEventLabelString(optional) Additional description of your event.
withEventValueNumber(optional) Specifies the monetary value associated with an event (e.g. you earn 10 to 100 euros depending on the quality of lead generated). NOTE: this value must be non-negative.

Appendix

Predefined user context keys

The Flagship SDK contains predefined user context keys.

The keys marked as Yes in the Auto-set by SDK column will be automatically set, while the ones marked as No need to be set by the client.

📘

Check the values sent by the SDK by enabling the logs.

You can overwrite these keys at any time. The key-value pairs will be sent to the server in the user context and can be edited in the Persona section of the Flagship platform.

SDK Variable NameDescriptionContext variable nameTypeAuto-set by SDKExample
FIRST_TIME_INITFirst init of the appsdk_firstTimeInitBooleanYesTRUE (FALSE if the init isn't the first one)
LOCALELanguage of the devicesdk_deviceLanguageStringYesfr_FR
DEVICE_TYPETablette / Mobilesdk_deviceTypeStringYesmobile
DEVICE_MODELModel of the devicesdk_deviceModelStringYessamsung E1200
LOCATION_CITYCity geolocationsdk_cityStringNotoulouse
LOCATION_REGIONRegion geolocationsdk_regionStringNooccitanie
LOCATION_COUNTRYCountry geolocationsdk_countryStringNoFrance
LOCATION_LATCurrent Latitudesdk_latDoubleNo43.623647
LOCATION_LONGCurrent Longitudesdk_longDoubleNo1.445397
IPIP of the devicesdk_ipStringNo127.0.0.1
OS_NAMEName of the OSsdk_osNameStringYesandroid / iOS
OS_VERSIONVersion of the OSsdk_osVersionStringYespie
API_LEVELVersion of the APIsdk_apiLevelIntegerYes24
ANDROID_VERSION / IOS VERSIONVersion of Androidsdk_androidVersion / sdk_iOSVersionStringYes9
MVNO / carrierNameName of the carrier or mobile virtual network operatorsdk_carrierNameStringYesorange
DEV_MODEIs the app in debug mode?sdk_devModeBooleanYesTRUE
VISITOR_IDVisitor_id of the usersdk_visitorIdStringYestoto2000
INTERNET_CONNECTIONWhat is the internet connectionsdk_internetConnectionStringNo3g
APP_VERSION_NAMEVersion name of the appsdk_versionNameStringNo1.1.2-beta
APP_VERSION_CODEVersion code of the appsdk_versionCodeIntegerNo40
FLAGSHIP_VERSIONVersion of the Flagship SDKsdk_fsVersionStringYes1.1.2
INTERFACE_NAMEName of the interfacesdk_interfaceNameStringNoProductPage

📘

To overwrite the keys, use the updateContext method


Cache data format

IVisitorCacheImplementation lookup format

{
  "version": 1,
  "data": {
    "visitorId": "visitor_1",
    "consent": true,
    "context": {
      "fs_users": "visitor_1",
      "sdk_osVersionCode": 31,
      "sdk_deviceModel": "Google Pixel 3",
      "fs_client": "android",
      "fs_version": "3.0.0",
      "sdk_carrierName": "Free",
      "sdk_osVersionName": "Android 12 S",
      "sdk_deviceType": "mobile",
      "plan": "enterprise",
      "sdk_deviceLanguage": "fra",
      "sdk_osName": "Android"
    },
    "assignmentsHistory": {
      "xxxxxxxxxxxxxxxxxxxx": "xxxxxxxxxxxxxxxxxxxx",
      "yyyyyyyyyyyyyyyyyyyy": "yyyyyyyyyyyyyyyyyyyy"
    },
    "campaigns": [
      {
        "campaignId": "xxxxxxxxxxxxxxxxxxxx",
        "variationGroupId": "xxxxxxxxxxxxxxxxxxxx",
        "variationId": "xxxxxxxxxxxxxxxxxxxx",
        "isReference": false,
        "type": "",
        "activated": false,
        "flags": {
          "key": "value"
        }
      },
      {
        "campaignId": "xxxxxxxxxxxxxxxxxxxx",
        "variationGroupId": "xxxxxxxxxxxxxxxxxxxx",
        "variationId": "xxxxxxxxxxxxxxxxxxxx",
        "isReference": false,
        "type": "",
        "activated": false,
        "flags": {
          "myAwesomeFeature": 20
        }
      }
    ]
  }
}

IHitCacheImplementation lookup format

{
  "version": 1,
  "data": {
    "time": 1637606817507,
    "visitorId": "visitor_1",
    "anonymousId": "e436e87f-cc61-44c6-ab40-fba15aec0af5",
    "type": "ACTIVATION",
    "content": {
      "cid": "xxxxxxxxxxxxxxxxxxxx",
      "caid": "xxxxxxxxxxxxxxxxxxxx",
      "vaid": "xxxxxxxxxxxxxxxxxxxx",
      "aid": "e436e87f-cc61-44c6-ab40-fba15aec0af5",
      "vid": "visitor_1"
    }
  }
}

Did this page help you?