Mobile SDK - Android

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

Installation

Dieser Prozess muss nur einmal durchgeführt werden, wenn Sie das SDK zum ersten Mal in Ihrem Projekt installieren müssen. Weitere Informationen zu nachfolgenden Updates finden Sie im Abschnitt Update.

Fügen Sie in Ihrer gradle.properties dieses Token hinzu: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a
Fügen Sie in Ihrer settings.gradle oder settings.gradle.kts folgende Zeilen hinzu:

// 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*
            }
        *}
    }
}*

Fügen Sie in der Datei build.gradle oder build.gradle.kts Ihres Moduls folgende Zeilen hinzu, um die Abhängigkeit zu erstellen:

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

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

Initialisierung

Bearbeiten Sie Ihre benutzerdefinierte Application-Klasse und stellen Sie den applicationContext für die Initialisierung bereit.

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

class CustomApplication: Application() {

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

Vergessen Sie nicht, Ihre Application-Klasse zu Manifest.xml hinzuzufügen.

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

Import

Sie können das Modul manuell am Anfang Ihrer MainActivity.kt importieren.

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

Verwendung

Das SDK enthält 3 Methoden:

Methode	Ladezeit
`show`	Erster Start: 250 ms
Folgende Starts: 50–250 ms
`requestSize`	250 ms
`track`	250 ms

Methode 1: `requestSize`

Diese Methode ermöglicht die Implementierung der CTA-Logik. Logik-Schema Dieses Schema erklärt, wie der CTA zum Öffnen von Kleep aktualisiert wird. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Implementierungsbeispiel

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

Methode 2: `show`

Diese Methode wird aufgerufen, wenn der CTA angeklickt wird. Sie ermöglicht das Laden der verschiedenen Bildschirme. Der Entwickler, der das SDK integriert, sollte sie in ein Bottom Sheet einbetten.

Parameter	Priorität	Beschreibung
productID	erforderlich	Ihre Produkt-ID
retailer	erforderlich	Name des Händlers
customerID	optional	CRM-Identifikator, für Analytics verwendet
trackingID	optional	ID, die von einem externen Tracking-Anbieter verwendet wird
stocks	optional	Eine Map von Artikel-Varianten-IDs zu ihrem Lagerstatus.
`true` für vorrätig, `false` (standardmäßig) für nicht vorrätig, emptyMap oder nicht angegeben, um die Prüfung zu überspringen.

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

Methode 3: `track`

Diese Methode ermöglicht das Tracking benutzerdefinierter Ereignisse.

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

Wir möchten 3 Ereignisse tracken:

eventName	Auslöser
`product_viewed`	Beim Aufrufen des PDP
`product_added_to_cart`	Beim Hinzufügen eines Produkts zum Warenkorb
`checkout_completed`	Bei der Bestellbestätigung nach der Zahlung

product_viewed Parameter (CSV) Beispiel

{
		productId: str
}

product_added_to_cart Parameter (CSV) Beispiel

{
    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 Parameter (CSV) Beispiel

{
    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

​Initialisierung

​Import

​Verwendung

​Methode 1: requestSize

​Methode 2: show

​Methode 3: track