キャンバスエントリのプロパティとイベントのプロパティ
この記事では、
canvas_entry_properties
とevent_properties
について、それぞれのプロパティを使用するタイミングや動作の違いなどを説明します。
カスタムイベントプロパティ全般については、「カスタムイベントプロパティ」を参照してください。
コンテキストコンポーネントのアーリーアクセス に参加している場合、Canvas エントリプロパティはCanvas コンテキスト変数の一部です。これは、canvas_entry_properties
がcontext
として参照されることを意味します。各context
変数には、名前、データ型、およびLiquid を含めることができる値が含まれます。
キャンバスエントリのプロパティとイベントプロパティは、キャンバスワークフロー内では機能が異なります。ユーザーがキャンバスに入るトリガーとなるイベントや API 呼び出しのプロパティは、canvas_entry_properties
と呼ばれます。ユーザーがキャンバスジャーニー内を移動する際に発生するイベントのプロパティは、event_properties
と呼ばれます。主な違いは、canvas_entry_properties
は、API トリガキャンバスのエントリペイロードのプロパティにアクセスすることによって、単なるイベント以上のものに焦点を当てます。
キャンバスエントリのプロパティとイベントのプロパティの違いの概要については、次の表を参照してください。
キャンバスエントリのプロパティ | イベントプロパティ | |
---|---|---|
Liquid | canvas_entry_properties |
event_properties |
永続性 | キャンバスフローを使用して構築されたキャンバスの期間中、すべてのメッセージステップから参照できる。 | - 1回のみ参照できます。 - 後続のメッセージステップからは参照できません。 |
元のキャンバスの動作 | - 永続エントリのプロパティがオンでなければなりません。 - キャンバスの最初のフルステップでのみ canvas_entry_properties を参照できます。キャンバスは、アクションベースまたは API トリガ-でなければなりません。 |
- キャンバスでアクションベースの配信を使用する任意のフルステップで event_properties を参照できます。- アクションベースのキャンバスの最初のフルステップを除いて、スケジュールされたフルステップでは使用できません。ただし、ユーザーがキャンバスコンポーネントを使用している場合、動作は event_properties のキャンバスフロールールに従います。 |
キャンバスフローの動作 | キャンバスのどのステップでもcanvas_entry_properties を参照できる。起動後の動作については、起動後のキャンバスの編集を参照してください。 |
- 行われたアクションがカスタムイベントまたは購入イベントである場合、アクションパスステップの後の最初のメッセージステップで event_properties を参照できます。- アクションパスステップの「その他のユーザー」パスの後に置くことはできません。 - アクションパスとメッセージステップの間に、メッセージ以外のキャンバスコンポーネントを置くことができます。これらのメッセージ以外のコンポーネントの 1 つがアクションパスのステップである場合、ユーザーはそのアクションパスの「その他のユーザー」パスをたどることができます。 |
元のCanvas エディタの詳細
2023 年 2 月 28 日以降、元のエディターを使用したキャンバスの作成や複製はできなくなりました。この記事は、元のキャンバスワークフローで canvas_entry_properties
や event_properties
を使用する際の参考として用意されています。
元のキャンバスエディターとキャンバスフローでは、リードメッセージのステップで event_properties
を使用することはできません。代わりに、canvas_entry_properties
を使用するか、event_properties
を含むメッセージステップの前に、対応するイベントを持つアクションパスステップを追加する必要があります。
知っておくべきこと
- キャンバスのエントリプロパティは、Liquid でのみ参照できます。キャンバス内のプロパティをフィルタリングするには、代わりにイベントプロパティのセグメンテーションを使用します。
- アプリ内メッセージチャネルの場合、
canvas_entry_properties
はキャンバスでのみ参照できます。event_properties
はアプリ内メッセージチャネルには使用できません。 event_properties
は先頭のメッセージステップで使用できません。代わりに、canvas_entry_properties
を使用するか、event_properties
を含むメッセージステップの前に、対応するイベントを持つアクションパスステップを追加する必要があります。- アクションパスステップに [SMS インバウンドメッセージを送信しました] または [WhatsApp インバウンドメッセージを送信しました] トリガーが含まれている場合、後続のキャンバスステップに SMS または WhatsApp Liquid プロパティを含めることができます。これは、キャンバスでのイベントプロパティの動作を反映します。こうすることで、メッセージを活用して、ユーザープロファイルや会話メッセージに関するファーストパーティデータを保存し、参照することができる。
イベントプロパティのタイムスタンプ
キャンバスでevent_properties
を使用している場合、タイムスタンプはUTC に正規化されます。ただし、以下で説明するいくつかの例外があります。この動作を考慮して、Braze は、メッセージが preferred timezone とともに送信されることを保証するために、次の例のような Liquid タイムゾーンフィルタを使用することを強くお勧めします。
1
{{canvas_entry_properties.${timestamp_property} | time_zone: "America/Los_Angeles" | date: "%H:%M" }
例外
- キャンバスの最初のステップがメッセージステップの場合、タイムスタンプはUTCに正規化されません。
- タイムスタンプは、キャンバス内の順序に関係なく、アプリ内メッセージチャネルを使用するメッセージステップではUTCに正規化されません。
ユースケース
canvas_entry_properties
とevent_properties
の違いをさらに理解するために、ユーザーが「ウィッシュリストにアイテムを追加」というカスタムイベントを実行すると、アクションベースのキャンバスに入るというシナリオを考えてみます。
canvas_entry_properties
は、キャンバスの作成時にエントリスケジュールステップで設定され、ユーザーがキャンバスに入るタイミングに対応します。キャンバスフローは永続的なエントリプロパティをサポートしているため、これらの canvas_entry_properties
は、キャンバスフローのどのメッセージステップでも参照できます。
このキャンバスには、ユーザーがウィッシュリストにアイテムを追加したかどうかを判断するアクションパスのステップから始まるユーザージャーニーがあります。ここから、ユーザーがアイテムを追加した場合、メッセージステップから「ウィッシュリストに新しいアイテムを追加しました」というメッセージを受け取る前に、遅延が発生します。
ユーザージャーニーの最初のメッセージステップは、アクションパスのステップからのカスタムの event_properties
にアクセスできます。この場合、このメッセージステップにメッセージ内容の一部として {{event_properties.${property_name}}}
を含めることができます。ユーザーがウィッシュリストにアイテムを追加しなかった場合、「その他のユーザー」パスを進みます。そのため、event_properties
を参照できず、無効な設定エラーが反映されます。
なお、event_properties
にアクセスできるのは、メッセージステップが、アクションパスステップの「その他のユーザー」以外のパスに遡ることができる場合のみです。メッセージステップが「その他のユーザー」パスに接続されていても、ユーザージャーニー内のアクションパスステップに遡ることができる場合には、event_properties
にアクセスすることが可能です。これらの動作の詳細については、メッセージステップを参照してください。