LEEEP iOS SDKは、LEEEPがwebプラットフォーム向けに提供している「コンテンツの表示」と「成果の計測」を、iOS向けアプリ上で実現するためのライブラリです。
※ Xcode 16.0における手順です
Xcodeでインストールしたいプロジェクトを開き、メニューから
File > Add Package Dependencies...右上の
Search or Enter Package URLにhttps://github.com/REGALITECH/leeep-ios-sdkと入力leeep-ios-sdkを選択し、Add Package
ブログ一覧・詳細タグを利用する場合は、LEEEP iOS SDK 0.11.0以上を指定してください。すでに導入済みの場合は、Xcodeでパッケージのバージョンを更新します。
未対応です。
未対応です。
アプリの起動時に Leeep.setup(websiteId: String) による初期化を行ってください。
websiteIdはLEEEP管理画面にてご確認ください。
実装例（ application(:didFinishLaunchingWithOptions:) 内で Leeep.setup(websiteId:) を実行）
「ソーシャル投稿」「投稿者」「レビュー」「UGC（リスト / UGC投稿詳細ページ）」に加え、SDK 0.11.0から「ブログ一覧」「ブログ詳細」タグを表示できます。
LeeepTagView(tagId: String) でタグのViewを生成します。
tagIdはLEEEP管理画面のタグ一覧にてご確認ください
onTapLinkで画面遷移のハンドリングを行えます。詳しくはリファレンスを参照してくださいonScrollRequestを設定すると、レビュー一覧のページ切替時に、外側のScrollViewを移動するための要求を受け取れます。LEEEPタグをアプリ側のスクロールコンテナ内へ配置する場合に使用してください。詳しくはリファレンスを参照してください。
実装例（ ScrollView 内に LeeepTagView を設置）
LeeepTagViewUIKit(tagId: String) でタグのViewを生成します。
tagIdはLEEEP管理画面のタグ一覧にてご確認ください
onTapLinkで画面遷移のハンドリングを行えます。詳しくはリファレンスを参照してくださいonScrollRequestを設定すると、レビュー一覧のページ切替時に、外側のScrollViewを移動するための要求を受け取れます。LEEEPタグをアプリ側のスクロールコンテナ内へ配置する場合に使用してください。詳しくはリファレンスを参照してください。
実装例（ ScrollView 内に LeeepTagView を設置）
LEEEP管理画面で、ブログ一覧用とブログ詳細用のタグをそれぞれ作成します。アプリ側にも一覧画面と詳細画面を用意し、各画面に対応するタグIDを指定してください。
一覧のブログリンクをタップすると、onTapLink に .blog(slug:url:) が通知されます。受け取った slug をアプリの詳細画面へ渡し、詳細タグの blogSlug に指定します。
次の例では、onOpenBlog をアプリのブログ詳細画面への遷移処理へ接続します。onOtherLink には、商品・投稿者などの既存のリンク処理を渡してください。
BLOG_LIST_TAG_ID と BLOG_DETAIL_TAG_ID を、発行した各タグIDへ置き換えます。詳細画面の onTapLink にも、ブログ・商品・投稿者などの遷移処理を設定してください。
blogSlug には記事のスラッグをそのまま渡します。URL全体や postId ではありません。アプリ側でURLエンコードする必要はありません。UIKitでも、LeeepTagViewUIKit の blogSlug に同じ値を指定します。
ブログリンクの判定には、LEEEP管理画面の「ブログ詳細ページパス」と、クエリ形式の場合は「スラッグクエリパラメータ名」の設定が必要です。詳しくはiOS SDKリファレンスのブログリンクの説明をご覧ください。
SDK 0.11.0で LeeepLinkHandlerParam に .blog が追加されました。すべてのケースを列挙した switch には .blog 分岐を追加してください。default がある場合も、アプリ内で記事詳細を開くには .blog の処理が必要です。
ブログ詳細の商品リンクは .product(id:url:) で受け取ります。id に入る商品IDの種類は、LEEEP側の「SDKに渡す商品ID」の設定に合わせてください。詳細はリファレンスをご覧ください。
レビュー一覧タグをアプリ側の ScrollView 内へ配置する場合、2ページ目以降へ切り替えたときに、外側のスクロール位置をレビュー一覧先頭へ戻す必要があります。
onScrollRequest を設定すると、ページ切替時に LeeepScrollRequest を受け取れます。外側のスクロールコンテナを、LeeepTagView の上端から request.hostOffsetTop ポイント下の位置へ移動してください。
onScrollRequest は任意です。設定していない既存実装はそのまま利用できます。座標変換を含むUIKitの実装例はLEEEP iOS SDK リファレンスを参照してください。
アプリ内で注文が完了した際に Leeep.Analytics.order() で注文イベントを計測します。
詳しくはリファレンスを参照してください。
webの購入完了ページで既に ParteTracking.order() を実装済みで、アプリからの注文でもwebの購入完了ページを表示する場合、アプリ側の実装は不要です。詳しくはお問い合わせください。
サンプルコード
ショッピング系のアプリの場合、商品詳細画面でその商品に紐付く投稿を表示することがコンバージョン率の向上に有効です。
特定の商品が紐付く投稿だけを表示したい場合、 LeeepTagView() に productId を与えてください。もし該当する投稿が0件の場合、 LeeepTagView の高さは0になります。
詳しくはリファレンスを参照してください。
アプリ上で会員ログイン時にユーザーIDをこの関数に与え、ログアウト時に nil をこの関数に与えてください。
詳しくはリファレンスを参照してください。