リッチプッシュ通知

前提条件

この機能を使う前に、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 ペインからメインアプリターゲットと通知サービス拡張ターゲットの両方にアプリグループ機能を追加します。次に、+ ボタンをクリックします。アプリのバンドル ID を使用してアプリグループを作成します。たとえば、アプリのバンドル ID が com.company.appname の場合、アプリグループに group.com.company.appname.xyz という名前を付けることができます。

重要

ここでいうアプリグループとは、Apple の App Groups Entitlement のことであり、Brazeのワークスペース（旧アプリグループ）ID のことではありません。

メインアプリと通知サービス拡張が共有データにアクセスできるようにするには、共有アプリグループが必要です。アプリをアプリグループに追加しない場合、アプリはプッシュペイロードから特定のフィールドを読み込めず、期待通りに完全に動作しない可能性があります。

ステップ 4: リッチプッシュ通知の統合

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

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

アプリへのリッチプッシュフレームワークの追加

• swift package manager
• cocoapods
• manual

Swift Package Managerの統合ガイドに従って、以下を実行して 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を提供します。アセットはプッシュ通知の受信時にダウンロードされるため、コンテンツをホスティングしている場合は、リクエストが大規模に同期的に急増することを想定する必要があります。