- デバイス情報をNotiflyに登録し、プッシュ通知の受信とアプリ内ポップアップの表示を行います。 アプリ内ポップアップは、アプリがフォアグラウンドにあるときにのみ表示されます。
- イベントとユーザー情報をNotiflyに連携し、キャンペーンのターゲティングや分析に利用します。
- ユーザーの行動をイベントとして記録し、効果を測定します。
始める前に
SDKをインストールする前に、次の手順を完了してください。- Firebaseプロジェクトを連携します。
Notifly iOS SDKは、プッシュ通知の送信にFirebase Cloud Messagingを使用します。
Firebaseプロジェクト連携ガイド
- iOSのAPNs認証情報を登録します。
APNs認証キーを登録する
- iOSで正常にビルドするには、必ず
.xcworkspaceファイルをXcodeで開いてください。
1. SDKをインストールする
パッケージをインストールする
npmのnotifly-sdkをインストールします。 最新バージョンは次のとおりです。- npm
- yarn
package.jsonにnotifly-sdkが追加されます。 iOSを設定する
1. Capabilityを設定する
-
Xcodeで
{Your_Project_Name}.xcworkspaceを開きます。.xcodeprojではNotifly SDKを使用できません。 -
Xcodeで、iOS Deployment TargetまたはMinimum Deploymentsを15.0以降に設定します。
Podfileにも同じバージョンを指定します。 -
Push NotificationsとBackground Modesを有効にし、Remote notificationsとBackground fetchを選択します。


2. AppDelegate.mmを設定する
- ファイルの場所を確認する
AppDelegate.mmは次のパスにあります。
notifly_sdkをインポートする
UNUserNotificationCenterDelegateプロトコルを追加する
AppDelegate.hで、AppDelegateクラスがUNUserNotificationCenterDelegateを実装するように変更します。
- AppDelegate.h
ヘッダー
AppDelegateのメソッドを変更する
AppDelegate.mmのメソッドに、Notifly連携用のコードを追加します。
- AppDelegate.mm
AppDelegate.mm
iOS Notification Service Extensionを設定する(推奨)
notifly-sdk 1.3.0以降で利用できます。 主な機能
- プッシュ通知に画像や動画を添付できます。
- ユーザーのプッシュ通知の受信状況を追跡し、キャンペーンの効果を詳しく分析できます。
初期化コードを追加する
アプリのエントリーポイント(index.jsまたはApp.js)に初期化コードを追加します。
index.js
projectIdとusernameは設定ページで確認できます。passwordは後方互換性のためのプレースホルダーです。実際のパスワードやAPI Secret Keyは入力せず、usernameと同じ空でない値を渡してください。 2. ユーザー情報を登録する
NotiflyはユーザーID(userId)とユーザー属性(params)に基づいて、マーケティングキャンペーンをパーソナライズします。登録されたユーザー情報は、セグメント分けや、プッシュ通知、メール、カカオアリムトークなどの配信対象の指定に使用されます。
1. ユーザーIDを設定する(Notifly.setUserId())
userIdは、アプリ内でログインしているユーザーの識別子に対応します。Notiflyはこの値に基づいてユーザーのイベントを追跡し、キャンペーンをパーソナライズします。
パラメーター
ユーザーIDを解除する
ログアウト時は、setUserId(null)を呼び出して現在のデバイスとユーザーの関連付けを解除することを推奨します。
同じユーザーデータを維持するには、サーバーまたはアプリ内で別途管理してください。
- JavaScript
setUserId
2. ユーザー属性を設定する
setUserPropertiesはユーザーの属性情報を登録します。この情報は、セグメントのターゲティング、メッセージのパーソナライズ、配信チャネルの選択などに使用されます。
機密性の高いユーザー属性を送信する前に氏名や住所など、保護が必要なカスタムユーザー属性は、データの送信前にコンソールのユーザー管理 > ユーザー一覧の属性管理で送信するキーと同じ名前で登録し、暗号化を有効にしてください。設定方法と利用時の制限は、属性管理ガイドを参照してください。
$emailはメールキャンペーン用のアドレスです。$phone_numberはSMSやカカオのキャンペーンに使用する電話番号です。$line_user_idはLINEメッセージキャンペーン用のLINEユーザーIDです。"plan"、"tier"、"country"などのカスタムフィールドも自由に設定できます。
- JavaScript
setUserProperties
3. イベントを記録する
ユーザーの行動を記録し、キャンペーンのトリガー、セグメント条件、効果分析などに利用できます。たとえば、ボタンのクリック、ページへのアクセス、購入完了などの行動をイベントとして収集します。
パラメーター
segmentationEventParamKeysを使うと、イベントパラメーター(eventParams)を配信対象の条件などに利用できます。指定できるキーは最大1つです。- JavaScript
trackEvent
4. 連携をテストする
SDKのインストール後、以下のページで実際のイベント収集とプッシュ通知の受信をテストしてください。連携をテストする
5. 高度な連携
プッシュ通知の許可をリクエストする
プッシュ通知のクリックイベントを購読する
アプリ内ポップアップのイベントリスナー
よくある質問
すでにFirebase Cloud Messagingを使用している場合も利用できますか?
すでにFirebase Cloud Messagingを使用している場合も利用できますか?
Notifly Android SDKは、既存のアプリで使用しているFirebase Cloud Messagingと併用できます。
ビルド時にAppDelegate.mmでNotiflyクラスに関するエラーが発生します。
ビルド時にAppDelegate.mmでNotiflyクラスに関するエラーが発生します。
Podfileに
use_frameworks! :linkage => :staticを追加して、静的リンクを試してください。すでにuse_frameworks!がある場合は、:linkage => :staticオプションのみを追加します。iOSでアプリがフォアグラウンドにあるときにプッシュ通知が表示されません。
iOSでアプリがフォアグラウンドにあるときにプッシュ通知が表示されません。
すでにFirebase Messagingを使用している場合は、以下の手順に従って
firebase.jsonを設定してください。React Native FirebaseのForeground Presentation Optionsガイドに従い、firebase.jsonに次のコードを追加します。notifly_sdk-Swift.hが見つからないというエラーが発生します。
notifly_sdk-Swift.hが見つからないというエラーが発生します。
- iOSの
notifly_sdkはSwiftで記述されています。Objective-Cから利用できるように、ビルド時にSwift互換ヘッダーnotifly_sdk-Swift.hが生成されます。ビルド対象のターゲットのビルド設定で、Header Search Pathsに"${PODS_CONFIGURATION_BUILD_DIR}"を追加してください。 - SwiftをObjective-Cから利用する
