プッシュ通知ストーリー

前提条件

この機能を使う前に、Swift Braze SDKを統合する必要がある。 プッシュ通知の設定も必要です。これにはUNNotificationフレームワークの実装が含まれます。

Push Storiesを受信するには、以下の最小SDKバージョンが必要です。

Push Storiesの設定

ステップ 1: 通知コンテンツ拡張ターゲットを追加する

アプリプロジェクトで、メニューFile > New > Targetに移動し、新しいNotification Content Extensionターゲットを追加してアクティブにします。

Xcodeによって新しいターゲットが生成され、以下のファイルが自動的に作成されます。

• NotificationViewController.swift
• MainInterface.storyboard

ステップ 2: 機能を有効にする

Xcodeで、メインアプリターゲットのSigning & Capabilitiesパネルを使用してBackground Modes機能を追加します。Background fetchとRemote notificationsの両方のチェックボックスを選択します。

アプリグループの追加

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

重要

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

アプリをアプリグループに追加しないと、アプリがプッシュペイロードからの特定のフィールドの入力に失敗し、期待どおりに完全に動作しない可能性があります。

ステップ 3: アプリにPush Storyフレームワークを追加する

• swift package manager
• cocoapods
• manual

Swift Package Managerの統合ガイドに従って、BrazePushStoryをNotification Content Extensionに追加します。

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 'YourNotificationContentExtensionTarget' do
pod 'BrazePushStory'
end

# Only include the below if you want to also integrate Rich Push
target 'YourNotificationServiceExtensionTarget' do
pod 'BrazeNotificationService'
end

注

リッチプッシュの実装方法については、リッチ通知を参照してください。

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

GitHubリリースページから最新のBrazePushStory.zipをダウンロードして展開し、BrazePushStory.xcframeworkをプロジェクトのNotification Content Extensionに追加します。

重要

Embed列の下で、BrazePushStory.xcframeworkに対してDo Not Embedが選択されていることを確認してください。

ステップ 4: 通知ビューコントローラーを更新する

NotificationViewController.swiftに以下の行を追加し、ヘッダーファイルをインポートします。

import BrazePushStory

次に、BrazePushStory.NotificationViewControllerを継承してデフォルトの実装を置き換えます。

class NotificationViewController: BrazePushStory.NotificationViewController {}

プッシュストーリーイベントのカスタム処理

独自のカスタムロジックを実装してプッシュストーリー通知イベントを処理する場合は、上記のようにBrazePushStory.NotificationViewControllerを継承し、以下のようにdidReceiveメソッドをオーバーライドします。

import BrazePushStory
import UserNotifications
import UserNotificationsUI

class NotificationViewController: BrazePushStory.NotificationViewController {
  override func didReceive(_ notification: UNNotification) {
    super.didReceive(notification)

    // Custom handling logic
  }

  override func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
    super.didReceive(response, completionHandler: completion)

    // Custom handling logic
  }
}

ステップ 5: 通知コンテンツ拡張plistを設定する

Notification Content ExtensionのInfo.plistファイルを開き、NSExtension \ NSExtensionAttributesの下に以下のキーを追加・変更します。

さらに、同じInfo.plistファイルに以下の最上位Brazeディクショナリを追加します。REPLACE_WITH_APPGROUPをステップ 2で作成したアプリグループに置き換えてください。

Info.plistファイルは以下の画像と一致するはずです。

ステップ 6: メインアプリでのBraze統合を更新する

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

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