キャンバスエントリのプロパティとイベントのプロパティ

この記事では、canvas_entry_properties と event_properties について、それぞれのプロパティを使用するタイミングや動作の違いなどを説明します。

キャンバスエントリのプロパティとイベントプロパティは、キャンバスワークフロー内では機能が異なります。ユーザーがキャンバスに入るトリガーとなるイベントや API 呼び出しのプロパティは、canvas_entry_properties と呼ばれます。ユーザーがキャンバスジャーニー内を移動する際に発生するイベントのプロパティは、event_properties と呼ばれます。ここでの重要な違いは、canvas_entry_properties は、API でトリガーされるキャンバスのエントリペイロードのプロパティにもアクセスすることにより、イベント以上のものに焦点を当てていることです。

元のキャンバスエディターとキャンバスフローでは、リードメッセージのステップで event_properties を使用することはできません。代わりに、canvas_entry_properties を使用するか、event_properties を含むメッセージステップの前に、対応するイベントを持つアクションパスステップを追加する必要があります。

また、キャンバスフローで構築されたワークフローと元のエディターでは、動作も異なります。例えば、元のキャンバスエディターでは、アクションベースのステップであれば、最初のフルステップで event_properties を使用できます。キャンバスフローの場合、フルステップはサポートされていないので、該当しません。

canvas_entry_properties と event_properties の相違点については、以下の表を参照してください。

	キャンバスエントリのプロパティ	イベントのプロパティ
Liquid	canvas_entry_properties	event_properties
永続性	キャンバスフローを使用して構築されたキャンバスの期間中、すべてのメッセージステップから参照できます。	- 参照できるのは 1 回だけです。 - 後続のメッセージステップからは参照できません。
元のキャンバス動作	- 永続エントリのプロパティがオンでなければなりません。 - キャンバスの最初のフルステップでのみ canvas_entry_properties を参照できます。アクションベースか API トリガーのキャンバスでなければなりません。	- キャンバスのアクションベースの配信を使用する任意のフルステップで event_properties を参照できます。 - アクションベースのキャンバスの最初のフルステップを除いて、スケジュールされたフルステップでは使用できません。ただし、ユーザーがキャンバスコンポーネントを使用している場合、動作は event_properties のキャンバスフロールールに従います。
キャンバスフローの動作	キャンバスのどのステップでも canvas_entry_properties を参照できます。	- 行われたアクションがカスタムイベントまたは購入イベントである場合、アクションパスステップの後の最初のメッセージステップで event_properties を参照できます。 - アクションパスステップの「その他のユーザー」パスの後に置くことはできません。 - アクションパスとメッセージステップの間に、メッセージ以外のキャンバスコンポーネントを置くことができます。これらのメッセージ以外のコンポーネントの 1 つがアクションパスのステップである場合、ユーザーはそのアクションパスの「その他のユーザー」パスをたどることができます。

キャンバスエントリのプロパティは Liquid 内でのみ参照できることに注意してください。キャンバス内のプロパティをフィルタリングするには、代わりにイベントプロパティのセグメンテーションを使用します。

例

canvas_entry_properties とevent_properties の違いをさらに理解するために、ユーザーが「ウィッシュリストにアイテムを追加」というカスタムイベントを実行すると、アクションベースのキャンバスに入るというシナリオを考えてみます。

canvas_entry_properties は、キャンバスの作成時にエントリスケジュールステップで設定され、ユーザーがキャンバスに入るタイミングに対応します。キャンバスフローは永続的なエントリプロパティをサポートしているため、これらの canvas_entry_properties は、キャンバスフローのどのメッセージステップでも参照できます。

このキャンバスには、ユーザーがウィッシュリストにアイテムを追加したかどうかを判断するアクションパスのステップから始まるユーザージャーニーがあります。ここから、ユーザーがアイテムを追加した場合、メッセージステップから「ウィッシュリストに新しいアイテムを追加しました」というメッセージを受け取る前に、遅延が発生します。

ユーザージャーニーの最初のメッセージステップは、アクションパスのステップからのカスタムの event_properties にアクセスできます。この場合、このメッセージステップにメッセージ内容の一部として {{event_properties.${property_name}}} を含めることができます。ユーザーがウィッシュリストにアイテムを追加しなかった場合、「その他のユーザー」パスを進みます。そのため、event_properties を参照できず、無効な設定エラーが反映されます。

なお、event_properties にアクセスできるのは、メッセージステップが、アクションパスステップの「その他のユーザー」以外のパスに遡ることができる場合のみです。メッセージステップが「その他のユーザー」パスに接続されていても、ユーザージャーニー内のアクションパスステップに遡ることができる場合には、event_properties にアクセスすることが可能です。これらの動作の詳細については、メッセージステップ をご覧ください。