LEEEP Android SDK クイックスタート

LEEEP Android SDKは、LEEEPがwebプラットフォーム向けに提供している「コンテンツの表示」と「成果の計測」を、Android向けアプリ上で実現するためのライブラリです。

※ Android Studio 2025.2.2における手順です

1. プロジェクトの settings.gradle(.kts) の dependencyResolutionManagement ブロックに追加

   Kotlin

2. アプリモジュールの build.gradle(.kts) の dependencies ブロックに implementation を追加

   ブログ一覧・詳細タグを利用する場合は、LEEEP Android SDK 0.7.0以上を指定してください。

   Kotlin

   最新のバージョンは leeep-android-sdkリポジトリのtag一覧 からご確認ください。

3. Android Studio上の Sync Now をクリック

アプリの起動時に Leeep.setup(websiteId: String) による初期化を行ってください。

• websiteIdはLEEEP管理画面にてご確認ください。

実装例（ onCreate(savedInstanceState: Bundle?) 内で Leeep.setup(websiteId:) を実行）

「ソーシャル投稿」「投稿者」「レビュー」「UGC」に加え、SDK 0.7.0から「ブログ一覧」「ブログ詳細」タグを表示できます。

LeeepTagView(tagId: String) でタグのViewを生成します。

• tagIdはLEEEP管理画面のタグ一覧にてご確認ください

• onTapLink で画面遷移のハンドリングを行えます。詳しくはリファレンスを参照してください

• onScrollRequest を設定すると、レビュー一覧のページ切替時に、外側のスクロールコンテナを移動するための要求を受け取れます。Column、LazyColumn、Viewシステムの ScrollView などへLEEEPタグを配置する場合に使用してください。詳しくはリファレンスを参照してください。

実装例

onScrollRequest は任意です。設定していない既存実装はそのまま利用できます。LazyColumn とViewシステムの例はリファレンスを参照してください。

LazyColumn 外にて makeLeeepTagView でviewを生成し、 LazyColumn 内で AndroidView に与えてください。

• tagIdはLEEEP管理画面のタグ一覧にてご確認ください

• onTapLink で画面遷移のハンドリングを行えます。詳しくはリファレンスを参照してください

• onScrollRequest を設定すると、レビュー一覧のページ切替時に、外側のスクロールコンテナを移動するための要求を受け取れます。Column、LazyColumn、Viewシステムの ScrollView などへLEEEPタグを配置する場合に使用してください。詳しくはリファレンスを参照してください。

Jetpack Composeを使わない従来のViewシステムでも、 makeLeeepTagView を使って WebView を生成し、XMLレイアウトに配置できます。

• tagIdはLEEEP管理画面のタグ一覧にてご確認ください

• onTapLink で画面遷移のハンドリングを行えます。詳しくはリファレンスを参照してください

• onScrollRequest を設定すると、レビュー一覧のページ切替時に、外側のスクロールコンテナを移動するための要求を受け取れます。Column、LazyColumn、Viewシステムの ScrollView などへLEEEPタグを配置する場合に使用してください。詳しくはリファレンスを参照してください。

LEEEP管理画面で、ブログ一覧用とブログ詳細用のタグをそれぞれ作成します。アプリ側にも一覧画面と詳細画面を用意し、各画面に対応するタグIDを指定してください。

一覧のブログリンクをタップすると、onTapLink に LeeepLinkHandlerParam.Blog が通知されます。受け取った slug をアプリの詳細画面へ渡し、詳細タグの blogSlug に指定します。

次の例では、onOpenBlog をアプリのブログ詳細画面への遷移処理へ接続します。onOtherLink には、商品・投稿者などの既存のリンク処理を渡してください。

BLOG_LIST_TAG_ID と BLOG_DETAIL_TAG_ID を、発行した各タグIDへ置き換えます。詳細画面の onTapLink にも、ブログ・商品・投稿者などの遷移処理を設定してください。

blogSlug は名前付き引数で指定します。値には記事のスラッグをそのまま渡してください。URL全体や postId ではありません。アプリ側でURLエンコードする必要はありません。Viewシステムでも、makeLeeepTagView の blogSlug に同じ値を指定します。

ブログリンクの判定には、LEEEP管理画面の「ブログ詳細ページパス」と、クエリ形式の場合は「スラッグクエリパラメータ名」の設定が必要です。詳しくはAndroid SDKリファレンスの「ブログリンク」の説明をご覧ください。

SDK 0.7.0で LeeepLinkHandlerParam に Blog が追加されました。すべてのケースを列挙した when には Blog 分岐を追加してください。else がある場合も、アプリ内で記事詳細を開くには Blog の処理が必要です。

ブログ詳細の商品リンクは LeeepLinkHandlerParam.Product で受け取ります。id に入る商品IDの種類は、LEEEP側の「SDKに渡す商品ID」の設定に合わせてください。詳細はAndroid SDKリファレンスの「商品リンクで受け取るID」をご覧ください。

アプリ内で注文が完了した際に Leeep.Analytics.order() で注文イベントを計測します。

詳しくはリファレンスを参照してください。

webの購入完了ページで既に ParteTracking.order() を実装済みで、アプリからの注文でもwebの購入完了ページを表示する場合、アプリ側の実装は不要です。詳しくはお問い合わせください。

サンプルコード

ショッピング系のアプリの場合、商品詳細画面でその商品に紐付く投稿を表示することがコンバージョン率の向上に有効です。

特定の商品が紐付く投稿だけを表示したい場合、 LeeepTagView() に productId を与えてください。もし該当する投稿が0件の場合、 LeeepTagView の高さは0になります。

詳しくはリファレンスを参照してください。

アプリ上で会員ログイン時にユーザーIDをこの関数に与え、ログアウト時に null をこの関数に与えてください。

詳しくはリファレンスを参照してください。