すべての機能（プッシュ通知、アプリ内メッセージングなど）を有効にするには、Android アプリでいくつかの手順を実施する必要があります。

MoEngage 依存関係の追加

プロジェクトレベルの build.gradle ファイルに mavenCentral() リポジトリを追加します。

buildscript {
    repositories {
        mavenCentral()
    }
}
 
allprojects {
    repositories {
        mavenCentral()
    }
}

Segment に加えて、build.gradle ファイルに以下の依存関係を追加します。

     implementation("com.moengage:moengage-segment-integration:5.6.00") {
        transitive = true
    }

MoEngage SDK は、動作のために Google が提供する以下の Jetpack ライブラリに依存しています。アプリケーションにまだ含まれていない場合は、必ず追加してください。

implementation("androidx.core:core:1.3.1")
implementation("androidx.appcompat:appcompat:1.2.0") 
implementation("androidx.lifecycle:lifecycle-process:2.2.0")

ビルド設定および SDK が使用するその他のライブラリの詳細については、Android SDK Configuration ドキュメントを参照してください。

Segment SDK への MoEngage の登録:

依存関係を追加したら、Segment SDK に統合を登録する必要があります。そのためには、MoEngage 統合をインポートします。

import com.segment.analytics.android.integrations.moengage.MoEngageIntegration;

次の行を追加します。

Analytics analytics = new Analytics.Builder(this, "write_key")
                .use(MoEngageIntegration.FACTORY)
                .build();

MoEngage SDK の初期化方法:

設定ページ Dashboard --> Settings --> App --> General から Workspace ID を取得し、Application クラスの onCreate() で MoEngage SDK を初期化します。注: SDK は onCreate() 内のメインスレッドで初期化することを推奨します。ワーカースレッドを作成してそのスレッドで SDK を初期化しないでください。

// this is the instance of the application class and "XXXXXXXXXXX" is the Workspace ID from the dashboard.
MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXXX")
            .enablePartnerIntegration(IntegrationPartner.SEGMENT)
            .build();
MoEngage.initialise(moEngage);

インストール/アップデートの区別

これは MoEngage プラットフォームへの移行時にのみ必要です。ユーザーがアプリケーションの新規ユーザーなのか、最新バージョンにアップデートした既存ユーザーなのかを SDK に伝える必要があります。ユーザーがすでにアプリケーションを使用していて、MoEngage SDK を含む新しいバージョンにアップデートしたばかりの場合はアップデートとなるため、以下の API を呼び出します。

MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.UPDATE);

新規インストールの場合は、以下の API を呼び出します。

MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.INSTALL);

プッシュ通知の設定方法:

FCM コンソールから Server Key をコピーし、MoEngage ダッシュボードに追加します（Server Key の場所がわからない場合は、Getting FCM Server Key を参照してください）。アップロードするには、MoEngage Dashboard —> Settings —> Channel —> Push —> Mobile Push —> Android に移動し、Server Key とパッケージ名を追加します。

キーは Test 環境と Live 環境の両方に必ず追加してください。

プッシュ通知のメタ情報の追加

プッシュ通知を表示するには通知に関するメタデータが必要で、スモールアイコンとラージアイコンの drawable は必須です。設定を SDK に渡すには、configureNotificationMetaData() を使用します。

MoEngage moEngage =
        new MoEngage.Builder(this, "XXXXXXXXXX")
            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon))
            .enablePartnerIntegration(IntegrationPartner.SEGMENT)
            .build();
MoEngage.initialise(moEngage);

Firebase Cloud Messaging の設定

プッシュ通知を表示するには、次の 2 つが重要です。

プッシュの登録、つまりプッシュトークンの生成。
Firebase Cloud Messaging（FCM）サービスからプッシュペイロードを受信し、デバイスに通知を表示すること。

アプリによるプッシュ登録と受信の処理

デフォルトでは、MoEngage SDK はプッシュトークンの登録を試みます。アプリケーションでプッシュを処理する場合は、SDK のトークン登録をオプトアウトする必要があります。

MoEngage の登録をオプトアウトする方法

MoEngage のトークン登録メカニズムをオプトアウトするには、以下のように MoEngage.Builder で FCM を設定する際にトークン登録を無効にします。

MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXX")
            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true))
            .configureFcm(FcmConfig(false))
            .enablePartnerIntegration(IntegrationPartner.SEGMENT)
            .build();
MoEngage.initialise(moEngage);

プッシュトークンを MoEngage SDK に渡す

MoEngage プラットフォームがデバイスにプッシュ通知を送信できるように、アプリケーションは FCM から受け取ったプッシュトークンを MoEngage SDK に渡す必要があります。プッシュトークンを MoEngage SDK に渡すには、以下の API を使用します。

MoEFireBaseHelper.getInstance().passPushToken(getApplicationContext(), token);

