セルフハンドルカードを使用すると、MoEngage プラットフォームで Card キャンペーンを作成し、アプリケーション内の任意の場所にカードを表示できる柔軟性が得られます。SDK はキャンペーンのデータを取得する API を提供しており、そのデータを使用して独自のカードビューを作成できます。

SDK のインストール

BOM を使用したインストール

BOM を使用した統合が推奨される統合方法です。BOM を使用したインストールのドキュメントを参照してください。BOM を構成したら、以下のように app/build.gradle ファイルに依存関係を追加します。

dependencies {
    ...
    implementation("com.moengage:cards-core")
}

BOM を構成したら、アプリケーションに必要な特定の MoEngage モジュールを含めます。
注: これらの依存関係にはバージョン番号は不要です。BOM がバージョンを自動的に管理します。

セルフハンドルカードの実装

以下の API を使用してカードのデータを取得し、独自の UI を構築します。SDK はデータ取得のためにブロッキング API と非同期 API の両方を提供しています。このドキュメントではブロッキング API のみを記載しています。非同期 API については、MoECardHelper の API リファレンスを参照してください。

セクションの読み込み/アンロード時の通知

カードは、別の画面または画面の一部のセクションに表示できます。カードの画面/セクションが読み込まれたときに onCardSectionLoaded() を呼び出し、画面/セクションが表示されなくなったとき、またはバックグラウンドに移行するときに onCardSectionUnloaded() を呼び出します。

// call on section or screen load
MoECardHelper.onCardSectionLoaded(context,listener);
// call when the section is no longer visible or going to background.
MoECardHelper.onCardSectionUnloaded(context);

// call on section or screen load
MoECardHelper.INSTANCE.onCardSectionLoaded(context,listener);
// call when the section is no longer visible or going to background.
MoECardHelper.INSTANCE.onCardSectionUnloaded(context);

カテゴリの取得

カードが設定されているすべてのカテゴリを取得するには、getCardCategories() API を使用します。

MoECardHelper.getCardCategories(context)

MoECardHelper.INSTANCE.getCardCategories(context);

さらに、オプションで他のカテゴリのスーパーセットのような All カテゴリを使用することもできます。isAllCategoryEnabled() API を使用してください。

MoECardHelper.isAllCategoryEnabled(context)

MoECardHelper.INSTANCE.isAllCategoryEnabled(context);

カテゴリごとのカードの取得

特定のカテゴリで表示対象となるカードを取得するには、getCardsForCategory() API を使用します。

MoECardHelper.getCardsForCategory(context, "[YOUR_CATEGORY]")

MoECardHelper.INSTANCE.getCardsForCategory(context, "[YOUR_CATEGORY]");

カテゴリに関係なく表示対象となるすべてのカードを取得するには、以下のようにカテゴリ CARD_CATEGORY_ALL を渡します。

MoECardHelper.getCardsForCategory(context, CARDS_CATEGORY_ALL)

MoECardHelper.INSTANCE.getCardsForCategory(context, MoECardsCoreConstants.CARDS_CATEGORY_ALL);

含まれるフィールドとデータの詳細については、Card モデルのドキュメントを参照してください。カードとカテゴリを取得するために別々の API を使用する代わりに、getCardsInfo() API を使用してすべての情報を一度に取得できます。

MoECardHelper.getCardsInfo(context)

MoECardHelper.INSTANCE.getCardsInfo(context);

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

Basic Card/Illustration Card

ウィジェット ID	ウィジェットタイプ	ウィジェット情報
0	Image (WidgetType.IMAGE)	カード内の画像ウィジェット。
1	Text (WidgetType.TEXT)	カードのヘッダーテキスト。
2	Text (WidgetType.TEXT)	カードのメッセージテキスト。
3	Button (WidgetType.Button)	カードの Call to Action (CTA)。

カードの統計情報のトラッキング

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

配信

アプリケーションのカードセクションへの配信をトラッキングするには、アプリケーションのカードセクションが読み込まれたときに cardDelivered() API を呼び出します。

MoECardHelper.cardDelivered(context)

MoECardHelper.INSTANCE.cardDelivered(context);

インプレッション

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

MoECardHelper.cardShown(context, card)

MoECardHelper.INSTANCE.cardShown(context, card);

クリック

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

MoECardHelper.cardClicked(context, card, widgetId)

MoECardHelper.INSTANCE.cardClicked(context, card, widgetId);

カードの削除

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

MoECardHelper.deleteCard(context, card)

MoECardHelper.INSTANCE.deleteCard(context, card);

カードのリストを削除するには、deleteCards() API を使用します。

サーバーからのカードの更新

必要に応じて、fetchCards() API を使用して MoEngage サーバーからカードを更新します。

MoECardHelper.fetchCards(Context, CardAvailableListener)

MoECardHelper.INSTANCE.fetchCards(Context, CardAvailableListener);

SDK は、アプリケーションがフォアグラウンドに移行するたびに、MoEngage サーバーからカードを自動的に更新/取得します。
この API には FUP (公正利用ポリシー) があり、上限を超えた場合は既存のカード、つまりデバイスのローカルストレージにあるカードがコールバックで渡されます。
fetchCards() の同期タイミングとレート制限の詳細については、MoEngage SDK はいつカードデータを同期しますか? を参照してください。

利用可能なヘルパー API の完全なガイドについては、ドキュメントを参照してください。

​SDK のインストール

​BOM を使用したインストール

​セルフハンドルカードの実装

​セクションの読み込み/アンロード時の通知

​カテゴリの取得

​カテゴリごとのカードの取得

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

​Basic Card/Illustration Card

​カードの統計情報のトラッキング

​配信

​インプレッション

​クリック

​カードの削除

​サーバーからのカードの更新