SDK の初期セットアップ
Xamarin の Braze SDK をインストールする方法について説明します。Braze SDK をインストールすると、基本的な分析機能と、ユーザーエンゲージメントのためのアプリ内メッセージが提供されます。
version 3.0.0
以降、この SDK では、NET 6以降を使用する必要があり、Xamarin フレームワークを使用するプロジェクトのサポートが削除されます。
version 4.0.0
以降、この SDK は Xamarin と Xamarin.Forms のサポートを終了し、.NET MAUI のサポートを追加しました。
Xamarinのサポート終了前後のMicrosoftのポリシーを参照してください。
ステップ1:Xamarin バインディングの取得
Xamarin バインディングは、Xamarin アプリでネイティブライブラリを使用する方法です。バインディングの実装は、ライブラリに対して C# インターフェイスを構築し、アプリケーションでそのインターフェイスを使用することから構成されます。 Xamarin ドキュメントを参照してください。Braze SDK バインディングを含めるには、NuGet を使用する方法と、ソースからコンパイルする方法の2つがあります。
最も単純な統合方式では、NuGet.org中央リポジトリーからBraze SDKを取得します。Visual Studio サイドバーで、Packages
フォルダを右クリックし、Add Packages...
をクリックします。 ‘Braze’ を検索し、BrazePlatform.BrazeAndroidBinding
パッケージをプロジェクトにインストールします。
2 番目の統合方法は、バインディングソース を含めることです。appboy-component/src/androidnet6
にバインディングソースコードがあります。Xamarin アプリ ケーションの BrazeAndroidBinding.csproj
にプロジェクトリファレンスを追加すると、バインディングがプロジェクトと共に構築され、Braze Android SDK にアクセスできるようになります。
Xamarin SDK バージョン 4.0.0 以降の iOS バインディングでは Braze Swift SDK が使用されますが、以前のバージョンでは従来の AppboyKit SDK が使用されます。
Xamarin バインディングは、Xamarin アプリでネイティブライブラリを使用する方法です。 バインディングの実装は、ライブラリに対して C# インターフェイスを構築し、アプリケーションでそのインターフェイスを使用することから構成されます。Braze SDK バインディングを含めるには、NuGet を使用する方法と、ソースからコンパイルする方法の2つがあります。
最も単純な統合方式では、NuGet.org中央リポジトリーからBraze SDKを取得します。Visual Studio サイドバーで、Packages
フォルダを右クリックし、Add Packages...
をクリックします。 「Braze」を検索し、最新の Xamarin iOS NuGet パッケージ (Braze.iOS.BrazeKit、Braze.iOS.BrazeUI、および [Braze.iOS.BrazeLocation]https://www.nuget.org/packages/Braze.iOS.BrazeLocation) をプロジェクトにインストールします。
.NET MAUI への移行を容易にするために、互換性ライブラリパッケージ Braze.iOS.BrazeKitCompat および Braze.iOS.BrazeUICompat も提供しています。
2 番目の統合方法は、バインディングソース を含めることです。appboy-component/src/iosnet6
にバインディングソースコードがあります。Xamarin アプリケーションの BrazeiOSBinding.csproj
にプロジェクトリファレンスを追加すると、バインディングがプロジェクトと共に構築され、Braze iOS SDK にアクセスできるようになります。プロジェクトの「リファレンス」フォルダに BrazeiOSBinding.csproj
が表示されていることを確認します。
ステップ2:Brazeインスタンスの設定
ステップ 2.1:Braze.xmlでBraze SDKを構成する
ライブラリが統合されたので、プロジェクトのResources/values
フォルダにBraze.xml
ファイルを作成する必要があります。ファイルの内容は、次のコードスニペットのようになります。
Braze ダッシュボードのSettings> API キーsにあるAPI キーでYOUR_API_KEY
を必ず置き換えてください。
古いナビゲーション を使用している場合は、デベロッパコンソール> API 設定.にAPI キーがあります。
1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string translatable="false" name="com_braze_api_key">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>
を削除します。
Braze.xml
の例については、Android MAUI サンプルアプリを参照してください。
ステップ 2.2:Androidマニフェストに必要な権限を追加する
API キーを追加したので、次の権限を AndroidManifest.xml
ファイルに追加する必要があります。
1
<uses-permission android:name="android.permission.INTERNET" />
AndroidManifest.xml
の例については、Android MAUI サンプルアプリケーションを参照してください。
ステップ 2.3:ユーザー セッションs の追跡とアプリ内メッセージs の登録
ユーザーセッショントラッキングを有効にし、アプリ内メッセージ用にアプリを登録するには、アプリの Application
クラスの OnCreate()
ライフサイクルメソッドに次の呼び出しを追加します。
1
RegisterActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener());
Braze インスタンスを設定したら、次のスニペットを追加して、インスタンスを設定します。
Braze ダッシュボードのSettings> API キーsにあるAPI キーでYOUR_API_KEY
を必ず置き換えてください。
古いナビゲーション を使用している場合は、デベロッパコンソール> API 設定.にAPI キーがあります。
1
2
3
var configuration = new BRZConfiguration("YOUR_API_KEY", "YOUR_ENDPOINT");
configuration.Api.AddSDKMetadata(new[] { BRZSDKMetadata.Xamarin });
braze = new Braze(configuration);
iOS MAUIサンプルアプリライケーションのApp.xaml.cs
ファイルを参照してください。
ステップ3: 統合をテストする
これで、アプリケーションを起動して、セッションが Braze ダッシュボードに (デバイス情報やその他の分析と共に) 記録されているのを確認できます。基本的なSDKインテグレーションのベストプラクティスの詳細については、Androidインテグレーション命令を参照してください。
これで、アプリケーションを起動して、セッションが Braze ダッシュボードに記録されているのを確認できます。基本的なSDKインテグレーションのベストプラクティスの詳細については、iOSインテグレーションの手順を参照してください。
現行のiOS SDK向けのパブリックXamarinバインディングはiOS FaceBook SDK(ソーシャルデータのリンク)には接続されず、BrazeへのIDFAの送信は含まれていません。