Mobil SDK - Android - Kleep Docs

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

Installation

Denne proces skal kun følges én gang, første gang du skal installere SDK’et i dit projekt. Se afsnittet Opdatering for instruktioner til efterfølgende opdateringer.

I din gradle.properties skal du tilføje dette token: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a
I din settings.gradle eller settings.gradle.kts skal du tilføje følgende linjer:

// for *settings.gradle*

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

// for *settings.gradle.kts*

*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 skal du tilføje følgende linjer for at oprette afhængigheden:

// *build.gradle*
dependencies {
	implementation 'com.github.KlipFit:kleep-android:version'
}

// *build.gradle.kts*
dependencies {
	implementation("com.github.KlipFit:kleep-android:version")
}

Initialisering

Rediger din brugerdefinerede Application-klasse og angiv applicationContext til initialisering.

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

class CustomApplication: Application() {

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

Glem ikke at tilføje din Application-klasse til Manifest.xml

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

Import

Du kan manuelt importere modulet i begyndelsen af din MainActivity.kt

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

Brug

SDK’et leveres med 3 metoder:

metode	indlæsningstid
`show`	Første start: 250ms
Næste starter: 50-250ms
`requestSize`	250ms
`track`	250ms

Metode 1: `requestSize`

Denne metode giver mulighed for at implementere logikken bag CTA’en. Logikskema Dette skema forklarer, hvordan du opdaterer CTA’en, der åbner Kleep. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Implementeringseksempel

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

Metode 2: `show`

Denne metode kaldes, når CTA’en klikkes. Den giver mulighed for at indlæse de forskellige skærme. Udvikleren, der integrerer SDK’et, bør indlejre dem i et bundark.

parameter	prioritet	beskrivelse
productID	påkrævet	Dit produkt-ID
retailer	påkrævet	Navn på forhandleren
customerID	valgfri	CRM-identifikator, brugt til analyse
trackingID	valgfri	ID brugt af ekstern sporingsudbyder
stocks	valgfri	Et map af varevariant-ID’er til deres lagerstatus.
`true` for på lager, `false` (som standard) for ikke på lager, emptyMap eller ikke angivet for at springe tjekket over.

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

Metode 3: `track`

Denne metode giver mulighed for at spore brugerdefinerede hændelser.

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

Vi ønsker at spore 3 hændelser:

eventName	Trigger
`product_viewed`	Når PDP vises
`product_added_to_cart`	Når produkt lægges i kurven
`checkout_completed`	Når ordre bekræftes efter betaling

product_viewed Parametre (CSV) Eksempel

{
		productId: str
}

product_added_to_cart Parametre (CSV) Eksempel

{
    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 Parametre (CSV) Eksempel

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

​Installation

​Initialisering

​Import

​Brug

​Metode 1: requestSize

​Metode 2: show

​Metode 3: track