機能フラグの作成

機能フラグを使用すると、選択したユーザーの機能をリモートで有効または無効にできます。Braze ダッシュボード内に新しい機能フラグを作成します。名前、ターゲットユーザー、およびこの機能を有効にするユーザーの割合を指定します。IDそして、IDそれをアプリやウェブサイトのコードで使用することで、ビジネスロジックの特定の部分を条件付きで実行できます。

フィーチャーフラグとは何か、Braze でどのように使用できるかについて詳しく知りたいですか？先に進む前に 機能フラグについて を確認してください。

前提条件

機能フラグを使用するには、SDK が少なくとも次の最低バージョンで最新であることを確認してください。

ダッシュボードに機能フラグを実装する

[メッセージング] > [機能フラグ] から機能フラグを作成、編集、アーカイブします。このページには、このワークスペースの既存の機能フラグのリストが表示されます。

アクセス許可

機能フラグを表示、作成、編集するには、「機能フラグの管理」権限 が必要です。使用可能な機能フラグのリストを表示するには、「キャンペーン、キャンバス、カード、フィーチャーフラッグ、セグメント、メディアライブラリへのアクセス」権限が必要です。

新しい機能フラグの作成

新しい機能フラグを作成するには、[機能フラグの作成] ボタンをクリックします。次に、機能フラグの詳細、プロパティ、ユーザーターゲティング、およびロールアウトトラフィックを定義します。

詳細

新しい機能フラグに [名前] と [ID] を指定します。

• 名前フィールドでは、マーケティング担当者や管理者が使用するこの機能フラグのタイトルを人間が読めるように指定できます。
• ID フィールドはコード内で参照され、特定のユーザーに対してこの機能が有効になっているかどうかが判断されます。これは一意でなければならず、作成後は変更できません。
• 説明フィールドは、この機能フラグに関する追加のコンテキストを提供できるオプションフィールドです。

IDは機能を開発する際に使用されるため、慎重に選択してください。コードが同僚 (および将来の自分) に読めるように、適切な命名規則を実践してください。

たとえば、enable_rider_new_profile_page機能フラグを有効にするとどうなるかを明確にするために{verb}_{product}_{feature}、という命名規則を使用するのが一般的です。

[プロパティ]

カスタムプロパティはフィーチャーフラグの一部として定義できます。これらのプロパティは、機能が有効になると、Braze SDK を介してアプリからアクセスできるようになります。プロパティの定義はオプションの手順です。

変数には、文字列、ブーリアン値、または数値を使用できます。各プロパティの変数キーとデフォルト値の両方を定義します。

プロパティの例

たとえば、eコマースストアの在庫切れバナーを表示する機能フラグを定義する場合、バナーを表示するときにアプリが使用する次のプロパティを設定できます。

ターゲット設定

機能フラグのロールアウトを開始するには、特定のユーザーセグメントを選択する必要があります。

「フィルターを追加」ドロップダウンメニューを使用して、ユーザーをターゲットオーディエンスから除外します。複数のフィルターを追加して対象者を絞り込みます。

ロールアウトトラフィック

機能フラグは常にオフの状態で開始されるため、ユーザーエクスペリエンスにおける機能のリリースとアクティベーションのタイミングを分けることができます。

新機能をロールアウトする準備ができたら、オーディエンスを指定し、ロールアウトトラフィックスライダーを使用して、ターゲットとするユーザーベースのうち、新機能を受け取るユーザーの割合をランダムに定義します。ロールアウトトラフィックスライダーを設定して、0% (ユーザーなし) から 100% (ターゲットオーディエンス全体) までの割合を設定します。

アプリケーション内で機能フラグが有効になっているかどうかを確認してください

機能フラグを定義したら、特定のユーザーに対して有効になっているかどうかを確認するようにアプリまたはサイトを構成します。有効になったら、アクションを設定するか、ユースケースに基づいて機能フラグの変数プロパティを参照します。Braze SDK には、機能フラグのステータスとそのプロパティをアプリに取り込むためのゲッターメソッドが用意されています。

機能フラグはセッションの開始時に自動的に更新されるため、起動時に機能の最新バージョンを表示できます。SDK はこれらの値をキャッシュして、オフラインでも使用できるようにします。

たとえば、アプリに新しいタイプのユーザープロファイルを導入するとします。IDをとして設定することもできますexpanded_user_profile。次に、この新しいユーザープロファイルを特定のユーザーに表示する必要があるかどうかをアプリに確認させます。以下に例を示します。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku

1
2
3
4
5
6
const featureFlag = braze.getFeatureFlag("expanded_user_profile");
if (featureFlag.enabled) {
  console.log(`expanded_user_profile is enabled`);
} else {
  console.log(`expanded_user_profile is not enabled`);
}

