Skip to main content
Self-handled cards を使用すると、MoEngage プラットフォームで Card キャンペーンを作成し、Web サイト内の任意の場所にカードを表示できます。SDK にはキャンペーンデータを取得するための API が用意されており、これを使用してカードのビューを作成できます。

SDK のインストール

以下に示すように、SDK の 初期化 スクリプトで Cards の設定を渡します。
Cards は独立したモジュールであり、コア SDK モジュールとは非同期に読み込まれます。そのため、ページの読み込み直後にはすぐに利用できない場合があります。 このイベントリスナーを使用し、初期化が完了してから Cards API を呼び出してください。
npm パッケージを使用している場合は、次のヘルパー関数を使用します。

Inbox オープン時に通知する

Inbox を開くたびに、以下に示すように MoEngage に通知することで、データを同期し、Inbox オープンイベントをトラッキングできます。

カテゴリを取得する

カードが設定されているすべてのカテゴリを取得するには、getCardCategories() API を使用します。
さらに、すべてのカテゴリを包含する All カテゴリを設けることもできます。isAllCategoryEnabled() API を使用します。

カテゴリのカードを取得する

特定のカテゴリで表示対象となるカードを取得するには、getCardsForCategory(categoryName) API を使用します。
カテゴリに関係なく表示対象となるすべてのカードを取得するには、以下に示すようにカテゴリ ‘All’ を渡します。

カード情報を取得する

カードとカテゴリを取得するために個別の API を使用する代わりに、*getCardsInfo(cardID)* API を使用してすべての情報を一度に取得できます。

サーバーからカードを更新する

必要に応じて、fetchCards() API を使用して MoEngage サーバーからカードを更新します。
fetchCards() の同期タイミングとレート制限の詳細については、MoEngage SDK はいつカードデータを同期しますか? を参照してください。

ウィジェットとウィジェット ID のマッピング

カード内の各 UI 要素は、クリックトラッキング API に渡す識別子を持つウィジェットです。次の表は、ウィジェット識別子とそれが表す要素の対応を示しています。

Basic Card/Illustration Card

カードの統計をトラッキングする

カードの UI/表示はアプリケーションによって制御されるため、表示とクリックの統計をトラッキングするには、アプリケーションから SDK に通知する必要があります。

インプレッション

特定のカードが画面に表示されたときに、*cardShown(cardID)* API を呼び出します。

クリック

ユーザーがカードをクリックするたびに、cardClicked(cardID, widgetID) API を呼び出し、クリックされた UI 要素のカードオブジェクトのウィジェット識別子を渡します。

カードを削除する

カードを削除するには、deleteCard(cardID) API を呼び出します。