プッシュ通知ストーリー

前提条件

この機能を使用する前に、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にできます。

重要

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

アプリをアプリグループに追加しない場合、プッシュペイロードから特定のフィールドを取得できず、期待どおりに完全に動作しない可能性があります。

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

• swift package manager
• cocoapods
• manual

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

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で、以下の行を追加してヘッダーファイルをインポートします。

1

import BrazePushStory

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

1

class NotificationViewController: BrazePushStory.NotificationViewController {}

Push Storiesイベントのカスタムハンドリング

Push Stories通知イベントを処理する独自のカスタムロジックを実装する場合は、前述の例のようにBrazePushStory.NotificationViewControllerを継承し、以下の例に示すようにdidReceiveメソッドをオーバーライドします。

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

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プロパティに割り当てます。

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)