> ## Documentation Index > Fetch the complete documentation index at: https://docs.kleep.ai/llms.txt > Use this file to discover all available pages before exploring further. # Mobile SDK - Android **Repository:** [https://github.com/KlipFit/kleep-android](https://github.com/KlipFit/kleep-android) ## Installation *** This process needs to be followed only once, the first time you need to install the SDK in your project. Please refer to the **Update** section to see the instructions for subsequent updates. 1. In your *gradle.properties,* add this token: `authToken=jp_9ibcequhrjtge3cmavt2k4sq6a` 2. In your *settings.gradle or settings.gradle.kts*, add the following lines: ```groovy theme={null} // for *settings.gradle* dependencyResolutionManagement { *// ...* repositories { *// ...* ~~~~ maven { url "https://jitpack.io" credentials { username authToken } } } } ``` ```kotlin theme={null} // for *settings.gradle.kts* *dependencyResolutionManagement { // ... repositories { // ... maven { url = uri("https://jitpack.io") credentials(PasswordCredentials::class) { val authToken: String by settings username = authToken* } *} } }* ``` 1. In your module’s *build.gradle* or *build.gradle.kts* file, add the following lines to create the dependency: ```groovy theme={null} // *build.gradle* dependencies { implementation 'com.github.KlipFit:kleep-android:version' } ``` ```kotlin theme={null} // *build.gradle.kts* dependencies { implementation("com.github.KlipFit:kleep-android:version") } ``` ## **Initialization** *** Edit your custom `Application` class and provide `applicationContext` for initialization. ```kotlin theme={null} import com.kleep.sdk.KleepResult import com.kleep.sdk.Kleep class CustomApplication: Application() { override fun onCreate() { super.onCreate() Kleep.init(applicationContext) } } ``` Don't forget to add your Application class to **`Manifest.xml`** ```kotlin theme={null} ... ``` ## Import *** You can manually import the module at the beginning of your **`MainActivity.kt`** ```kotlin theme={null} import com.kleep.sdk.KleepResult import com.kleep.sdk.Kleep ``` ## Usage *** The SDK comes with 3 methods: | method | loadtime | | ----------------------- | ------------------- | | `show` | First launch: 250ms | | Next launches: 50-250ms | | | `requestSize` | 250ms | | `track` | 250ms | ### Method 1: `requestSize` This method allows to implement the logic of the CTA. **Logic schema** This schema explains how to update the CTA opening Kleep. [https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1\&t=ccXWciNziIdfhgew-1](https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1\&t=ccXWciNziIdfhgew-1) **Implementation example** ```kotlin theme={null} Kleep.builder(this, onResult = { when (it) { is KleepResult.NotSupported -> { // Handle the NotSupported case } is KleepResult.NoRecommendationYet -> { // Handle the NoRecommendationYet case } is KleepResult.RecommendationFound -> { val resultText = it.size val variantId = it.variantId Toast.makeText(this, resultText, Toast.LENGTH_SHORT).show() } else -> { } } }) .setPackageName(packageName) // optional .setLang(DEFAULT_LANGUAGE) // required: "fr", "en", "es", "it", "pt", "nl" .setProductId("1234") // required .setRetailer("retailer_name") // required .setTrackingId("uuid") // empty if non-existent .setCustomerId("unique_customer_id") // optional .requestSize() ``` ```kotlin theme={null} package com.kleep.sdk /** * Interface with the Kleep SDK in order to compute the recommended size of a product given some user information */ interface KleepDialogBuilder { /** * Set the package name, not required * @return interface of the SDK builder */ fun setPackageName(packageName: String): KleepDialogBuilder /** * Set the language to use: required (default to FR) * Values supported: "fr", "en", "es", "it", "pt", "nl" * @return interface of the SDK builder */ fun setLang(lang: String): KleepDialogBuilder /** * Set product ID, required to compute the recommended size. * @return interface of the SDK builder */ fun setProductId(productId: String): KleepDialogBuilder /** * Set tracking id, required. Should represent unique tracking id. * Should be an empty string if the tracking id does not exist. * * @return interface of the SDK builder */ fun setTrackingId(tracking_id: String): KleepDialogBuilder /** * Set customer id, optonal. Should represent customer id linked to backend. * Should be an empty string if the tracking id does not exist. * * @return interface of the SDK builder */ fun setCustomerId(customer_id: String): KleepDialogBuilder /** * Set retail name (mandatory), required for stock/similar_products requests. * * @return interface of the SDK builder */ fun setRetailer(retailerName: String): KleepDialogBuilder /** * Sets the stock availability for items. * Providing an empty map or omitting this function disables stock checking. * * @return interface of the SDK builder */ fun setStocks(stocks: Map): KleepDialogBuilder /** * Display the Kleep UI inside a BottomSheet, so the user can fill a survey or take 2 pictures * in order to compute and display the recommended size to the user */ fun show() /** * Get the latest recommended size for the last viewed user. * As it's an async process and take several seconds, * the result will be give by the onResult listener , provided to the SDK builder */ fun requestSize() } ``` ### Method 2: `show` This method is called when the CTA is clicked. It allows to load the different screens. **The developper integrating the SDK should embed them into a bottom sheet.** | parameter | priority | description | | -------------------------------------------------------------------------------------------------------- | ---------- | ------------------------------------------------ | | **productID** | *required* | You product ID | | **retailer** | *required* | Name of the retailer | | **customerID** | *optional* | CRM identifier, used for analytics | | **trackingID** | *optional* | ID used by external tracking provider | | stocks | *optional* | A map of item variant IDs to their stock status. | | `true` for in stock, `false` (by default) for out of stock, emptyMap or not specified to skip the check. | | | ```kotlin theme={null} Kleep.builder(this, onResult = { when (it) { is KleepResult.NotSupported -> { // Handle the NotSupported case } is KleepResult.NoRecommendationYet -> { // Handle the NoRecommendationYet casem } is KleepResult.RecommendationFound -> { val resultText = it.size val variantId = it.variantId // addToCart(variantId) Toast.makeText(this, resultText, Toast.LENGTH_SHORT).show() } else -> { } } }) .setPackageName(packageName) // optional .setLang(DEFAULT_LANGUAGE) // required: "fr", "en", "es", "it", "pt", "nl" .setProductId("1234") // required .setRetailer("retailer_name") // required .setTrackingId("tracking_id") // optional .setCustomerId("unique_customer_id") // optional .setStocks(stocks: Map) // optional .show() ``` ### Method 3: `track` This method allows to track custom events. ```kotlin theme={null} Kleep.track(eventName: String, eventInfo: Map) ``` We want to track 3 events: | eventName | Trigger | | ----------------------- | ----------------------------------------- | | `product_viewed` | Upon PDP viewed | | `product_added_to_cart` | Upon product added to the cart | | `checkout_completed` | Upon order confirmation after the payment | **`product_viewed`** [Parameters (CSV)](/images/android/Untitled%202c68bfd3e84981db82a9f924cf43673d.csv) **Example** ```jsx theme={null} { productId: str } ``` **`product_added_to_cart`** [Parameters (CSV)](/images/android/Untitled%202c68bfd3e8498100baf9d17e8b7df5e0.csv) **Example** ```jsx theme={null} { productId: str, variantId: str, cart: [ { productId: "123ABC456", variantId: "123ABC456-00R", sku: "XYZ", size: "S", quantity: 2, price: { amount: "50", currencyCode: "EUR" } }, { productId: "123ABC456", variantId: "123ABC456-00R", sku: "XYZ", size: "S", quantity: 1, price: { amount: "40", currencyCode: "USD" } } ... ], } ``` **`checkout_completed`** [Parameters (CSV)](/images/android/Untitled%202c68bfd3e84981b0bdecd417ba621e4e.csv) **Example** ```jsx theme={null} { orderId: "000001", cart: [ { lineItemId: "000001#1", productId: "123ABC456", variantId: "123ABC456-00R", sku: "XYZ", size: "S", quantity: 2, price: { amount: "50", currencyCode: "EUR" } }, { lineItemId: "000000#2", productId: "123ABC456", variantId: "123ABC456-00R", sku: "XYZ", size: "S", quantity: 1, price: { amount: "40", currencyCode: "USD" } } ... ], } ```