SDKの初期セットアップ

この参照記事では、tvOS 用 Braze SDKをインストールする方法について説明します。Braze SDKをインストールすると、基本的な分析機能が提供されます。

tvOS Braze SDKは、Objective-C および Swift プロジェクトの依存関係マネージャーである CocoaPods を使用してインストールまたは更新する必要があります。CocoaPods を使用すると、統合と更新がさらに簡単になります。

tvOS SDK CocoaPods の統合

ステップ1:CocoaPods をインストールする

tvOS CocoaPods を介して SDKをインストールすると、インストールプロセスの大部分が自動化されます。このプロセスを開始する前に、Ruby バージョン 2.0.0 以降を使用していることを確認してください。

開始するには、次のコマンドを実行します。

1
$ sudo gem install cocoapods

• rake 実行可能ファイルを上書きするプロンプトが表示された場合、詳細については CocoaPods.org の Getting started を参照してください。
• CocoaPods に関する問題がある場合は、CocoaPods トラブルシューティングガイドを参照してください。

ステップ2:Podfile の構築

CocoaPods Ruby Gem をインストールしたら、Xcode プロジェクトディレクトリに Podfile という名前のファイルを作成する必要があります。

次の行を Podfile に追加します。

1
2
3
target 'YourAppTarget' do
  pod 'Appboy-tvOS-SDK'
end

ポッドの更新がマイナーバージョンの更新よりも小さいものを自動的に取得するように、Braze をバージョン管理することをお勧めします。これは pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build のようになります。メジャーな変更があっても最新の Braze SDK バージョンを自動的に統合する場合は、Podfile で pod 'Appboy-tvOS-SDK' を使用できます。

ステップ3:Braze SDKのインストール

Braze SDK CocoaPods をインストールするには、ターミナル内で Xcode アプリプロジェクトのディレクトリに移動し、次のコマンドを実行します。

1
pod install

この時点で、CocoaPods によって作成された新しい Xcode プロジェクトワークスペースを開くことができるはずです。Xcode プロジェクトの代わりに、必ずこの Xcode ワークスペースを使用してください。

ステップ4:アプリデリゲートの更新

• objective-c
• swift

1
#import <AppboyTVOSKit/AppboyKit.h>

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

1
import AppboyTVOSKit

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

ステップ5:カスタムエンドポイントまたはデータクラスターを指定する

Braze 担当者から、正しいエンドポイントについてすでに案内があったはずです。

コンパイル時のエンドポイント構成（推奨）

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

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

ランタイムエンドポイント構成

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

• 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 はアプリケーションからデータを収集しており、基本的な統合は完了しているはずです。tvOS アプリおよびその他のサードパーティライブラリをコンパイルするときは、Bitcode を有効にする必要があることに注意してください。

CocoaPods 経由で Braze SDKを更新する

CocoaPod を更新するには、プロジェクトディレクトリ内で次のコマンドを実行するだけです。

1
pod update

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

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

• objective-c
• swift

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

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

このメソッドは startWithApiKey:inApplication:withLaunchOptions: 初期化メソッドを置き換え、次のパラメーターで呼び出されます。

• YOUR-API-KEY: アプリケーションの API キーは、Braze ダッシュボードの設定の管理にあります。
• 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 実装と同等になります。

手動統合オプション

tvOS SDKを手動で統合することもできます。パブリックリポジトリからフレームワークを取得し、前のセクションで説明したように Braze を初期化するだけです。

ユーザーの特定と分析レポート

ユーザー ID の設定、カスタムイベントのログ記録、ユーザー属性の設定については、iOS ドキュメントを参照してください。また、イベントの命名規則についてもよく理解しておくことをお勧めします。