このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。

警告

AppboyKit(Objective-C SDKとも呼ばれます)はもはやサポートされておらず、Swift SDK. 新しい機能、バグ修正、セキュリティー更新s、またはテクニカルサポートを受けません。ただし、メッセージングと分析は通常どおり機能し続けます。詳しくは、新しいBrazeの概要SDK]を参照してください。

統合を完了する

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

Braze SDKをCocoaPods、Carthage、またはダイナミックな手動統合で統合している場合は、次のコード行をAppDelegate.mファイルに追加します。

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

Swift Package Managerまたは静的な手動統合を使用して統合している場合は、代わりに次の行を使用します。

#import "AppboyKit.h"

次に、AppDelegate.mファイル内のapplication:didFinishLaunchingWithOptions:メソッド内に以下のスニペットを追加します。

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

設定の管理ページの正しい値でYOUR-APP-IDENTIFIER-API-KEYを更新してください。アプリ識別子APIキーの場所について詳しくは、APIドキュメントをご覧ください。

Braze SDKをCocoaPods、Carthage、またはダイナミックな手動統合で統合している場合は、次のコード行をAppDelegate.swiftファイルに追加します。

import Appboy_iOS_SDK

Swift Package Managerまたは静的な手動統合を使用して統合している場合は、代わりに次の行を使用します。

import AppboyKit

SwiftプロジェクトでのObjective-Cコードの使用の詳細については、Apple開発者ドキュメントを参照してください。

次に、AppDelegate.swiftで、次のスニペットをapplication(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Boolに追加します。

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

注

sharedInstanceシングルトンは、startWithApiKey:が呼び出される前はnilになります。これはBraze機能を使用するための前提条件です。

警告

必ずアプリケーションのメインスレッドでBrazeを初期化してください。非同期で初期化すると、機能が破損する可能性があります。

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

注

2019年12月の時点で、カスタムエンドポイントは提供されなくなっていることに注意してください。既存のカスタムエンドポイントがある場合は、それを引き続き使用できます。詳細については、利用可能なエンドポイントのリストを参照してください。

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

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

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

AppDelegate.mファイルのapplication:didFinishLaunchingWithOptions:メソッド内に、次のBrazeメソッドを追加します。

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

このメソッドはstartWithApiKey:inApplication:withLaunchOptions:初期化メソッドを置き換えることに注意してください。

AppDelegate.swiftのapplication(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Boolメソッド内に、次のBrazeメソッドを追加します。appboyOptionsはスタートアップ設定値のDictionaryです。

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

このメソッドはstartWithApiKey:inApplication:withLaunchOptions:初期化メソッドを置き換えることに注意してください。

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

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メソッドに関する追加のガイダンスを得ることができます。

New Stuff!