1
2
3
4
5
6
let featureFlag = braze.featureFlags.featureFlag(id: "expanded_user_profile")
if featureFlag.enabled {
  print("expanded_user_profile is enabled")
} else {
  print("expanded_user_profile is not enabled")
}

1
2
3
4
5
6
FeatureFlag featureFlag = braze.getFeatureFlag("expanded_user_profile");
if (featureFlag.getEnabled()) {
  Log.i(TAG, "expanded_user_profile is enabled");
} else {
  Log.i(TAG, "expanded_user_profile is not enabled");
}

1
2
3
4
5
6
val featureFlag = braze.getFeatureFlag("expanded_user_profile")
if (featureFlag.enabled) {
  Log.i(TAG, "expanded_user_profile is enabled.")
} else {
  Log.i(TAG, "expanded_user_profile is not enabled.")
}

1
2
3
4
5
6
const featureFlag = await Braze.getFeatureFlag("expanded_user_profile");
if (featureFlag.enabled) {
  console.log(`expanded_user_profile is enabled`);
} else {
  console.log(`expanded_user_profile is not enabled`);
}

1
2
3
4
5
6
var featureFlag = Appboy.AppboyBinding.GetFeatureFlag("expanded_user_profile");
if (featureFlag.Enabled) {
  Console.WriteLine("expanded_user_profile is enabled");
} else {
  Console.WriteLine("expanded_user_profile is not enabled");
}

1
2
3
4
5
6
const featureFlag = await BrazePlugin.getFeatureFlag("expanded_user_profile");
if (featureFlag.enabled) {
  console.log(`expanded_user_profile is enabled`);  
} else {
  console.log(`expanded_user_profile is not enabled`);
}

1
2
3
4
5
6
BrazeFeatureFlag featureFlag = await braze.getFeatureFlagByID("expanded_user_profile");
if (featureFlag.enabled) {
  print("expanded_user_profile is enabled");
} else {
  print("expanded_user_profile is not enabled");
}

1
2
3
4
5
6
featureFlag = m.braze.getFeatureFlag("expanded_user_profile")
if featureFlag.enabled
  print "expanded_user_profile is enabled"
else
  print "expanded_user_profile is not enabled"
end if

機能フラグのインプレッションを記録する

ユーザーが新機能を操作する機会があったとき、または機能が無効になっていれば操作できたはずのときに、機能フラグのインプレッションを追跡します（A/B テストのコントロールグループの場合）。

通常、アプリの機能フラグを参照する場所のすぐ下に次のコード行を置くことができます。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku

1
braze.logFeatureFlagImpression("expanded_user_profile");

1
braze.featureFlags.logFeatureFlagImpression(id: "expanded_user_profile")

1
braze.logFeatureFlagImpression("expanded_user_profile");

1
braze.logFeatureFlagImpression("expanded_user_profile")

1
Braze.logFeatureFlagImpression("expanded_user_profile");

1
Appboy.AppboyBinding.LogFeatureFlagImpression("expanded_user_profile");

1
BrazePlugin.logFeatureFlagImpression("expanded_user_profile");

1
braze.logFeatureFlagImpression("expanded_user_profile");

1
m.Braze.logFeatureFlagImpression("expanded_user_profile");

プロパティへのアクセス

機能フラグのプロパティにアクセスするには、ダッシュボードで定義したタイプに応じて、次のいずれかの方法を使用します。

機能フラグが有効になっていない場合、または参照するプロパティが存在しない場合、これらのメソッドが返されますnull。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku

1
2
3
4
5
6
7
8
// Feature flag instance
const featureFlag = braze.getFeatureFlag("expanded_user_profile");
// String properties
const stringProperty = featureFlag.getStringProperty("color");
// Boolean properties
const booleanProperty = featureFlag.getBooleanProperty("expanded");
// Number properties
const numberProperty = featureFlag.getNumberProperty("height");

1
2
3
4
5
6
7
8
// Feature flag instance
let featureFlag: FeatureFlag = braze.featureFlags.featureFlag(id: "expanded_user_profile")
// String properties
let stringProperty: String? = featureFlag.stringProperty(key: "color")
// Boolean properties
let booleanProperty: Bool? = featureFlag.boolProperty(key: "expanded")
// Number properties
let numberProperty: Double? = featureFlag.numberProperty(key: "height")

1
2
3
4
5
6
7
8
// Feature flag instance
FeatureFlag featureFlag = braze.getFeatureFlag("expanded_user_profile");
// String properties
String stringProperty = featureFlag.getStringProperty("color");
// Boolean properties
Boolean booleanProperty = featureFlag.getBooleanProperty("expanded");
// Number properties
Number numberProperty = featureFlag.getNumberProperty("height");

