Cordova Braze SDK の統合
Cordova Braze SDK を iOS または Android アプリに統合する方法について説明します。完了したら、SDK をさらにカスタマイズできます。
SDK の統合
ステップ1:SDK をプロジェクトに追加する
Cordova 6 以降では、GitHub から直接 SDK を追加できます。または、GitHub リポジトリの ZIP をダウンロードして、SDK を手動で追加することもできます。
ロケーションコレクションとジオフェンスを使用する予定がない場合は、GitHub の master
ブランチを使用してください。
1
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#master
位置情報の収集とジオフェンスの使用を計画している場合は、GitHub の geofence-branch
を使用します。
1
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#geofence-branch
tip:
ステップ 1 を繰り返すことで、いつでも master
と geofence-branch
を切り替えることができます。
ステップ 2:プロジェクトを構成する
次に、プロジェクトの config.xml
ファイル内の platform
要素に次の環境設定を追加します。
1
2
<preference name="com.braze.api_key" value="BRAZE_API_KEY" />
<preference name="com.braze.ios_api_endpoint" value="CUSTOM_API_ENDPOINT" />
1
2
<preference name="com.braze.api_key" value="BRAZE_API_KEY" />
<preference name="com.braze.android_api_endpoint" value="CUSTOM_API_ENDPOINT" />
次のように置き換えます。
値 | 説明 |
---|---|
BRAZE_API_KEY |
あなたのBraze REST APIキー。 |
CUSTOM_API_ENDPOINT |
カスタムAPIエンドポイント。このエンドポイントは、Brazeダッシュボードの正しいアプリグループにBrazeインスタンスデータをルーティングするために使用されます。 |
config.xml
ファイルの platform
要素は次のようになります。
1
2
3
4
<platform name="ios">
<preference name="com.braze.api_key" value="BRAZE_API_KEY" />
<preference name="com.braze.ios_api_endpoint" value="sdk.fra-01.braze.eu" />
</platform>
1
2
3
4
<platform name="android">
<preference name="com.braze.api_key" value="BRAZE_API_KEY" />
<preference name="com.braze.android_api_endpoint" value="sdk.fra-01.braze.eu" />
</platform>
自動セッショントラッキングの無効化 (Android のみ)
デフォルトでは、Android Cordova プラグインは自動的にセッションを追跡します。自動セッショントラッキングを無効にするには、プロジェクトの config.xml
ファイル内の platform
要素に次の設定を追加します。
1
2
3
<platform name="android">
<preference name="com.braze.android_disable_auto_session_tracking" value="true" />
</platform>
トラッキングセッションを再開するには、BrazePlugin.startSessionTracking()
を呼び出します。次回の Activity.onStart()
以降に開始されたセッションのみが追跡されることに注意してください。
New Stuff!