統合の完了

これらの手順に従う前に、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 v 3.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 v 3.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 メソッドに関する追加のガイダンスを提供できます。