モバイル SDK - Android

リポジトリ: https://github.com/KlipFit/kleep-android

インストール

このプロセスは、プロジェクトに SDK を初めてインストールする際に一度だけ行う必要があります。その後のアップデート手順については、アップデートセクションを参照してください。 SDK はプライベートな Cloudsmith Maven リポジトリを通じて配布されています。

Cloudsmith の認証情報を追加

local.properties に、Kleep から提供された認証情報を追加してください:

local.properties

cloudsmithUser=token
cloudsmithApiKey=TOKEN_VALUE

TOKEN_VALUE を Kleep から提供されたトークンに置き換えてください。ユーザー名は文字列 token をそのまま使用します。

Cloudsmith Maven リポジトリを追加

settings.gradle または settings.gradle.kts に以下の行を追加してください:

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") ?: ""
            }
        }
    }
}

依存関係を追加

モジュールの build.gradle または build.gradle.kts ファイルに、依存関係を作成するための以下の行を追加してください:

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

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

従来のインストール方法（JitPack）

以下の手順は、JitPack を通じて配布されていた古いバージョンの SDK に適用されます。

gradle.properties に次のトークンを追加してください: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a

settings.gradle または settings.gradle.kts に以下の行を追加してください:

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

モジュールの build.gradle または build.gradle.kts ファイルに、依存関係を作成するための以下の行を追加してください:
dependencies { implementation 'com.github.KlipFit:kleep-android:version' }
dependencies { implementation("com.github.KlipFit:kleep-android:version") }

初期化

カスタム Application クラスを編集し、初期化のために applicationContext を渡してください。

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

class CustomApplication: Application() {

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

Manifest.xml に Application クラスを追加することを忘れないでください

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

インポート

MainActivity.kt の先頭でモジュールを手動でインポートできます

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

使用方法

SDK には 3 つのメソッドがあります:

メソッド	読み込み時間
`show`	初回起動: 250ms、次回以降: 50–250ms
`requestSize`	250ms
`track`	250ms

メソッド 1: `requestSize`

このメソッドは CTA のロジックを実装するために使用します。 ロジックスキーマ このスキーマは、Kleep を開く CTA の更新方法を説明しています。 https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 実装例

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

メソッド 2: `show`

このメソッドは CTA がクリックされたときに呼び出されます。各種画面をロードするために使用します。SDK を統合する開発者は、これらをボトムシートに埋め込む必要があります。

パラメータ	優先度	説明
productID	必須	商品 ID
retailer	必須	小売業者名
customerID	任意	分析に使用する CRM 識別子
trackingID	任意	外部トラッキングプロバイダーが使用する ID
stocks	任意	商品バリアント ID と在庫状況のマップ。`true` は在庫あり、`false`（デフォルト）は在庫なし、emptyMap または未指定でチェックをスキップ。

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

メソッド 3: `track`

このメソッドはカスタムイベントをトラッキングするために使用します。

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

トラッキングしたい 3 つのイベント:

eventName	トリガー
`product_viewed`	PDP 閲覧時
`product_added_to_cart`	商品がカートに追加されたとき
`checkout_completed`	支払い後の注文確認時

product_viewed パラメータ (CSV) 例

{
		productId: str
}

product_added_to_cart パラメータ (CSV) 例

{
    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 パラメータ (CSV) 例

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

ようこそ

CMS

モバイル

ダッシュボード

データ

プライバシー

モバイル SDK - Android

インストール

初期化

インポート

使用方法

メソッド 1: `requestSize`

メソッド 2: `show`

メソッド 3: `track`

​インストール

​初期化

​インポート

​使用方法

​メソッド 1: requestSize

​メソッド 2: show

​メソッド 3: track

インストール

初期化

インポート

使用方法

メソッド 1: `requestSize`

メソッド 2: `show`

メソッド 3: `track`