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