次の機能に対応しています。
- デバイス情報をNotiflyに登録し、プッシュ通知を受信したり、アプリ内ポップアップを表示したりできます。 (アプリ内ポップアップは、アプリがフォアグラウンドのときにのみ表示されます。)
- イベントとユーザー情報をNotiflyに送信し、キャンペーンのターゲティングと分析に使用できます。
- ユーザー行動をイベントとして記録し、キャンペーンの効果を測定できます。
事前準備
- Firebaseプロジェクトを連携します。
Notifly iOS SDKは、プッシュ通知の送信にFirebase Cloud Messagingを使用します。
Firebaseプロジェクトの連携ガイド
- iOSのAPNs認証情報を登録します。
APNs認証情報の登録
1. iOSの設定
1. Capabilityの設定
-
Xcodeでターゲットの最小デプロイバージョンをiOS 15.0以降に設定します。CocoaPodsを使う場合は、
Podfileにも同じバージョンを設定します。 -
Push NotificationsとBackground Modesを有効にします。Background Modesでは、Remote notificationsとBackground fetchを有効にしてください。


2. iOS SDKのインストール
Notifly iOS SDKは、CocoaPodsまたはSwift Package Managerでインストールできます。- CocoaPods
- Swift Package Manager
- XcodeプロジェクトにCocoaPodsが設定されていることを確認します。 未設定の場合は、CocoaPodsの導入ガイドを確認してください。
- Podfileの先頭に
platform :ios, '15.0'を追加します。15.0より新しいiOSバージョンも指定できます。 - Podfileに次のコードを追加します。
Podfile
3. AppDelegateの設定
Notifly SDKがiOSの通知システムと連携できるように、AppDelegateファイルを編集します。1. SwiftUIプロジェクトでのAppDelegateの作成
SwiftUIプロジェクトには、AppDelegateファイルがない場合があります。
その場合は、次のように作成します。
AppDelegate.swift
@UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegateを追加します。
<YOUR_PROJECT_NAME>App.swift
2. Notiflyの初期化とdelegateの設定
AppDelegate.swiftに次のインポートを追加します。
AppDelegate.swiftのUIApplicationDelegateメソッドにNotiflyの呼び出しを追加します。
projectIdとusernameは設定ページで確認できます。passwordは後方互換性のためのプレースホルダーです。usernameと同じ空でない値を渡してください。実際のパスワードやAPI Secret Keyは指定しないでください。 AppDelegate.swift
UNUserNotificationCenterDelegateメソッドを実装します。
UNUserNotificationCenterDelegate
4. ユーザー情報の登録
Notiflyは、ユーザー識別子(userId)とユーザー属性(params)を使って、マーケティングキャンペーンをパーソナライズします。登録したユーザー情報は、セグメントの分類や、プッシュ通知、メール、カカオアリムトークなどの配信対象の設定に使用されます。
1. ユーザーIDの登録(Notifly.setUserId())
userIdには、アプリ内でログインしているユーザーの識別子を設定します。Notiflyは、この値を使ってユーザーのイベントを追跡し、キャンペーンをパーソナライズします。
パラメーター
ユーザーIDの解除
ログアウト時には、Notifly.setUserId(userId: nil)を呼び出して、現在のデバイスとユーザーの関連付けを解除することを推奨します。
同じユーザーデータを保持する必要がある場合は、サーバーまたはアプリ内で別途管理してください。
- iOS
setUserId
2. ユーザー属性の登録
setUserPropertiesで、ユーザーの属性情報を登録します。登録した情報は、セグメントのターゲティング、メッセージのパーソナライズ、配信チャネルの選択などに使用されます。
機密性の高いユーザー属性を送信する前に氏名や住所など、保護が必要なカスタムユーザー属性を送信する前に、コンソールのユーザー管理 > ユーザー一覧の属性管理で、送信するキーと同じ名前の属性を登録し、暗号化を有効にしてください。設定方法と利用上の制約については、属性管理ガイドを確認してください。
パラメーター
$email: メールキャンペーンに使用するメールアドレスです。$phone_number: SMSやカカオのキャンペーンに使用する電話番号です。$line_user_id: LINEメッセージキャンペーンに使用するLINEユーザーIDです。- カスタムフィールド:
"plan"、"tier"、"country"など、任意のフィールドを設定できます。
- iOS
setUserProperties
5. イベントの記録
ユーザー行動を記録すると、キャンペーンのトリガー、セグメントの条件、効果分析などに使用できます。ボタンのクリック、ページへのアクセス、購入完了などのユーザー行動をイベントとして収集します。
パラメーター
segmentationEventParamKeysを指定すると、イベントパラメーター(eventParams)を配信対象の設定などに使用できます。指定できるキーは最大1つです。- Swift
trackEvent
6. 内部ユーザーIDの取得
getNotiflyUserId()は、Notiflyが内部で管理する一意のユーザーIDを返します。このIDは、
setUserId()で登録するユーザーIDとは別の識別子です。通常の連携では使用する必要はありません。外部CRMやサードパーティーサービスとの連携で、Notiflyの内部ユーザーIDが必要な場合に使用します。
7. iOS Notification Service Extensionの設定(推奨)
notifly-sdkバージョン1.3.0以降で利用できます。 主な機能
- プッシュ通知に画像や動画を添付できます。
- プッシュ通知の受信状況を追跡し、キャンペーンの効果を詳しく分析できます。
8. 連携テスト
SDKのインストール後、連携テストガイドに沿って、イベントの収集とプッシュ通知の受信を確認してください。連携をテストする
9. 高度な連携
プッシュ通知の許可をリクエストする
アプリ内ポップアップのイベントリスナー
リッチプッシュ通知
FAQ
すでにFirebase Cloud Messagingを使用している場合はどうすればよいですか?
すでにFirebase Cloud Messagingを使用している場合はどうすればよいですか?
Notifly iOS SDKは、アプリで使用中のFirebase Cloud Messagingと併用できます。
SwiftUIプロジェクトでプッシュ通知のトークンが転送されない、またはアプリ内ポップアップが動作しません。
SwiftUIプロジェクトでプッシュ通知のトークンが転送されない、またはアプリ内ポップアップが動作しません。
SwiftUI環境では、Firebase SDKのメソッドスウィズリングによって、delegateメソッドの呼び出しが正しく転送されない場合があります。
(関連するIssue: firebase-ios-sdk#7473)Info.plistでスウィズリングを無効にした後は、APNsトークンをFirebaseに手動で渡す必要があります。
FirebaseAppDelegateProxyEnabledをBoolean型のNOに設定し、スウィズリングを無効にしてください。Info.plist
AppDelegate.swift
