コンテキスト変数
コンテキスト変数は、特定のキャンバスにおけるユーザーのジャーニー内で作成・使用できる一時的なデータです。コンテキスト変数を使用すると、ユーザーのプロファイル情報を恒久的に変更することなく、遅延のパーソナライズ、ユーザーのダイナミックなセグメント化、メッセージングの充実化が可能になります。コンテキスト変数はキャンバスセッション内にのみ存在し、異なるキャンバス間やセッション外では保持されません。
コンテキスト変数の仕組み
コンテキスト変数は2つの方法で設定できます。
- キャンバスエントリ時: ユーザーがキャンバスに入ると、イベントまたは API トリガーからのデータがコンテキスト変数に自動的に入力されます。
- コンテキストステップ内: コンテキストステップを追加することで、キャンバス内でコンテキスト変数を手動で定義または更新できます。
各コンテキスト変数には以下が含まれます。
- 名前（
flight_timeやsubscription_renewal_dateなど） - データタイプ（数値、文字列、時間、配列など）
- Liquid またはパーソナライゼーションを追加ツールを使用して割り当てる値
定義すると、次の形式で参照することにより、キャンバス全体でコンテキスト変数を使用できます: {{context.${example_variable_name}}}
例えば、{{context.${flight_time}}} はユーザーの予定フライト時刻を返すことができます。
ユーザーがキャンバスに入るたびに（以前に入ったことがある場合でも）、コンテキスト変数は最新のエントリデータとキャンバス設定に基づいて再定義されます。このステートフルなアプローチにより、各キャンバスエントリが独自の独立したコンテキストを維持でき、ユーザーは同じジャーニー内で複数のアクティブな状態を持ちながら、各状態の固有のコンテキストを保持できます。
例えば、顧客に2つの今後のフライトがある場合、2つの別々のジャーニー状態が同時に実行されます。それぞれが出発時刻や目的地などの独自のフライト固有のコンテキスト変数を持ちます。これにより、午後2時のニューヨーク行きフライトに関するパーソナライズされたリマインダーを送信しながら、明日の午前8時のロサンゼルス行きフライトに関する別の更新を送信でき、各メッセージが特定の予約に関連した内容になります。
考慮事項
コンテキストステップごとに最大10個のコンテキスト変数を定義できます。各変数名は最大100文字で、文字、数字、またはアンダースコアのみを使用する必要があります。
コンテキスト変数の定義は最大10,240文字です。API トリガーのキャンバスにコンテキスト変数を渡す場合、コンテキストステップで作成された変数と同じ名前空間を共有します。例えば、/canvas/trigger/send エンドポイントのコンテキストオブジェクトで変数 purchased_item を送信した場合、{{context.${purchased_item}}} として参照できます。コンテキストステップでその変数を再定義すると、新しい値がそのユーザーのジャーニーの API 値を上書きします。
コンテキストステップごとに最大50 KBを保存でき、最大10個の変数に分散されます。ステップ内のすべての変数の合計サイズが50 KBを超えた場合、制限を超える変数は評価も保存もされません。例えば、コンテキストステップに3つの変数がある場合:
- 変数1: 30 KB
- 変数2: 19 KB
- 変数3: 2 KB
変数3は、前の変数の合計が50 KBを超えるため、評価も保存もされません。
データタイプ
ステップで作成または更新されるコンテキスト変数には、以下のデータタイプを割り当てることができます。
コンテキスト変数は、イベントプロパティと同じデータタイプの期待される形式を持ちます。
配列タイプを使用する場合、Braze は値を JSON として解析しようとするため、オブジェクトの配列を正常に作成できます。配列内のオブジェクトが有効な JSON でない場合、結果は単純な文字列の配列になります。
ネストされたオブジェクトやオブジェクトの配列には、as_json_string Liquid フィルターを使用してください。コンテキストステップで同じオブジェクトを作成する場合は、as_json_string を使用してオブジェクトをレンダリングする必要があります。例: {{context.${object_array} | as_json_string }}
| データタイプ | 変数名の例 | 値の例 |
|---|---|---|
| ブール値 | loyalty_program | true |
| 数値 | credit_score | 740 |
| 文字列 | product_name | green_tea |
| 配列 | favorite_products | ["wireless_headphones", "smart_homehub", "fitness_tracker_swatch"] |
| 配列（オブジェクトの） | pet_details | [ |
| 時間（UTC） | last_purchase_date | 2025-12-25T08:15:30:250-0800 |
| オブジェクト（フラット化） | user_profile | { |
デフォルトでは、時間データタイプは UTC です。文字列データタイプを使用して時間値を保存する場合、PST などの別のタイムゾーンとして時間を定義できます。
例えば、ユーザーの誕生日の前日にメッセージを送信する場合、前日に送信するための Liquid ロジックが関連付けられているため、コンテキスト変数を時間データタイプとして保存します。ただし、クリスマス（12月25日）にホリデーメッセージを送信する場合は、時間をダイナミックな変数として参照する必要がないため、文字列データタイプを使用する方が適切です。
オブジェクトデータタイプの場合、ドット記法を使用してデータ内のパスを指定できます。例えば、コンテキストステップでコンテキスト変数 order_summary を次の構造で定義した場合:
1
2
3
4
5
{
"shipping": {
"carrier": "overnight"
}
}
オーディエンスパスまたは条件分岐フィルターでは、ドット記法を使用してコンテキスト変数名としてパスを入力します（例: order_summary.shipping.carrier）。フィルターが評価されると、Braze はそのパスを値 overnight に解決します。
Liquid 内（メッセージステップなど）では、代わりに {{context.${order_summary}.shipping.carrier}} を使用します。
コンテキスト変数の使用
コンテキスト変数は、メッセージやユーザーの更新ステップなど、キャンバス内で Liquid を使用するあらゆる場所で、パーソナライゼーションを追加を選択して使用できます。メッセージステップのアプリ内メッセージやバナーでは、メッセージの有効期限を決定するためにコンテキスト変数を選択できます。
例えば、今後のフライト前に乗客に VIP ラウンジアクセスについて通知したいとします。このメッセージはファーストクラスのチケットを購入した乗客にのみ送信する必要があります。コンテキスト変数は、この情報を追跡する柔軟な方法です。
ユーザーは飛行機のチケットを購入するとキャンバスに入ります。ラウンジアクセスの資格を判断するために、コンテキストステップで lounge_access_granted というコンテキスト変数を作成し、ユーザージャーニーの後続のステップでそのコンテキスト変数を参照します。
このコンテキストステップでは、{{custom_attribute.${purchased_flight}}} を使用して、購入したフライトのタイプが first_class かどうかを判断します。
次に、{{context.${lounge_access_granted}}} が true であるユーザーをターゲットにするメッセージステップを作成します。このメッセージは、パーソナライズされたラウンジ情報を含むプッシュ通知になります。このコンテキスト変数に基づいて、資格のある乗客はフライト前に関連するメッセージを受け取ります。
- ファーストクラスのチケット乗客は次のメッセージを受け取ります:「限定 VIP ラウンジアクセスをお楽しみください！」
- ビジネスクラスとエコノミークラスのチケット乗客は次のメッセージを受け取ります:「フライトをアップグレードして限定 VIP ラウンジアクセスを手に入れましょう。」
コンテキストステップの情報を使用してパーソナライズされた遅延オプションを追加できます。つまり、ユーザーを遅延させる変数を選択できます。
アクションパスと離脱条件の場合
以下のトリガーアクションで、プロパティフィルターをコンテキスト変数またはカスタム属性と比較できます: カスタムイベントを実行および購入を行う。これらのアクショントリガーは、基本プロパティとネストされたプロパティの両方のプロパティフィルターもサポートしています。
- 基本プロパティと比較する場合、利用可能な比較はカスタムイベントで定義されたプロパティのタイプと一致します。例えば、文字列プロパティには完全一致、正規表現一致があります。ブール値プロパティは true または false になります。
- ネストされたプロパティと比較する場合、タイプは事前定義されていないため、ブール値、数値、文字列、時間、年内の日付の複数のデータタイプにわたる比較を選択できます。これは階層化カスタム属性の比較と同様です。比較時にネストされたプロパティの実際のデータタイプと一致しないデータタイプを選択した場合、ユーザーはアクションパスまたは離脱条件に一致しません。
アクションパスの例
カスタム属性の比較では、アクションが実行された時点のカスタム属性値を使用します。つまり、比較時にユーザーがこのカスタム属性を設定していない場合、またはカスタム属性値が定義されたプロパティ比較と一致しない場合、ユーザーはアクションパスグループに一致しません。これは、ユーザーがアクションパスステップに入った時点では一致していた場合でも同様です。
以下のアクションパスは、基本プロパティ source を持つカスタムイベント Account_Created を実行したユーザーを、コンテキスト変数 app_source_variable に振り分けるように設定されています。
以下のアクションパスは、特定の製品名 shoes の基本プロパティ brand をコンテキスト変数 promoted_shoe_brand と一致させるように設定されています。
離脱条件の例
離脱条件は、キャンバス内のユーザージャーニーの任意の時点で、以下の場合にユーザーがキャンバスから離脱することを示します。
- カスタムイベント Abandon Cart を実行し、かつ
- 基本プロパティ Item in Cart がコンテキスト変数
cart_item_thresholdの文字列値と一致する場合。
離脱条件は、キャンバス内のユーザージャーニーの任意の時点で、以下の場合にユーザーがキャンバスから離脱することを示します。
- 製品名「book」の特定の購入を行い、かつ
- その購入のネストされたプロパティ「loyalty_program」がユーザーのカスタム属性「VIP」と等しい場合。
有効期限の設定
キャンバスのメッセージステップ内のバナーおよびアプリ内メッセージでは、有効期限としてステップが利用可能になってからの期間を選択し、期間をパーソナライズをオンにすることで、コンテキスト変数から利用可能時間枠を制御できます。例えば、コンテキストステップからのプロモーションや予約期間に合わせることができます。
期間をパーソナライズは、その期間ベースの有効期限オプションに適用されます。代わりに特定の日時を選択した場合は、日時コントロールを使用して有効期限を設定します。
アクションパスの遅延
アクションパスステップの評価時間枠で、遅延をパーソナライズをオンにすると、コンテキスト変数からユーザーがステップに保持される時間を設定できます。ティアやリージョンなどの詳細に基づいて待機期間がユーザーごとに異なる場合に使用します。
コンテキスト変数フィルター
オーディエンスパスおよび条件分岐ステップで、以前に宣言されたコンテキスト変数を使用するフィルターを作成できます。
コンテキスト変数フィルターは、オーディエンスパスと条件分岐ステップでのみ利用可能です。
コンテキスト変数はキャンバスのスコープ内でのみ宣言およびアクセス可能であり、セグメントでは参照できません。コンテキスト変数フィルターは、オーディエンスパスと条件分岐ステップで同様に機能します。オーディエンスパスステップは複数のグループを表し、条件分岐ステップはバイナリの判断を表します。
キャンバスのコンテキスト変数に事前定義されたタイプがあるのと同様に、コンテキスト変数と静的値の比較には一致するデータタイプが必要です。コンテキスト変数フィルターは、ブール値、数値、文字列、時間、年内の日付の複数のデータタイプにわたる比較を可能にします。これは階層化カスタム属性の比較と同様です。
コンテキスト変数と比較には同じデータタイプを使用してください。例えば、コンテキスト変数が時間データタイプの場合、時間比較（「前」や「後」など）を使用します。一致しないデータタイプ（時間コンテキスト変数に対する文字列比較など）を使用すると、予期しない動作が発生する可能性があります。
「Day of year」と「Time」のフィルタータイプの選択について：日付を含むコンテキスト変数をフィルタリングする際は、その日付が毎年繰り返されるかどうかに基づいて、適切な比較タイプを選択してください。
- 毎年繰り返される日付（誕生日、記念日、クリスマスなどの祝日など）には「Day of year」を使用してください。この比較タイプは、年の要素を無視し、その年の日数（1〜365/366）に基づいて計算します。
- 繰り返されない絶対日付（契約終了日、予約日、サブスクリプションの更新日など）には「Time」を使用してください。この比較タイプは、年を含む完全なタイムスタンプに基づいて計算します。
絶対日付に「Day of year」を使用すると、計算が年の要素を無視するため、誤った結果や予期しない結果が生じることがあります。例えば、4月の将来の契約終了日が63日以内かどうかを判断する場合、「Day of year」を使用すると、日付番号（119対359）のみを比較し、実際には4月まで188日あることを考慮しないため、誤った一致が生じる可能性があります。
一般的な指針：その日付は毎年繰り返されますか？はい → 「Day of year」を使用してください。いいえ → 「Time」を使用してください。
以下は、コンテキスト変数 product_name を正規表現 /braze/ と比較するコンテキスト変数フィルターの例です。
コンテキスト変数またはカスタム属性との比較
コンテキスト変数またはカスタム属性と比較トグルを選択すると、以前に定義されたコンテキスト変数またはユーザーのカスタム属性と比較するコンテキスト変数フィルターを構築できます。これは、API トリガーの context のようにユーザーごとにダイナミックな比較を行う場合や、コンテキスト変数にわたって定義された複雑な比較ロジックを集約する場合に便利です。
ダイナミックな非アクティブ期間の後にユーザーにパーソナライズされたリマインダーを送信したいとします。過去3日間にアプリにログインしていないユーザーがメッセージを受け取る対象です。
コンテキスト変数 re_engagement_date は {{now | minus: 3 | append: ' days'}} として定義されています。3 days はユーザーのカスタム属性としても保存される可変量にすることができます。したがって、re_engagement_date が last_login_date（ユーザープロファイルにカスタム属性として保存）より後の場合、メッセージが送信されます。
以下のフィルターは、コンテキスト変数 reminder_date がコンテキスト変数 appointment_deadline より前であることを比較します。これにより、オーディエンスパスステップでユーザーをグループ化して、予約期限前に追加のリマインダーを受け取るべきかどうかを判断できます。
タイムゾーンの一貫性の標準化
キャンバスでタイムスタンプタイプを使用するほとんどのイベントプロパティはすでに UTC ですが、いくつかの例外があります。キャンバスコンテキストの追加により、アクションベースのキャンバスのすべてのデフォルトのタイムスタンプイベントプロパティは一貫して UTC になります。この変更は、キャンバスステップやメッセージの編集時により予測可能で一貫した体験を確保するための広範な取り組みの一部です。この変更は、特定のキャンバスがコンテキストステップを使用しているかどうかに関係なく、すべてのアクションベースのキャンバスに影響します。
すべての状況において、タイムスタンプを目的のタイムゾーンで表示するために Liquid の time_zone フィルターを使用することを強くお勧めします。例については、コンテキストステップの記事のよくある質問を参照してください。