LEEEP Android SDK リファレンス

※ 導入手順はLEEEP Android SDKクイックスタートをご覧ください。

LEEEP Android SDKのセットアップを行います。アプリの起動時にこの関数を実行してください。

パラメータ

• websiteId : LEEEP上で管理しているウェブサイトのID（LEEEP管理画面でご確認ください）

ユーザーIDをセットすることで、LEEEPのイベント計測時に同一のユーザーとして扱われます。

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

パラメータ

• userId : あなたのアプリ/サービス上で管理している、ユーザーを一意に識別する文字列

true にすると LeeepTagView の初期化時やイベント計測時に正常系のログを出力します（異常系のログは showLog = false の状態でも出力されます）。

デフォルトは false です。

LEEEPタグのviewを生成します。Column の中で呼び出してください。

内部的にはweb向けのLEEEPタグをWebViewで表示し、ページ遷移の処理を onTapLink に引き継いでいます。

パラメータ

• tagId : LEEEPタグのID（LEEEP管理画面でご確認ください）

• productId : あなたのアプリ/サービス上で管理している商品ID

  • 商品詳細ページなどで、その商品が紐づいたコンテンツのみを表示したい場合などに使います

  • Shopifyをお使いの場合、LeeepTagView の生成時のみ cartProductId として商品IDを与える必要があります。詳しくは担当者にお問い合わせください

• postId : LEEEP上で管理している投稿ID

  • ソーシャル投稿詳細ページタグを表示する際に与えてください

• staffId : LEEEP上で管理している投稿者ID

  • 投稿者詳細ページタグを表示する際に与えてください

• onTapLink : タグ内のリンクがクリックされたときのコールバック

  • 引数の LeeepHandlerParam により、以下のパターンで分岐させることができます

    • Post : 投稿がタップされた場合。 id を用いてソーシャル投稿詳細ページタグを表示することを想定しています

    • Staff : 投稿者がタップされた場合。 id を用いて投稿者詳細ページタグを表示することを想定しています

    • Product : 商品がタップされた場合。 id を用いて商品詳細画面に遷移することを想定しています

    • ReviewForm ：レビューリストタグにおいて「レビューを書く」のボタンがタップされた場合。 productId を用いてレビューフォーム画面に遷移することを想定しています

    • Other : その他のリンクがタップされた場合。 url を用いてブラウザを開くか、または何もしないことを想定しています

LEEEPタグのWebViewを生成します。 LazyColumn 内にLEEEPタグを表示するための関数で、 LazyColumn 外でインスタンス生成してください。詳しくはクイックスタートをご覧ください。

パラメータは上述の LeeepTagView() と同様です。

注文を計測します。

パラメータ

• orderId : あなたのアプリ/サービス上で管理している注文ID

• products : 注文した商品情報

  • productId : あなたのアプリ/サービス上で管理している商品ID

  • skuCode : あなたのアプリ/サービス上で管理しているSKUコード。SKUコードがない商品の場合 "-" を与えてください

  • salesPrice : 販売価格。定価ではなく割引等が適用された販売価格を与えてください

  • quantity : 販売個数

  • name : 商品名

• discountAmount : 注文全体に対する割引金額。個々の商品に対する割引は products[].salesPrice に与えてください

ページビューを計測します。

商品のビューを計測します。商品詳細画面に遷移したときにこの関数を実行してください。

パラメータ

• productId : あなたのアプリ/サービス上で管理している商品ID

LEEEPタグのビューを計測します。

LeeepTagView LeeepTagViewUIKit は自動で viewTag を発火するため実装不要です。

パラメータ

• tagId : LEEEPタグのID（LEEEP管理画面でご確認ください）

LEEEPの投稿のビューを計測します。

LeeepTagView LeeepTagViewUIKit は自動で viewPost を発火するため実装不要です。

パラメータ

• postId : LEEEP上で管理している投稿ID