リッチプッシュ通知

前提条件

この機能を使用する前に、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: App Groupを追加する

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

重要

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

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

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

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

サンプルについては、ExamplesアプリのNotificationServiceでの使用例を参照してください。

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

• swift package manager
• cocoapods
• manual

Swift Package Manager統合ガイドに従った後、以下の手順でNotification Service ExtensionにBrazeNotificationServiceを追加します：

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でApp Groupを設定する

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を提供します。アセットはプッシュ通知の受信時にダウンロードされるため、コンテンツをホストしている場合は、リクエストの大規模で同期的なスパイクに備えて計画してください。