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

この記事では、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
永続性	キャンバスフローを使用して構築されたキャンバスの期間中、すべてのメッセージステップから参照できる。	- 一度しか参照できない。 - 後続のMessageステップからは参照できない。
オリジナル・キャンバスの振る舞い	- 永続的エントリーのプロパティをオンにしておく必要がある。 - キャンバスの最初のフルステップでのみ canvas_entry_properties を参照できます。キャンバスはアクションベースかAPIトリガーでなければならない。	- キャンバスでアクションベースのデリバリーを使用するフルステップでは、event_properties を参照できる。 - アクションベースのキャンバスの最初のフルステップを除いて、スケジュールされたフルステップでは使用できません。ただし、ユーザーがCanvasコンポーネントを使用している場合、動作はevent_properties のCanvas Flowルールに従う。
キャンバスフローの動作	キャンバスのどのステップでもcanvas_entry_properties を参照できる。	- アクション・パス・ステップの後の最初のメッセージ・ステップで、event_properties を参照することができる。 - アクションパスステップの「その他のユーザー」パスの後に置くことはできません。 - アクションパスとメッセージステップの間に、メッセージ以外のキャンバスコンポーネントを置くことができます。これらの非メッセージコンポーネントの1つがアクションパスのステップである場合、ユーザーはそのアクションパスのEveryone Elseパスを通ることができる。

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

アクションパスのステップが “Sent an SMS Inbound Message “または “Sent a WhatsApp Inbound Message “トリガーを含むとき、後続のキャンバスステップはSMSまたはWhatsApp Liquidプロパティを含むことができる。これは、Canvas Flowにおけるイベントプロパティの動作を反映している。こうすることで、メッセージを活用して、ユーザープロファイルや会話メッセージに関するファーストパーティデータを保存し、参照することができる。

ユースケース

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

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

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

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

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