統合を完了する

これらの手順に従う前に、Carthage、CocoaPods、Swift Package Manager、または手動統合のいずれかを使用してSDKを統合していることを確認してください。

ステップ1:アプリデリゲートを更新する

• objective-c
• swift

1
#import "Appboy-iOS-SDK/AppboyKit.h"

1
#import "AppboyKit.h"

1
2
3
[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions];

1
import Appboy_iOS_SDK

1
import AppboyKit

1
Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY", in:application, withLaunchOptions:launchOptions)

ステップ2:データクラスターを指定する

コンパイル時のエンドポイント設定（推奨）

既存のカスタムエンドポイントが指定されている場合:

• Braze iOS SDK v3.0.2以降では、Info.plist ファイルを使用してカスタムエンドポイントを設定できます。Braze ディクショナリを Info.plist ファイルに追加します。Braze ディクショナリ内で、Endpoint 文字列サブエントリを追加し、値をカスタムエンドポイントURLのオーソリティ（たとえば、https://sdk.iad-01.braze.com ではなく sdk.iad-01.braze.com）に設定します。Braze iOS SDK v4.0.2より前では、ディクショナリキー Appboy を Braze の代わりに使用する必要があります。

Braze担当者は、正しいエンドポイントについてすでに通知しているはずです。

ランタイムエンドポイント設定

既存のカスタムエンドポイントが指定されている場合:

• Braze iOS SDK v3.17.0以降では、startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: に渡される appboyOptions パラメーター内の ABKEndpointKey を使用してエンドポイントの設定をオーバーライドできます。値をカスタムエンドポイントURLのオーソリティ（たとえば、https://sdk.iad-01.braze.com ではなく sdk.iad-01.braze.com）に設定します。

SDKの統合が完了

これでBrazeはアプリケーションからデータを収集しており、基本的な統合は完了しているはずです。カスタムイベントトラッキング、プッシュメッセージング、およびBraze機能の完全なスイートを有効にするには、次の記事を参照してください。

起動時のBrazeのカスタマイズ

起動時にBrazeをカスタマイズする場合は、代わりにBraze初期化メソッド startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: を使用し、オプションのBraze起動キーの NSDictionary を渡すことができます。

• objective-c
• swift

1
2
3
4
[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

1
2
3
4
Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY",
                 in:application,
                 withLaunchOptions:launchOptions,
                 withAppboyOptions:appboyOptions)

このメソッドは、次のパラメーターを使用して呼び出されます。

• YOUR-APP-IDENTIFIER-API-KEY – Brazeダッシュボードのアプリ識別子APIキー。
• application – 現在のアプリ。
• launchOptions – application:didFinishLaunchingWithOptions: から取得するオプション NSDictionary。
• appboyOptions – Brazeのスタートアップ設定値を持つオプションの NSDictionary。

Brazeのスタートアップキーのリストについては、Appboy.h を参照してください。

Appboy.sharedInstance() およびSwiftのnullability

一般的な慣例とは多少異なりますが、Appboy.sharedInstance() シングルトンはオプショナルです。これは、startWithApiKey: が呼び出される前は sharedInstance が nil であり、遅延初期化を使用できる非標準だが無効ではない実装がいくつかあるためです。

Appboyの sharedInstance（標準実装）にアクセスする前に didFinishLaunchingWithOptions: デリゲートで startWithApiKey: を呼び出すと、Appboy.sharedInstance()?.changeUser("testUser") のようなオプショナルチェーンを使用して、煩雑なチェックを回避できます。これは、非nullの sharedInstance を想定したObjective-C実装と同等になります。

その他のリソース

iOSクラスの完全なドキュメントを参照して、SDKメソッドに関する追加のガイダンスを得ることができます。