リッチプッシュ通知

前提条件

この機能を使う前に、Swift Braze SDKを統合する必要がある。 プッシュ通知の設定も必要です。

リッチプッシュ通知の設定

ステップ 1: サービス拡張機能を作成する

通知サービス拡張機能を作成するには、Xcode で File > New > Target に移動し、Notification Service Extension を選択します。

Embed In Application がアプリケーションに拡張機能を埋め込むように設定されていることを確認してください。

ステップ 2: 通知サービス拡張機能を設定する

通知サービス拡張機能は、アプリにバンドルされる独自のバイナリです。Apple Developer Portal で独自のアプリ ID とプロビジョニングプロファイルを使用して設定する必要があります。

通知サービス拡張機能のバンドル ID は、メインアプリターゲットのバンドル ID とは異なるものにする必要があります。例えば、アプリのバンドル ID が com.company.appname の場合、サービス拡張機能には com.company.appname.AppNameServiceExtension を使用できます。

ステップ 3: アプリグループを追加する

Xcode で、Signing & Capabilities ペインからメインアプリターゲットと Notification Service Extension ターゲットの両方に App Groups 機能を追加します。次に、+ ボタンをクリックします。アプリのバンドル ID を使用してアプリグループを作成します。例えば、アプリのバンドル ID が com.company.appname の場合、アプリグループに group.com.company.appname.xyz という名前を付けることができます。

重要

ここでの App Groups は、Apple の App Groups Entitlement を指しており、Braze のワークスペース（旧アプリグループ）ID ではありません。

メインアプリと Notification Service Extension が共有データにアクセスできるように、共有アプリグループが必要です。アプリをアプリグループに追加しない場合、アプリがプッシュペイロードの特定のフィールドを取得できず、期待通りに完全に動作しない可能性があります。

ステップ 4: リッチプッシュ通知を統合する

BrazeNotificationService を使用したリッチプッシュ通知の統合に関するステップバイステップガイドについては、チュートリアルを参照してください。

サンプルを確認するには、Examples アプリの NotificationService の使用方法を参照してください。

リッチプッシュフレームワークをアプリに追加する

• swift package マネージャー
• cocoapods
• 手動

Swift Package マネージャー 統合ガイドに従った後、以下の手順で BrazeNotificationService を Notification Service Extension に追加します。

1. Xcode で、フレームワークとライブラリの下にある 追加アイコンを選択してフレームワークを追加します。
   
   
   
   

2. 「BrazeNotificationService」フレームワークを選択します。
   
   

Podfile に以下を追加します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
target 'YourAppTarget' do
  pod 'BrazeKit'
  pod 'BrazeUI'
  pod 'BrazeLocation'
end

target 'YourNotificationServiceExtensionTarget' do
  pod 'BrazeNotificationService'
end

# Only include the below if you want to also integrate Push Stories
target 'YourNotificationContentExtensionTarget' do
  pod 'BrazePushStory'
end

注

Push Stories の実装手順については、ドキュメントを参照してください。

Podfile を更新した後、ターミナルで Xcode アプリプロジェクトのディレクトリに移動し、pod install を実行します。

BrazeNotificationService.xcframework を Notification Service Extension に追加するには、手動統合を参照してください。

独自の UNNotificationServiceExtension を使用する

独自の UNNotificationServiceExtension を使用する必要がある場合は、代わりに didReceive メソッドで brazeHandle を呼び出すことができます。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import BrazeNotificationService
import UserNotifications

class NotificationService: UNNotificationServiceExtension {

  override func didReceive(
    _ request: UNNotificationRequest,
    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
  ) {
    if brazeHandle(request: request, contentHandler: contentHandler) {
      return
    }

    // Custom handling here

    contentHandler(request.content)
  }
}

ステップ 5: Braze でアプリグループを設定する

Braze を初期化する前に、アプリグループの名前を Braze 設定の push.appGroup プロパティに割り当てます。

1
2
3
4
let configuration = Braze.Configuration(apiKey: "<YOUR-BRAZE-API-KEY>",
                                        endpoint: "<YOUR-BRAZE-ENDPOINT>")
configuration.push.appGroup = "REPLACE_WITH_APPGROUP"
let braze = Braze(configuration: configuration)

ステップ 6: ダッシュボードでリッチ通知を作成する

マーケティングチームはダッシュボードからリッチ通知を作成することもできます。プッシュコンポーザーを使用してプッシュ通知を作成し、画像や GIF を添付するか、画像、GIF、または動画をホストする URL を提供します。アセットはプッシュ通知の受信時にダウンロードされるため、コンテンツを自前でホストしている場合は、大規模な同期リクエストのスパイクに備えて計画する必要があります。