Mobile SDK - Android

Repository: https://github.com/KlipFit/kleep-android

Installation

Denna process behöver bara följas en gång, första gången du behöver installera SDK:n i ditt projekt. Se avsnittet Uppdatering för instruktioner om efterföljande uppdateringar. SDK:n distribueras via ett privat Cloudsmith Maven-repository.

Lägg till dina Cloudsmith-uppgifter

I din local.properties, lägg till de inloggningsuppgifter som tillhandahålls av Kleep:

local.properties

cloudsmithUser=token
cloudsmithApiKey=TOKEN_VALUE

Ersätt TOKEN_VALUE med det token som tillhandahålls av Kleep. Användarnamnet är den bokstavliga strängen token.

Lägg till Cloudsmith Maven-repositoryt

I din settings.gradle eller settings.gradle.kts, lägg till följande rader:

val localProps = java.util.Properties().apply {
    val localFile = file("local.properties")
    if (localFile.exists()) load(localFile.inputStream())
}

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url = uri("https://dl.cloudsmith.io/basic/kleep/kleep-android/maven/")
            credentials {
                username = localProps.getProperty("cloudsmithUser") ?: ""
                password = localProps.getProperty("cloudsmithApiKey") ?: ""
            }
        }
    }
}

def localProps = new Properties()
def localFile = file("local.properties")
if (localFile.exists()) localProps.load(localFile.newDataInputStream())

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url "https://dl.cloudsmith.io/basic/kleep/kleep-android/maven/"
            credentials {
                username = localProps.getProperty("cloudsmithUser") ?: ""
                password = localProps.getProperty("cloudsmithApiKey") ?: ""
            }
        }
    }
}

Lägg till beroendet

I din moduls build.gradle eller build.gradle.kts-fil, lägg till följande rader för att skapa beroendet:

dependencies {
    implementation 'com.klipfit:kleep-android:version'
}

dependencies {
    implementation("com.klipfit:kleep-android:version")
}

Äldre installation (JitPack)

Dessa instruktioner gäller äldre SDK-versioner som distribuerades via JitPack.

I din gradle.properties, lägg till detta token: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a

I din settings.gradle eller settings.gradle.kts, lägg till följande rader:

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url "https://jitpack.io"
            credentials { username authToken }
        }
    }
}

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url = uri("https://jitpack.io")
            credentials(PasswordCredentials::class) {
                val authToken: String by settings
                username = authToken
            }
        }
    }
}

I din moduls build.gradle eller build.gradle.kts-fil, lägg till följande rader för att skapa beroendet:

dependencies {
    implementation 'com.github.KlipFit:kleep-android:version'
}

dependencies {
    implementation("com.github.KlipFit:kleep-android:version")
}

Initiering

Redigera din anpassade Application-klass och ange applicationContext för initiering.

import com.kleep.sdk.KleepResult
import com.kleep.sdk.Kleep

class CustomApplication: Application() {

    override fun onCreate() {
        super.onCreate()
        Kleep.init(applicationContext)
    }
}

Glöm inte att lägga till din Application-klass i Manifest.xml

<application
        android:name=".CustomApplication"
        ...
        >
...
</application>

Import

Du kan manuellt importera modulen i början av din MainActivity.kt

import com.kleep.sdk.KleepResult
import com.kleep.sdk.Kleep

Användning

SDK:n levereras med 3 metoder:

metod	laddningstid
`show`	Första start: 250ms
Nästa starter: 50-250ms
`requestSize`	250ms
`track`	250ms

Metod 1: `requestSize`

Denna metod gör det möjligt att implementera logiken för CTA. Logikschema Detta schema förklarar hur man uppdaterar CTA som öppnar Kleep. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Implementeringsexempel

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()

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<String, Boolean>): 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()
}

Metod 2: `show`

Denna metod anropas när CTA klickas. Den gör det möjligt att ladda de olika skärmarna. Utvecklaren som integrerar SDK:n bör bädda in dem i ett bottom sheet.

parameter	prioritet	beskrivning
productID	obligatorisk	Ditt produkt-ID
retailer	obligatorisk	Återförsäljarens namn
customerID	valfritt	CRM-identifierare, används för analys
trackingID	valfritt	ID som används av extern spårningsleverantör
stocks	valfritt	En avbildning av varianternas ID till deras lagerstatus. `true` för i lager, `false` (som standard) för slut i lager, emptyMap eller inte angiven för att hoppa över kontrollen.

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<String, Boolean>) // optional
	.show()

Metod 3: `track`

Denna metod gör det möjligt att spåra anpassade händelser.

Kleep.track(eventName: String, eventInfo: Map<String, String>)

Vi vill spåra 3 händelser:

eventName	Utlösare
`product_viewed`	När PDP visas
`product_added_to_cart`	När produkt läggs i varukorgen
`checkout_completed`	Vid orderbekräftelse efter betalning

product_viewed Parametrar (CSV) Exempel

{
		productId: str
}

product_added_to_cart Parametrar (CSV) Exempel

{
    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 Parametrar (CSV) Exempel

{
    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"
				}
	    }
	    ...
    ],
}

Välkommen

CMS

Mobil

Instrumentpanel

Data

Integritet

Mobile SDK - Android

Installation

Initiering

Import

Användning

Metod 1: `requestSize`

Metod 2: `show`

Metod 3: `track`

​Installation

​Initiering

​Import

​Användning

​Metod 1: requestSize

​Metod 2: show

​Metod 3: track

Installation

Initiering

Import

Användning

Metod 1: `requestSize`

Metod 2: `show`

Metod 3: `track`