1
2
3
4
5
6
7
8
// feature flag instance
val featureFlag = braze.getFeatureFlag("expanded_user_profile")
// string properties
val stringProperty = featureFlag.getStringProperty("color")
// boolean properties
val booleanProperty = featureFlag.getBooleanProperty("expanded")
// number properties
val numberProperty = featureFlag.getNumberProperty("height")

1
2
3
4
5
6
// String properties
const stringProperty = await Braze.getFeatureFlagStringProperty("expanded_user_profile", "color");
// Boolean properties
const booleanProperty = await Braze.getFeatureFlagBooleanProperty("expanded_user_profile", "expanded");
// Number properties
const numberProperty = await Braze.getFeatureFlagNumberProperty("expanded_user_profile", "height");

1
2
3
4
5
6
7
8
9
10
// Feature flag instance
var featureFlag = Appboy.AppboyBinding.GetFeatureFlag("expanded_user_profile");
// String properties
var stringProperty = featureFlag.getStringProperty("color");
// Boolean properties
var booleanProperty = featureFlag.getBooleanProperty("expanded");
// Number property as integer
var integerProperty = featureFlag.getIntegerProperty("height");
// Number property as double
var doubleProperty = featureFlag.getDoubleProperty("height");

1
2
3
4
5
6
// String properties
const stringProperty = await BrazePlugin.getFeatureFlagStringProperty("expanded_user_profile", "color");
// Boolean properties
const booleanProperty = await BrazePlugin.getFeatureFlagBooleanProperty("expanded_user_profile", "expanded");
// Number properties
const numberProperty = await BrazePlugin.getFeatureFlagNumberProperty("expanded_user_profile", "height");

1
2
3
4
5
6
7
BrazeFeatureFlag featureFlag = await braze.getFeatureFlagByID("expanded_user_profile");
// String properties
var stringProperty = featureFlag.getStringProperty("color");
// Boolean properties
var booleanProperty = featureFlag.getBooleanProperty("expanded");
// Number properties
var numberProperty = featureFlag.getNumberProperty("height");

1
2
3
4
5
6
' String properties
color = featureFlag.getStringProperty("color")
' Boolean properties
expanded = featureFlag.getBooleanProperty("expanded")
' Number properties
height = featureFlag.getNumberProperty("height")

有効になっているすべての機能フラグのリストを取得することもできます。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku

1
2
3
4
const features = getAllFeatureFlags();
for(const feature of features) {
  console.log(`Feature: ${feature.id}`, feature.enabled);
}

1
2
3
4
let features = braze.featureFlags.featureFlags
for let feature in features {
  print("Feature: \(feature.id)", feature.enabled)
}

1
2
3
4
List<FeatureFlag> features = braze.getAllFeatureFlags();
for (FeatureFlag feature: features) {
  Log.i(TAG, "Feature: ", feature.getId(), feature.getEnabled());
}

1
2
3
4
val featureFlags = braze.getAllFeatureFlags()
featureFlags.forEach { feature ->
  Log.i(TAG, "Feature: ${feature.id} ${feature.enabled}")
}

1
2
3
4
const features = await Braze.getAllFeatureFlags();
for(const feature of features) {
  console.log(`Feature: ${feature.id}`, feature.enabled);
}

1
2
3
4
List<FeatureFlag> features = Appboy.AppboyBinding.GetAllFeatureFlags();
foreach (FeatureFlag feature in features) {
  Console.WriteLine("Feature: {0} - enabled: {1}", feature.ID, feature.Enabled);
}

1
2
3
4
const features = await BrazePlugin.getAllFeatureFlags();
for(const feature of features) {
  console.log(`Feature: ${feature.id}`, feature.enabled);
}

1
2
3
4
List<BrazeFeatureFlag> featureFlags = await braze.getAllFeatureFlags();
featureFlags.forEach((feature) {
  print("Feature: ${feature.id} ${feature.enabled}");
});

1
2
3
4
features = m.braze.getAllFeatureFlags()
for each feature in features
      print "Feature: " + feature.id + " enabled: " + feature.enabled.toStr()
end for

機能フラグを更新

セッション中に現在のユーザーの機能フラグを更新して、Braze から最新の値を取得できます。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku

1
2
3
4
5
braze.refreshFeatureFlags(() => {
  console.log(`Feature flags have been refreshed.`);
}, () => {
  console.log(`Failed to refresh feature flags.`);
});

1
2
3
4
5
6
7
8
braze.featureFlags.requestRefresh { result in
  switch result {
  case .success(let features):
    print("Feature flags have been refreshed:", features)
  case .failure(let error):
    print("Failed to refresh feature flags:", error)
  }
}

1
braze.refreshFeatureFlags();

1
braze.refreshFeatureFlags()

1
Braze.refreshFeatureFlags();

1
Appboy.AppboyBinding.RefreshFeatureFlags();

1
BrazePlugin.refreshFeatureFlags();

1
braze.refreshFeatureFlags();

