SDK の初期セットアップ

このリファレンス記事では、Braze SDK for Xamarinのインストール方法について説明します。Braze SDK をインストールすると、基本的な分析機能と、ユーザーエンゲージメントのためのアプリ内メッセージが提供されます。

Android

ステップ 1:Xamarin バインディングの取得

Xamarin バインディングは、Xamarin アプリでネイティブライブラリを使用する方法です。バインドの実装は、ライブラリへのC# インターフェイスを構築し、アプリケーションでそのインターフェイスを使用することで構成されます。 Xamarin のドキュメントを参照してください。

Braze SDK バインディングを含めるには2 つの方法があります。

オプション 1: ニューゲット

最も単純な統合方法では、Nuget.org中央リポジトリからBraze SDK を取得します。Visual Studio サイドバーで、Packages フォルダを右クリックし、Add Packages... をクリックします。 ‘Braze’ を検索し、AppboyPlatform.AndroidBinding パッケージをプロジェクトにインストールします。

オプション 2: ソース

2 番目の統合方法は、バインディングソース を含めることです。appboy-component\src\android の下にバインディングソースコードがあります。Xamarin アプリケーションのAppboyPlatform.XamarinAndroidBinding.csproj にプロジェクト参照を追加すると、バインディングがプロジェクトと共にビルドされ、Braze Android SDK にアクセスできるようになります。

Braze Nuget パッケージは、Xamarin.Android.Support.v4 Nuget パッケージによって異なります。

ステップ 2: braze.xml で Braze SDK を設定する

ライブラリが統合されたので、プロジェクトのResources/values フォルダにbraze.xml ファイルを作成する必要があります。ファイルの内容は、次のコードスニペットのようになります。

Braze ダッシュボードのSettings > API Keys にあるAPI キーでREPLACE_WITH_YOUR_API_KEY を必ず置き換えてください。

1
2
3
4
5
6
7
8
9
    <?xml version="1.0" encoding="utf-8"?>
    <resources>
    <string name="com_braze_api_key">REPLACE_WITH_YOUR_API_KEY</string>
    <string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_ENDPOINT_OR_CLUSTER</string>
    <string-array name="com_braze_internal_sdk_metadata">
      <item>XAMARIN</item>
      <item>NUGET</item>
    </string-array>
    </resources>

バインドソースを手動で含める場合は、<item>NUGET</item> をコードから削除します。

ステップ 3: Android マニフェストに必要な権限を追加する

API キーを追加したので、次の権限を AndroidManifest.xml に追加する必要があります。

1
2
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

ステップ 4: ユーザーセッションの追跡とアプリ内メッセージの登録

ユーザーセッション追跡を有効にし、アプリ内メッセージ用にアプリを登録するには、アプリ内のOnCreate() クラスのApplication ライフサイクルメソッドに次の呼び出しを追加します。

1
RegisterActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener());

SDK 統合の完了

これで、アプリケーションを起動し、セッションがBraze ダッシュボードに(デバイス情報やその他の分析とともに) ログ記録されていることを確認できるようになります。

基本的なSDK 統合のベストプラクティスの詳細については、Android 統合手順 を参照してください。

iOS

ステップ 1:Xamarin バインディングの取得

Xamarin バインディングは、Xamarin アプリでネイティブライブラリを使用する方法です。 バインドの実装は、C# インタフェースをライブラリに構築し、アプリケーションでそのインタフェースを使用することで構成されます。

Braze SDK バインディングを含めるには2 つの方法があります。

オプション 1: ニューゲット

最も単純な統合方法では、Nuget.org中央リポジトリからBraze SDK を取得します。Visual Studio サイドバーで、Packages フォルダを右クリックし、Add Packages... をクリックします。 ‘Braze’ を検索し、AppboyPlatformXamariniOSBinding パッケージをプロジェクトにインストールします。

オプション 2: ソース

2 番目の統合方法は、バインディングソース を含めることです。 our GitHub repository にバインディングソースコードがあります。Xamarin アプリケーションのAppboyPlatformXamariniOSBinding.csproj にプロジェクト参照を追加すると、バインディングがプロジェクトとともに構築され、Braze iOS SDK にアクセスできるようになります。プロジェクトの”Reference”フォルダにAppboyPlatformXamariniOSBindingが表示されていることを確認します。

ステップ 2: アプリデリゲートを更新し、Xamarin の使用を宣言する

AppDelegate.cs ファイル内で、FinishedLaunching メソッド内に次のスニペットを追加します。

Developer Consoleページの正しい値でYOUR-API-KEYを更新してください。

1
2
3
4
// C#
 Appboy.StartWithApiKey ("YOUR-API-KEY", UIApplication.SharedApplication, options);
 Appboy.SharedInstance.SdkFlavor = ABKSDKFlavor.Xamarin;
 Appboy.SharedInstance.AddSdkMetadata(new []{ ABKSdkMetadata.ABKSdkMetadataXamarin, ABKSdkMetadata.ABKSdkMetadataNuGet });

バインドソースを手動で含める場合は、ABKSdkMetadata.ABKSdkMetadataNuGet をコードから削除します。

実装例

TestApp.XamariniOSサンプルアプリのAppDelegate.csファイルを参照してください。

ステップ 3: SDK エンドポイントをinfo.plist ファイルに追加する

Info.plist ファイル内で、次のスニペットを追加します。

YOUR-SDK-ENDPOINT は必ず、Settings ページの正しい値で更新してください。

1
2
3
4
5
6
// C#
<key>Braze</key>
<dict>
 <key>Endpoint</key>
 <string>YOUR-SDK-ENDPOINT</string>
</dict>

オプションで、次のスニペットを含めることで、詳細ロギングを含めることができます。

1
2
3
4
5
6
7
8
// C#
<key>Braze</key>
<dict>
 <key>LogLevel</key>
 <string>0</string>
 <key>Endpoint</key>
 <string>YOUR-SDK-ENDPOINT</string>
</dict>

なお、Braze iOS SDK v4.0.2 より前のバージョンでは、Braze の代わりにディクショナリキー Appboy を使用する必要があります。

SDK 統合の完了

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

iOS SDK 用の現在のパブリックXamarin バインディングは、iOS Facebook SDK(ソーシャルデータをリンクする)には接続されず、Braze へのIDFA の送信は含まれません。