SDK の初期セットアップ

このリファレンス記事では、Flutter 向け Braze SDK のインストール方法について説明します。以下の手順に従って、Braze Flutter SDK をインストールします。これには、Dart で記述された Flutter アプリでインテグレーターが Braze API を使用できるようにするパッケージが含まれています。

このプラグインには、基本的な分析機能が用意されており、iOS と Android 両方のアプリ内メッセージとコンテンツカードを1つのコードベースで統合できます。

前提条件

インストールを完了するには、アプリ識別子 API キーと SDK エンドポイントが必要です。どちらもダッシュボードの [設定の管理] の下にあります。

これらの手順を実行する前に、Flutter SDK をインストールしてセットアップします。マシンとプロジェクトで、必要な最小限の Flutter バージョンと Dart バージョン (こちらに記載) が実行されていることを確認します。

ステップ 1:Braze ライブラリーを統合する

コマンドラインから Braze Flutter SDK パッケージを追加します。

1
flutter pub add braze_plugin

これにより、適切な行がpubspec.yaml に追加されます。

ステップ 2:ネイティブセットアップを完了する

• android
• ios

1
2
3
4
5
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="com_braze_api_key">YOUR_APP_IDENTIFIER_API_KEY</string>
<string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_ENDPOINT_OR_CLUSTER</string>
</resources>

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

1
2
import BrazeKit
import braze_plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
static var braze: Braze? = nil

func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
) -> Bool {
  // Setup Braze
  let configuration = Braze.Configuration(
    apiKey: "<BRAZE_API_KEY>",
    endpoint: "<BRAZE_ENDPOINT>"
  )
  // - Enable logging or customize configuration here
  configuration.logger.level = .info
  let braze = BrazePlugin.initBraze(configuration)
  AppDelegate.braze = braze

  return true
}

1
@import BrazeKit;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  // Setup Braze
  BRZConfiguration *configuration =
      [[BRZConfiguration alloc] initWithApiKey:@"<BRAZE_API_KEY>"
                                      endpoint:@"<BRAZE_ENDPOINT>"];
  // - Enable logging or customize configuration here
  configuration.logger.level = BRZLoggerLevelInfo;
  Braze *braze = [BrazePlugin initBraze:configuration];
  AppDelegate.braze = braze;

  [self.window makeKeyAndVisible];
  return YES;
}

#pragma mark - AppDelegate.braze

static Braze *_braze = nil;

+ (Braze *)braze {
  return _braze;
}

+ (void)setBraze:(Braze *)braze {
  _braze = braze;
}

ステップ 3: 使用

Dart コードにプラグインをインポートするには、以下を使用します。

1
import 'package:braze_plugin/braze_plugin.dart';

次に、サンプルアプリのように new BrazePlugin() を呼び出して、Braze プラグインのインスタンスを初期化します。

基本的な統合のテスト

この時点で、ダッシュボードでセッション統計を確認することで、SDK が統合されていることを確認できます。いずれかのプラットフォームでアプリケーションを実行すると、ダッシュボード ([概要] セクション) に新しいセッションが表示されます。

アプリで次のコードを呼び出すことで、特定のユーザーのセッションを開くことができます。

1
2
BrazePlugin braze = BrazePlugin();
braze.changeUser("{some-user-id}");

その後、ダッシュボードの [オーディエンス] > [ユーザー検索] で {some-user-id} を使用してユーザーを検索します。そこで、セッションとデバイスデータがロギングされていることを確認できます。