注: プッシュトークンが更新されたときと、アプリケーションのアップデート時には、必ずトークンを MoEngage SDK に渡してください。アプリケーションのアップデート時にトークンを渡すことは、MoEngage プラットフォームへの移行において重要です。

プッシュペイロードを MoEngage SDK に渡す

プッシュペイロードを MoEngage SDK に渡すには、Firebase レシーバーの onMessageReceived() から MoEngage API を呼び出します。ペイロードを MoEngage SDK に渡す前に、SDK が提供するヘルパー API を使用して、ペイロードが MoEngage プラットフォームからのものかどうかを確認してください。

if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.getData())) {
  MoEFireBaseHelper.Companion.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData());
}else{
  // your app's business logic to show notification
}

SDK によるプッシュ登録と受信の処理

マニフェストファイルに以下のコードを追加します。

<service android:name="com.moengage.firebase.MoEFireBaseMessagingService">
 	<intent-filter>
		<action android:name="com.google.firebase.MESSAGING_EVENT" />
 	</intent-filter>
</service>

MoEngage SDK がプッシュ登録を処理する場合、新しいトークンが登録されたとき、またはトークンが更新されたときに、オプションでアプリケーションにコールバックを提供します。アプリケーションは FirebaseEventListener を実装し、Application クラスの onCreate() で MoEFireBaseHelper.getInstance().addEventListener() を使用してコールバックを登録することで、このコールバックを受け取ることができます。

Rich Landing Activity の宣言と設定:

次のスニペットを追加し、[PARENT_ACTIVITY_NAME] を親アクティビティの名前に、[ACTIVITY_NAME] を Rich Landing Page の親となるアクティビティ名に置き換えます。

<activity
    android:name="com.moe.pushlibrary.activities.MoEActivity"
    android:label="[ACTIVITY_NAME]"
    android:parentActivityName="[PARENT_ACTIVITY_NAME]" >
 </activity>

これで、MoEngage からプッシュ通知を受信する準備が整いました。MoEngage Android SDK が提供する機能の詳細については、以下のリンクを参照してください。

Identify

ユーザー固有の属性をトラッキングするには、Identify を使用します。これは MoEngage でのユーザー属性のトラッキングに相当します。MoEngage は、Segment がサポートする traits とカスタム traits の両方をサポートしています。traits.id を設定すると、その値がそのユーザーの Unique ID として設定されます。

Track

アプリ内のイベントとユーザー行動をトラッキングするには、track を使用します。これにより、関連するプロパティとともにイベントが MoEngage に送信されます。イベントのトラッキングは不可欠であり、ユーザーエンゲージメントのためのセグメントの作成に役立ちます。

Reset

アプリでユーザーがログアウトして新しい ID でログインできる場合は、Analytics クライアントの reset を呼び出す必要があります。

実装サンプル

実装サンプルについては、こちらの GitHub リポジトリを参照してください。

ガイド

Android デバイスモード 5.x.x

MoEngage 依存関係の追加

Segment SDK への MoEngage の登録:

MoEngage SDK の初期化方法:

インストール/アップデートの区別

プッシュ通知の設定方法:

プッシュ通知のメタ情報の追加

Firebase Cloud Messaging の設定

アプリによるプッシュ登録と受信の処理

MoEngage の登録をオプトアウトする方法

プッシュトークンを MoEngage SDK に渡す

プッシュペイロードを MoEngage SDK に渡す

SDK によるプッシュ登録と受信の処理

Rich Landing Activity の宣言と設定:

Identify

Track

Reset

実装サンプル

​MoEngage 依存関係の追加

​Segment SDK への MoEngage の登録:

​MoEngage SDK の初期化方法:

​インストール/アップデートの区別

​プッシュ通知の設定方法:

​プッシュ通知のメタ情報の追加

​Firebase Cloud Messaging の設定

​アプリによるプッシュ登録と受信の処理

​MoEngage の登録をオプトアウトする方法

​プッシュトークンを MoEngage SDK に渡す

​プッシュペイロードを MoEngage SDK に渡す

​SDK によるプッシュ登録と受信の処理

​Rich Landing Activity の宣言と設定:

​Identify

​Track

​Reset

​実装サンプル

MoEngage 依存関係の追加

Segment SDK への MoEngage の登録:

MoEngage SDK の初期化方法:

インストール/アップデートの区別

プッシュ通知の設定方法:

プッシュ通知のメタ情報の追加

Firebase Cloud Messaging の設定

アプリによるプッシュ登録と受信の処理

MoEngage の登録をオプトアウトする方法

プッシュトークンを MoEngage SDK に渡す

プッシュペイロードを MoEngage SDK に渡す

SDK によるプッシュ登録と受信の処理

Rich Landing Activity の宣言と設定:

Identify

Track

Reset

実装サンプル