コンテキストとイベントプロパティ
このリファレンス記事では、
contextとevent_propertiesに関する情報を取り上げます。それぞれのプロパティを使用するタイミングや動作の違いについて説明します。
カスタムイベントプロパティ全般については、カスタムイベントプロパティをご覧ください。
表示される用語とLiquidの名前空間は、ワークスペースで利用可能な機能によって異なります。
- ダッシュボードにコンテキスト変数と表示される場合は、エントリプロパティを
contextで参照します（例：{{context.${property_name}}}）。コンテキストステップを使用して変数を作成または更新することもできます。 - ダッシュボードにキャンバスエントリプロパティと表示される場合は、
canvas_entry_propertiesで参照します（例：{{canvas_entry_properties.${property_name}}}）。コンテキストステップおよびコンテキスト変数フィルターは利用できません。
詳細については、コンテキストおよびコンテキストとイベントプロパティを参照してください。キャンバスコンテキストへのアクセスが必要な場合は、カスタマーサクセスマネージャーにお問い合わせください。
コンテキストプロパティとイベントプロパティは、キャンバスワークフロー内で異なる動作をします。キャンバスコンテキストが有効なワークスペースでは、ユーザーのキャンバスへのエントリをトリガーするイベントまたはAPI呼び出しのプロパティはcontextとして利用できます。ワークスペースにキャンバスエントリプロパティが表示されている場合、同じエントリデータはレガシーのcanvas_entry_properties名前空間を使用します。ユーザーがキャンバスジャーニー内を移動する際に発生するイベントのプロパティはevent_propertiesと呼ばれます。
コンテキストとイベントプロパティの違いの概要については、以下の表を参照してください。
| コンテキストプロパティ | イベントプロパティ | |
|---|---|---|
| Liquid | context、またはダッシュボードにキャンバスエントリプロパティと表示されている場合はcanvas_entry_properties |
event_properties |
| 永続性 | キャンバスを使用して構築されたキャンバスの期間中、すべてのメッセージステップで参照できます。 | - 一度だけ参照できます。 - 後続のメッセージステップでは参照できません。 |
| キャンバスの動作 | キャンバスの任意のステップでcontextを参照できます。起動後の動作については、起動後のキャンバスの編集を参照してください。 |
- アクションパスステップの後の最初のメッセージステップでevent_propertiesを参照できます。ここでのアクションはカスタムイベントまたは購入イベントです。- アクションパスステップのその他全員パスの後では参照できません。 - アクションパスとメッセージステップの間に、メッセージ以外のコンポーネントを配置できます。これらのメッセージ以外のコンポーネントの1つがアクションパスステップの場合、ユーザーはそのステップのその他全員パスを通過できます。 |
オリジナルキャンバスエディターの詳細
オリジナルエディターを使用してキャンバスを作成または複製することはできなくなりました。キャンバスコンテキストはオリジナルキャンバスエディターではサポートされていないため、このセクションは以前のキャンバスワークフローでキャンバスエントリプロパティとイベントプロパティを使用する際の参照用として提供されています。
キャンバスエントリプロパティ:
- 永続的なエントリプロパティを有効にする必要があります。
- キャンバスの最初のフルステップでのみ
canvas_entry_propertiesを参照できます。キャンバスはアクションベースまたはAPIトリガーである必要があります。
エントリプロパティ:
- キャンバス内でアクションベースの配信を使用する任意のフルステップで
event_propertiesを参照できます。 - アクションベースのキャンバスの最初のフルステップ以外のスケジュールされたフルステップでは使用できません。ただし、ユーザーがキャンバスコンポーネントを使用している場合、動作は
event_propertiesの現在のキャンバスワークフロールールに従います。
イベントプロパティ:
- 先頭のメッセージステップでは
event_propertiesを使用できません。代わりに、canvas_entry_propertiesを使用するか、event_propertiesを含むメッセージステップの前に対応するイベントを持つアクションパスステップを追加する必要があります。
知っておくべきこと
- LiquidでContextを参照できます。ワークスペースでフィルターとしてコンテキスト変数が利用可能な場合、サポートされているキャンバスフィルターでもContextを使用できます。それ以外の場合は、イベントプロパティセグメンテーションを使用してください。
- アプリ内メッセージチャネルでは、キャンバスで
contextとevent_propertiesを参照できます。event_propertiesは、トリガーベースであるため、最初のキャンバスステップに含まれている場合にアクセスできます。 - リードメッセージステップでは
event_propertiesを使用できません。代わりに、contextを使用するか、event_propertiesを含むメッセージステップの前に対応するイベントを持つアクションパスステップを追加できます。 - アクションパスステップに「SMS受信メッセージを送信」または「WhatsApp受信メッセージを送信」トリガーが含まれている場合、後続のキャンバスステップにSMSまたはWhatsApp Liquidプロパティを含めることができます。これは、キャンバスでイベントプロパティが機能する方法と同じです。この方法で、メッセージを活用してファーストパーティデータをユーザープロファイルや会話型メッセージングに保存・参照できます。
オーディエンスの適格性は、キャンバスエントリ時に一度だけ評価されます。エントリ中にユーザーがマージされた場合、識別されたユーザーはキャンバスを通じて続行し、キャンバスセグメント基準に対して再評価されません。
タイムスタンプ
キャンバスのすべてのタイムスタンプはUTCに正規化されます。この動作を踏まえ、Brazeでは以下の例のようなLiquidタイムゾーンフィルターを使用して、希望するタイムゾーンでメッセージを送信することを強く推奨しています。
{{context.${timestamp_property} | time_zone: "America/Los_Angeles" | date: "%H:%M" }}
ユースケース
contextとevent_propertiesの違いをさらに理解するために、ユーザーがカスタムイベント「ウィッシュリストにアイテムを追加」を実行した場合にアクションベースのキャンバスに入るシナリオを考えてみましょう。
エントリデータはエントリスケジュールステップで設定され、ユーザーがキャンバスに入るタイミングに対応します。キャンバスコンテキストを持つワークスペースでは、このデータはcontextとして利用可能であり、任意のメッセージステップで参照できます。それ以外のワークスペースでは、ダッシュボードはこのデータをキャンバスエントリプロパティと表示し、canvas_entry_propertiesを使用します。
このキャンバスでは、ユーザーがウィッシュリストにアイテムを追加したかどうかを判定するアクションパスステップから始まるユーザージャーニーがあります。ここで、ユーザーがアイテムを追加した場合、ディレイを経てからメッセージステップの「ウィッシュリストに新しいアイテムがあります！」というメッセージを受け取ります。
ユーザージャーニーの最初のメッセージステップは、アクションパスステップからのカスタムevent_propertiesにアクセスできます。この場合、メッセージコンテンツの一部としてこのメッセージステップに{{event_properties.${property_name}}}を含めることができます。ユーザーがウィッシュリストにアイテムを追加しなかった場合、「その他全員」パスを通るため、event_propertiesは参照できず、無効な設定エラーが表示されます。
event_propertiesにアクセスできるのは、メッセージステップがアクションパスステップの「その他全員」以外のパスにさかのぼれる場合のみです。メッセージステップが「その他全員」パスに接続されていても、ユーザージャーニー内のアクションパスステップにさかのぼれる場合は、event_propertiesへのアクセスが引き続き可能です。これらの動作の詳細については、メッセージステップを参照してください。