リッチプッシュ通知

前提条件

この機能を使用する前に、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で、Signing & CapabilitiesペインからメインアプリのターゲットとNotification Service Extensionのターゲットの両方にApp Groups機能を追加します。次に、+ボタンをクリックします。アプリのバンドルIDを使用してApp Groupを作成します。たとえば、アプリのバンドルIDがcom.company.appnameの場合、App Groupの名前をgroup.com.company.appname.xyzにできます。

重要

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

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

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

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

サンプルを確認するには、Examplesアプリの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の実装の詳細については、Push Storiesを参照してください。

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

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

生成されたXcodeプロジェクトのトラブルシューティング

TuistなどのビルドツールでXcodeプロジェクトを生成する場合は、生成されたプロジェクトでBrazeNotificationServiceがNotification Service Extensionのターゲットにリンクされたままになっており、そのリソースが拡張機能のバンドル内に保持されていることを確認してください。生成されたプロジェクト構造によっては、リソースが想定外のバンドルに配置され、実行時にリッチプッシュのアセットを読み込めなくなる場合があります。

サポートについては、以下のリソースを参照してください。

• Braze Swift SDKリポジトリ
• Notification Service Extension向けBraze Swift SDKのサンプル
• Braze Swift SDKのイシュートラッカー

独自の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を初期化する前に、App Groupの名前を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を指定します。アセットはプッシュ通知の受信時にダウンロードされるため、コンテンツを自社でホストしている場合は、リクエストが大規模かつ同時に急増することを想定して計画してください。