Push Story のセットアップ

Push Story 機能を使用するには、UNNotification フレームワークと iOS 10が必要です。この機能は iOS SDK バージョン3.2.1以降でのみ利用可能です。

ステップ1: アプリでプッシュを有効にする

プッシュ通知統合に従って、アプリでプッシュを有効にします。

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

アプリプロジェクトで、メニュー [ファイル] > [新規] > [ターゲット…] を選択し、新しい Notification Content Extension ターゲットを追加してアクティブ化します。

Xcode によって新しいターゲットが生成され、次のようなファイルが自動的に作成されるはずです。

• objective-c
• swift

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

Push Story 機能では、メインアプリターゲットの ［機能］ セクションのバックグラウンドモードが必要です。バックグラウンドモードをオンにしたら、[バックグラウンドフェッチ] と [リモート通知] を選択します。

アプリグループの追加

Capability App Groups も追加する必要があります。アプリにアプリグループがない場合は、メインアプリターゲットの ［機能］ に移動し、App Groups をオンにして ［+］ ボタンをクリックします。アプリのバンドル ID を使用してアプリグループを作成します。たとえば、アプリのバンドル ID が com.company.appname の場合、アプリグループに group.com.company.appname.xyz という名前を付けることができます。メインアプリとコンテンツ拡張ターゲットの両方で App Groups をオンにする必要があります。

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

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

• swift package manager
• cocoapods
• manual

1
2
3
target 'YourContentExtensionTarget' do
  pod 'Appboy-Push-Story'
end

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

• objective-c
• swift

1
#import <AppboyPushStory/AppboyPushStory.h>

1
2
@property (nonatomic) IBOutlet ABKStoriesView *storiesView;
@property (nonatomic) ABKStoriesViewDataSource *dataSource;

1
import AppboyPushStory

ステップ 6: 通知コンテンツ拡張ストーリーボードを設定する

Notification Content Extension ストーリーボードを開き、通知ビューコントローラーに新しい UIView を配置します。クラスの名前を ABKStoriesView に変更します。通知ビューコントローラのメインビューフレームに合わせて、ビューの幅と高さを自動サイズ変更可能にします。

次に、追加された ABKStoriesView に通知ビューコントローラーの storiesView IBOutlet をリンクします。

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

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

UNNotificationExtensionCategory = ab_cat_push_story_v2 (String タイプ) UNNotificationExtensionDefaultContentHidden = YES (Boolean タイプ) UNNotificationExtensionInitialContentSizeRatio = 0.65 (Number タイプ)

ステップ 8メインアプリでの　Braze 統合のアップデート

オプション 1: ランタイム

Braze インスタンスの設定に使用する appboyOptions 辞書で、ABKPushStoryAppGroupKey エントリを追加し、値をワークスペース API 識別子に設定します。

• objective-c
• swift

1
2
3
4
5
6
NSMutableDictionary *appboyOptions = [NSMutableDictionary dictionary];
appboyOptions[ABKPushStoryAppGroupKey] = @"YOUR-APP-GROUP-IDENTIFIER";
[Appboy startWithApiKey:@"YOUR-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

1
2
3
4
let appboyOptions: [AnyHashable: Any] = [
  ABKPushStoryAppGroupKey : "YOUR-APP-GROUP-IDENTIFIER"
]
Appboy.start(withApiKey: "YOUR-API-KEY", in:application, withLaunchOptions:launchOptions, withAppboyOptions:appboyOptions)

オプション 2: Info.plist

または、Info.plist ファイルから Push Story ワークスペースを構成するには、Braze という名前の辞書を Info.plist ファイルに追加します。Braze辞書内で、文字列型の PushStoryAppGroup サブエントリを追加し、値をワークスペース識別子に設定します。なお、Braze iOS SDK v4.0.2より前のバージョンでは、Braze の代わりに辞書キー Appboy を使用する必要があります。

次のステップ:

次に、アクションボタンを統合する手順を参照してください。これはプッシュストーリーメッセージにボタンを表示するために必要です。