次の機能に対応しています。
- デバイス情報をNotiflyに登録し、プッシュ通知を受信したり、アプリ内ポップアップを表示したりできます。 (アプリ内ポップアップは、アプリがフォアグラウンドのときにのみ表示されます。)
- イベントとユーザー情報をNotiflyに送信し、キャンペーンのターゲティングと分析に使用できます。
- ユーザー行動をイベントとして記録し、キャンペーンの効果を測定できます。
事前準備
- Firebaseプロジェクトを連携します。
Notifly Android SDKは、プッシュ通知の送信にFirebase Cloud Messagingを使用します。
Firebaseプロジェクトの連携ガイド
- アプリ内ポップアップにはAndroid 11(APIレベル30)以降が必要です。
アプリ内ポップアップキャンペーンは、Android 11以降でのみ利用できます。
1. SDKのインストール
Notifly Android SDKは、JitPackで配布されています。Gradleの設定
- Gradle 7.0以降
- Gradle 7.0より前
settings.gradle
SDKの依存関係の追加
build.gradle (Module: app)
SDKの機能更新とセキュリティ更新は随時公開されます。JitPackの最新バージョンを使用してください。
SDKの初期化
SDKはApplicationクラスで初期化することを推奨します。特定のActivityで初期化すると、ほかのActivityでは初期化が適用されない場合があります。
Applicationクラスがない場合は、
クラスを作成し、
クラスを作成し、
AndroidManifest.xmlのandroid:name属性に登録してください。AndroidManifest.xml
- Kotlin
- Java
アプリのApplicationクラスの
onCreateに、次のコードを追加します。MainApplication.kt
NOTIFLY_PROJECT_IDとUSERNAMEは設定ページで確認できます。PASSWORDは後方互換性のためのプレースホルダーです。USERNAMEと同じ空でない値を渡してください。実際のパスワードやAPI Secret Keyは指定しないでください。 2. ユーザー情報の登録
Notiflyは、ユーザー識別子(userId)とユーザー属性(params)を使って、マーケティングキャンペーンをパーソナライズします。登録したユーザー情報は、セグメントの分類や、プッシュ通知、メール、カカオアリムトークなどの配信対象の設定に使用されます。
ユーザー情報の登録メソッドは、
Notifly.initialize()によるSDKの初期化が完了してから呼び出してください。 ユーザーIDの登録(Notifly.setUserId())
userIdには、アプリ内でログインしているユーザーの識別子を設定します。Notiflyは、この値を使ってユーザーのイベントを追跡し、キャンペーンをパーソナライズします。
ユーザーIDの解除
ログアウト時には、setUserId(null)を呼び出して、現在のデバイスとユーザーの関連付けを解除することを推奨します。
同じユーザーデータを保持する必要がある場合は、サーバーまたはアプリ内で別途管理してください。
- Kotlin
- Java
setUserId
ユーザー属性の登録(Notifly.setUserProperties())
setUserPropertiesで、ユーザーの属性情報を登録します。登録した情報は、セグメントのターゲティング、メッセージのパーソナライズ、配信チャネルの選択などに使用されます。
機密性の高いユーザー属性を送信する前に氏名や住所など、保護が必要なカスタムユーザー属性を送信する前に、コンソールのユーザー管理 > ユーザー一覧の属性管理で、送信するキーと同じ名前の属性を登録し、暗号化を有効にしてください。設定方法と利用上の制約については、属性管理ガイドを確認してください。
$email: メールキャンペーンに使用するメールアドレスです。$phone_number: SMSやカカオのキャンペーンに使用する電話番号です。$line_user_id: LINEメッセージキャンペーンに使用するLINEユーザーIDです。- カスタムフィールド:
"plan"、"tier"、"country"など、任意のフィールドを設定できます。
- Kotlin
- Java
setUserProperties
3. イベントの記録(Notifly.trackEvent())
ユーザー行動を記録すると、キャンペーンのトリガー、セグメントの条件、効果分析などに使用できます。ボタンのクリック、ページへのアクセス、購入完了などのユーザー行動をイベントとして収集します。
segmentationEventParamKeysに指定できるキーは、現在最大1つです。- 例として、
listOf("plan")を指定すると、"plan"イベントパラメーターをセグメントの分類に使用できます。
- Kotlin(Jetpack Compose)
- Kotlin(XMLレイアウト)
- Java
Notifly.trackEvent
4. 内部ユーザーIDの取得
getNotiflyUserId()は、Notiflyが内部で管理する一意のユーザーIDを返します。このIDは、
setUserId()で登録するユーザーIDとは別の識別子です。通常の連携では使用する必要はありません。外部CRMやサードパーティーサービスとの連携で、Notiflyの内部ユーザーIDが必要な場合に使用します。
5. 連携テスト
SDKのインストール後、連携テストガイドに沿って、イベントの収集とプッシュ通知の受信を確認してください。連携をテストする
6. 高度な連携
プッシュ通知アイコンの設定
プッシュ通知の許可をリクエストする
プッシュ通知のクリックイベント
プッシュ通知インターセプター
アプリ内ポップアップのイベントリスナー
WebView
FAQ
すでにFirebase Cloud Messagingを使用している場合はどうすればよいですか?
すでにFirebase Cloud Messagingを使用している場合はどうすればよいですか?
Notifly Android SDKは、アプリで使用中のFirebase Cloud Messagingと併用できます。
