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

SDK のインストール

インストール

MoEngage Cards SDK をアプリケーションに追加するには、アプリケーションの pubspec.yaml ファイルを編集し、次の依存関係を追加します。
$latestVersion は、プラグインの最新バージョンを指します。 依存関係を追加したら、ターミナルで flutter pub get コマンドを実行して依存関係をインストールします。 プラグインをインストールした後、以下のプラットフォーム固有の設定を行います。
このプラグインは moengage_flutter プラグインに依存しています。moengage_flutter プラグインもインストールされていることを確認してください。詳細については、ドキュメントを参照してください。

Android のインストール

V(1) app/build.gradle ファイルに次の依存関係を追加します。
$sdkVersion を適切な SDK バージョンに置き換えてください。サポートされる最小バージョンは 1.5.0 です。

iOS のインストール

iOS の場合、ネイティブの依存関係は Cards Flutter SDK 自体に含まれているため、Cards をサポートするために追加の依存関係を含める必要はありません。

Cards の初期化

MoEngage Cards モジュールは、Cards モジュールを使用するウィジェット内で初期化できます。
例

カード情報の取得

特定のユーザーに表示可能なすべてのカードキャンペーンのデータを取得します。データは CardsInfo として返されます。データモデルの完全な一覧については、API ドキュメントを参照してください。

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

Basic Card/Illustration Card

カードの更新

refreshCards*()*** API を使用して、ユーザーの要求に応じてカードを更新します。この API は、プルして更新(Pull to refresh)の動作を再現するために使用できます。

カードの取得

fetchCards*()*** API を使用して、ユーザーのカードを取得します。この API は、最新のカードデータを同期するために使用できます。
fetchCards() の同期タイミングとレート制限の詳細については、MoEngage SDK はいつカードデータを同期しますか?を参照してください。

Inbox の読み込み

カードは、別の画面または画面の一部のセクションに表示できます。カードの画面またはセクションが読み込まれたら、onCardsSectionLoaded() を呼び出します。

Inbox のアンロード

画面またはセクションが表示されなくなったとき、またはバックグラウンドに移行するときに、onCardSectionUnloaded() を呼び出します。

カテゴリーの取得

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

All カテゴリーが有効かどうか

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

カテゴリー別のカードの取得

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

新しいカード数の取得

新しいカードの数を取得するには、次のように getNewCardsCount() メソッドを使用します。

カードの表示

カードがユーザーに表示されたことを通知するには、cardShown() API を呼び出します。

カードのクリック

カードがユーザーに表示されたことを通知するには、cardClicked() API を呼び出します。

カードの削除

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

カードを配信済みとしてマーク

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

複数のカードの削除

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

未クリックのカード数の取得

未クリックのカードの数を取得するには、次のように getUnClickedCardsCount() メソッドを使用します。

アプリ起動時のカード同期リスナー

このリスナーを設定すると、アプリ起動時のカード同期についてコールバックを受け取れます。このリスナーは initialize() API を呼び出す前に設定する必要があります。ほとんどの場合、この API は必要ありません。
ハイブリッドフレームワークは、MoEngage のデフォルトの Card をサポートしていません。Self-handled Card のみがサポートされています。