AppboyKit (also known as the Objective-C SDK) is no longer supported and has been replaced by the Swift SDK. It will no longer receive new features, bug fixes, security updates, or technical support—however, messaging and analytics will continue to function as normal. To learn more, see Introducing the New Braze Swift SDK.
手動統合
Swift パッケージマネージャー、CocoaPods、Carthage などのパッケージマネージャーを使用して SDK を実装することを強くお勧めします。これにより、時間を大幅に節約し、プロセスの多くを自動化できます。ただし、それができない場合は、手順に従って手動で統合を完了することができます。
ステップ1:Braze SDK のダウンロード
オプション1:ダイナミック XCFramework
- リリースページから
Appboy_iOS_SDK.xcframework.zip
をダウンロードし、ファイルを抽出します。 - Xcode では、この
.xcframework
をプロジェクトにドラッグアンドドロップします。 - プロジェクトの [一般] タブで、
Appboy_iOS_SDK.xcframework
の [埋め込みと署名] を選択します。
オプション2:静的統合用の静的 XCFramework
- リリースページから
Appboy_iOS_SDK.zip
をダウンロードしてください。 - Xcode のプロジェクトナビゲーターから、Braze の宛先プロジェクトまたはグループを選択します。
- [ファイル] > [ファイルの追加] > [プロジェクト名] に移動します。
AppboyKit
とAppboyUI
フォルダをグループとしてプロジェクトに追加します。- 初めて統合する場合は、[宛先グループのフォルダに項目をコピー] オプションが選択されていることを確認してください。ファイルピッカーの [オプション] を展開して、[必要に応じてアイテムをコピー] と [グループを作成] を選択します。
AppboyKit/include
とAppboyUI/include
のディレクトリを削除します。
- (オプション) 次のいずれかに該当する場合:
- SDK のコア分析機能のみが必要で、UI 機能 (アプリ内メッセージやコンテンツカードなど) は使用しないでください。
- Braze UI 機能のカスタム UI があり、画像のダウンロードは自分で処理できます。
SDK のコアバージョンは、ABKSDWebImageProxy.m
およびAppboy.bundle
のファイルを削除することで使用できます。これにより、SDWebImage
フレームワークの依存関係と UI 関連のすべてのリソース (Nib ファイル、画像、ローカリゼーションファイルなど) が SDK から削除されます。
Braze UI 機能なしでコアバージョンの SDK を使用しようとしても、アプリ内メッセージは表示されません。コアバージョンで Braze コンテンツカードの UI を表示しようとすると、予期しない動作が発生します。
ステップ2:必要な iOS ライブラリの追加
- プロジェクトのターゲットをクリックし (左側のナビゲーションを使用)、[ビルドフェーズ] タブを選択します。
- [バイナリをライブラリにリンク] の下のボタンをクリックします。
- メニューで、
SystemConfiguration.framework
を選択します。 SystemConfiguration.framework
の横にあるプルダウンメニューを使用して、このライブラリを必須としてマークします。- これを繰り返して、次の各必須フレームワークをプロジェクトに追加し、それぞれを「必須」としてマークします。
QuartzCore.framework
libz.tbd
CoreImage.framework
CoreText.framework
WebKit.framework
- 次のフレームワークを追加し、オプションとしてマークします。
CoreTelephony.framework
- [ビルド設定] タブを選択します。[リンク] セクションで、「その他のリンカーフラグ」設定を探し、
-ObjC
フラグを追加します。 - コンテンツカードとアプリ内メッセージングが正しく機能するには、
SDWebImage
フレームワークが必要です。SDWebImage
は GIF を含む画像のダウンロードと表示に使用されます。コンテンツカードまたはアプリ内メッセージを使用する場合は、SDWebImage の統合手順に従ってください。
SDWebImage 統合
SDWebImage
をインストールするには、手順に従い、出来上がった XCFramework
をプロジェクトにドラッグアンドドロップしてください。
オプションの位置情報の追跡
CoreLocation.framework
を追加して位置情報の追跡を有効にします。- アプリで
CLLocationManager
を使用するユーザーの位置情報を認証する必要があります。
ステップ3:Objective-C ブリッジヘッダー
プロジェクトで Objective-C のみを使用する場合は、このステップをスキップしてください。
プロジェクトで Swift を使用している場合は、ブリッジヘッダーファイルが必要になります。
ブリッジヘッダーファイルがない場合は、[ファイル] > [新規] > [ファイル] > (iOS または OS X) > [ソース] > [ヘッダーファイル] を選択して作成し、your-product-module-name-Bridging-Header.h
という名前を付けます。次に、ブリッジヘッダーファイルの先頭に次のコード行を追加します。
1
#import "AppboyKit.h"
プロジェクトのビルド設定で、ヘッダーファイルの相対パスを Swift Compiler - Code Generation
の下の Objective-C Bridging Header
ビルド設定に追加します。
次のステップ
手順に従って統合を完了してください。