Shopifyの注文メタフィールド
Shopify 標準インテグレーションを使用すると、選択した注文メタフィールドを注文イベントに追加できます。注文メタフィールドには、ギフトメッセージやフルフィルメントの希望など、注文に関する独自のデータが保持されます。
最大 20 個の注文メタフィールド定義を選択できます。Brazeは選択された定義をサポート対象の Shopify 注文イベントに書き込むため、セグメンテーションやパーソナライゼーションに使用できます。
注文メタフィールドがイベントにどのように表示されるか
選択した各メタフィールドは、イベントの metadata オブジェクトに <namespace>_<key> として、metadata.tags などのフィールドと並んで追加されます。たとえば、Shopifyの定義 custom.gift_note は metadata.custom_gift_note として表示されます。
{
"metadata": {
"order_number": "1234",
"tags": ["heavy", "heavy2"],
"custom_gift_note": "Happy birthday!"
}
}
注文タグは変更されません。Brazeは引き続きすべてのタグをイベントで送信します。空のメタフィールド値は省略されます。
サポートされている注文メタフィールドのタイプ
ピッカーには、以下のタイプの定義のみが表示されます。参照、ファイル、JSON、金額、評価は選択できません。
| Shopifyのタイプ | イベントでの保存形式 |
|---|---|
| 単一行テキスト、複数行テキスト、色、URL、ID | 文字列 |
| 整数 | 整数 |
| 小数 | 数値 |
| 真または偽 | ブール値 |
| 日付、日付と時刻 | UTCの ISO 8601 文字列。時刻のない日付は UTCの午前 0 時になります。 |
| 単一行テキスト、日付、日付と時刻、色、ID、または URL のリスト | 文字列の配列 |
次の場合、Brazeはイベントから値を省略します。
- 文字列値、またはリスト内の項目が 255 文字を超える場合。
- 値を定義のタイプに変換できない場合 (整数フィールドにテキストが含まれる場合など)。
- キー (
<namespace>_<key>) が 255 文字を超える場合、または$や.を含む場合。 - キーが、
order_numberや Shopify Markets のフィールドなど、Brazeがすでにイベントに書き込んでいるプロパティと重複する場合。
サポートされているイベント
以下のイベントでは、選択した注文メタフィールドが metadata に含まれます。
- 注文確定 (
ecommerce.order_placed) - 注文キャンセル (
ecommerce.order_cancelled) shopify_paid_ordershopify_fulfilled_ordershopify_partially_fulfilled_order
注文返金 (ecommerce.order_refunded) とチェックアウトイベントには、注文メタフィールドは含まれません。
Brazeが注文メタフィールドを含めるタイミング
| ソース | 説明 |
|---|---|
| Shopifyの注文 Webhook | 値は、Shopifyが注文 Webhookを送信した時点のメタフィールドのスナップショットです。送信後にイベントが書き換えられることはありません。 |
| 履歴データのバックフィル | 初期設定時に注文メタフィールドを選択し、履歴データのバックフィルがオンになっている場合、バックフィルされた注文には選択したメタフィールドが含まれます。 |
選択内容の変更は、変更後に届いた注文にのみ適用されます。過去の注文は再同期されません。
メタフィールドの変更または削除
- インテグレーションページで、設定を編集を選択します。
- Shopify データを追跡ステップで、追加の注文イベント設定を表示を開きます。
- 注文メタフィールドを注文イベントに追加を更新します。チェックボックスをオフにすると、選択内容がクリアされます。
Shopifyで定義を削除すると、Brazeは選択内容からその定義を自動的に削除します。すでに送信されたイベントの値はそのまま保持されます。
セグメンテーションとパーソナライゼーション
注文メタフィールドの値は、タグと同じく metadata 配下のイベントプロパティであるため、現在 metadata.tags を使用しているのと同じ方法で使用できます。たとえば、{{event_properties.${metadata}.custom_gift_note}} は、この記事の custom.gift_note の例では Happy birthday! を返します。