1
m.Braze.refreshFeatureFlags()

変化に耳を傾ける

SDK がいずれかの機能フラグを更新したときにアプリをリッスンして更新するように Braze SDK を設定できます。

これは、ユーザーが機能を利用できなくなった場合にアプリを更新する場合に便利です。たとえば、機能が有効になっているかどうかや、そのプロパティ値のいずれかに基づいてアプリの状態を設定します。

• javascript
• swift
• java
• kotlin
• react native
• unity
• cordova
• flutter
• roku
• react hook

1
2
3
4
5
6
// Register an event listener
const subscriptionId = braze.subscribeToFeatureFlagsUpdates((features) => {
  console.log(`Features were updated`, features);
});
// Unregister this event listener
braze.removeSubscription(subscriptionId);

1
2
3
4
5
6
7
// Create the feature flags subscription
// - You must keep a strong reference to the subscription to keep it active
let subscription = braze.featureFlags.subscribeToUpdates { features in
  print("Feature flags were updated:", features)
}
// Cancel the subscription
subscription.cancel()

1
2
3
4
5
6
braze.subscribeToFeatureFlagsUpdates(event -> {
  Log.i(TAG, "Feature flags were updated.");
  for (FeatureFlag feature: event.getFeatureFlags()) {
    Log.i(TAG, "Feature: ", feature.getId(), feature.getEnabled());
  }
});

1
2
3
4
5
6
braze.subscribeToFeatureFlagsUpdates() { event ->
  Log.i(TAG, "Feature flags were updated.")
  event.featureFlags.forEach { feature ->
    Log.i(TAG, "Feature: ${feature.id}")
  }
}

1
2
3
4
// Register an event listener
Braze.addListener(braze.Events.FEATURE_FLAGS_UPDATED, (featureFlags) => {
  console.log(`featureFlagUpdates`, JSON.stringify(featureFlags));
});

1
2
3
4
// Register an event listener
BrazePlugin.subscribeToFeatureFlagUpdates((featureFlags) => {
    console.log(`featureFlagUpdates`, JSON.stringify(featureFlags));
});

1
2
' Define a function called `onFeatureFlagChanges` to be called when feature flags are refreshed
m.BrazeTask.ObserveField("BrazeFeatureFlags", "onFeatureFlagChanges")

機能フラグによるセグメンテーション

Braze は、現在どのユーザーが機能フラグの対象になっているか、どのユーザーが機能フラグに参加しているかを自動的に追跡します。**機能フラグ**フィルター を使用してセグメントまたはターゲットメッセージを作成できます。セグメントでのフィルタリングの詳細については、セグメントの作成 を参照してください。

ベストプラクティス

ロールアウトとキャンバスや実験を組み合わせないでください

さまざまなエントリポイントによってユーザーが有効または無効になるのを防ぐには、ロールアウトスライダーをゼロより大きい値に設定するか、キャンバスまたは実験で機能フラグを有効にする必要があります。ベストプラクティスとして、キャンバスや実験で機能フラグを使用する予定の場合は、ロールアウト率をゼロに保つことをお勧めします。

命名規則

• 次のようなパターンに従うことを検討してください{product}.{feature}.{action}。
  • たとえば、配車アプリでは、機能 ID は次のようになります。 driver.profile.show_animation_v3
• これは、特定の製品分野やチームの機能フラグを検索する場合にも役立ちます。
• アプリ内で機能フラグのデフォルト状態が無効になっていることを確認してください。
  • たとえば、disable_feature_xyzという名前のフラグがある場合はアンチパターンになります。例外もあるかもしれませんが、機能の「有効」状態と実際に有効になっている動作 (機能 XYZ を無効にする) を混同しないようにしてください。

前もって計画する

常に安全にプレイしてください。オフスイッチが必要な新機能を検討するときは、新しいアプリの更新が必要だと気付くよりも、機能フラグを付けて新しいコードをリリースし、必要ない方がよいでしょう。

説明文を書く

機能フラグに説明を追加します。これはBrazeのオプションフィールドですが、利用可能な機能フラグを閲覧するときに他の人が抱くかもしれない質問に答えるのに役立ちます。

• このフラグの有効化と動作の責任者の連絡先
• このフラグを無効にするべき場合
• このフラグが制御する新機能に関するドキュメントまたはメモへのリンク
• 機能の使用方法に関する依存関係や注意事項

古い機能フラグをクリーンアップ

100% ロールアウト時に必要以上に長く機能をオンのままにしておくのは、私たち全員の罪悪感です。

コード (および Braze ダッシュボード) をきれいに保つため、すべてのユーザーがアップグレードして機能を無効にするオプションが不要になったら、コードベースから恒久的な機能フラグを削除してください。これにより、開発環境の複雑さが軽減されるだけでなく、機能フラグのリストが整理されます。