このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。

購入オブジェクト

この記事では、購入オブジェクトのさまざまなコンポーネント、正しい使用方法、ベストプラクティス、参考となる例について説明します。

重要

レガシーの購入イベントはメンテナンスモードに移行します。既存のBrazeのお客様は、レガシーの購入イベントを引き続き使用できます。購入イベントは引き続き期待どおりに動作しますが、今後はeコマース推奨イベントを基盤として新しい機能が構築されます。Brazeは、サポート終了日が設定されるかなり前に事前通知を行います。新規のBrazeのお客様は、eコマース推奨イベントを使用してください。レガシーの購入イベントは利用できません。

購入オブジェクトとは何ですか？

購入オブジェクトは、購入が発生したときに API を介して渡されるオブジェクトです。各購入オブジェクトは購入配列内に配置され、各オブジェクトは特定のユーザーによる特定の時刻の1回の購入を表します。購入オブジェクトには多くのフィールドがあり、Braze のバックエンドはこれらの情報を保存して、カスタマイズ、データ収集、パーソナライゼーションに使用できます。

オブジェクト本文

{
  // One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required.
  "external_id" : (optional, string) External user ID,
  "user_alias" : (optional, User Alias Object) User alias object,
  "braze_id" : (optional, string) Braze user identifier,
  "email": (optional, string) User email address,
  "phone": (optional, string) User phone number,
  "app_id" : (optional, string) see App Identifier,
  // See the following product_id naming conventions for clarification.
  "product_id" : (required, string) identifier for the purchase, for example, Product Name or Product Category,
  "currency" : (required, string) ISO 4217 Alphabetic Currency Code,
  //Revenue from a purchase object is calculated as the product of quantity and price.
  "price" : (required, float) value in the base currency unit (for example, Dollars for USD, Yen for JPY),
  "quantity" : (optional, integer) the quantity purchased (defaults to 1, must be <= 100 -- currently, Braze treats a quantity _X_ as _X_ separate purchases with quantity 1),
  "time" : (required, datetime as string in ISO 8601) Time of purchase,
  // See the following purchase object explanation for clarification.
  "properties" : (optional, Properties Object) properties of the event,
  // Setting this flag to true puts the API in "Update Only" mode.
  // When using a "user_alias", "Update Only" mode is always true.
  "_update_existing_only" : (optional, boolean)
}

注

タイムスタンプが未来の日時になっている購入は、デフォルトで現在時刻に設定されます。これにより、購入イベントが正確なタイミングで記録されます。

注

一部の識別子の組み合わせは同時に使用できません。また、email と phone の両方が指定された場合は email が優先されます。詳細については、識別子の解決を参照してください。

購入の製品 ID

購入オブジェクト内の product_id は、購入の識別子です（Product Name や Product Category など）。

Brazeでは、ダッシュボードに最大5,000個の product_id を保存できます。
product_id は最大255文字まで指定できます。

命名規則

Brazeでは、購入オブジェクトの product_id について、いくつかの一般的な命名規則を提供しています。product_id を選ぶ際は、記録されたすべてのアイテムをこの product_id でグループ化できるよう、SKU ではなく製品名や製品カテゴリーなどのシンプルな名前を使用することをお勧めします。

これにより、セグメンテーションやトリガーで製品を識別しやすくなります。

注文レベルで購入を記録する

製品レベルではなく注文レベルで購入を記録したい場合は、注文名や注文カテゴリーを product_id として使用できます（Online Order や Completed Order など）。

たとえば、Web SDKで注文レベルの購入を記録するには、次のようにします。

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "purchases" : [
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "Completed Order",
      "currency" : "USD",
      "price" : 219.98,
      "time" : "2013-07-16T19:20:30+01:00",
      "properties" : {
        "products" : [ { "name": "Monitor", "category": "Gaming", "product_amount": 19.99, },
        { "name": "Gaming Keyboard", "category": "Gaming ", "product_amount": 199.99, }
        ]
      }
    }
  ]
}

購入プロパティオブジェクト

購入プロパティは、親となる購入イベントによってトリガーされるメッセージでのフィルタリングやLiquidパーソナライゼーションのために設計されています。デフォルトでは、Brazeのユーザープロファイルには保持されません。購入プロパティの値をセグメンテーションに使用するには、イベントプロパティのセグメンテーションを参照してください。この機能では、最大30日間のルックバック期間にわたって値がユーザープロファイルに保存されます。

The properties values must be an object up to 50 KB where the keys are the property names and the values are the property values. Property names must be strings, 255 characters or fewer, with no leading dollar signs ($).

Property values can be any of the following data types:

Data type	Description
Number	Integer or float
Boolean	Value `true` or `false`
Datetime	String in ISO 8601 or `yyyy-MM-dd'T'HH:mm:ss:SSSZ` format. Not supported within arrays.
String	255 characters or fewer
Array	Supported; datetimes are not supported within arrays.
Object	Ingested as strings (not nested objects). For nested data, use a string value (for example, JSON serialized).

The following keys are reserved and cannot be used as property names: time, product_id, quantity, event_name, price, and currency. Using a reserved key in the properties object returns the error “Invalid ‘properties’ field”.

カスタム属性、イベントプロパティ、カタログにわたるデータタイプの統合リファレンスについては、データタイプを参照してください。

購入プロパティ

購入プロパティは、メッセージのトリガーやLiquidを使用したパーソナライゼーションに使用でき、これらのプロパティに基づいてセグメント化することもできます。

注

When you view segmentable purchase properties in Data Settings > Products, the list displays property keys (names such as “color” or “brand”), not the actual property values (such as “red” or “Nike”).

命名規則

この機能は購入ごとではなく、製品ごとに有効になることに注意してください。たとえば、個別の製品が大量にあっても、それぞれのプロパティが同じである場合、セグメント化は必要ない場合があります。

この場合、データ構造を設定する際に、トランザクションレベルの識別子ではなく「グループレベル」で製品名を使用することをお勧めします。たとえば、鉄道チケット会社では、「片道」、「往復」、「複数都市」といった製品を用意すべきであり、「取引123」や「取引046」などの特定の取引にすべきではありません。別の例として、「食べ物」の購入イベントでは、プロパティは「ケーキ」や「サンドイッチ」に設定するのが最適です。

重要

製品はBraze REST APIを使用して追加できます。たとえば、/users/trackエンドポイントにコールを送信し、新しい購入IDを含めると、Brazeはダッシュボードのデータ設定 > 製品セクションに自動的に製品を作成します。

購入オブジェクトの例

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "purchases" : [
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "backpack",
      "currency" : "USD",
      "price" : 40.00,
      "time" : "2013-07-16T19:20:30+01:00",
      "properties" : {
        "color" : "red",
        "monogram" : "ABC",
        "checkout_duration" : 180,
        "size" : "Large",
        "brand" : "Backpack Locker"
      }
    },
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "pencil",
      "currency" : "USD",
      "price" : 2.00,
      "time" : "2013-07-17T19:20:20+01:00",
      "properties" : {
        "number" : 2,
        "sharpened" : true
      }
    },
    {
      "user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "pen",
      "currency" : "USD",
      "price" : 2.50,
      "time" : "2013-07-17T19:20:20+01:00",
      "properties" : {
        "color" : "blue",
      }
    }
  ]
}

購入オブジェクト、イベントオブジェクト、およびWebhook

この例から、誰かが色、モノグラム、チェックアウト時間、サイズ、ブランドのプロパティを持つバックパックを購入したことがわかります。次に、購入イベントプロパティを使用してこれらのプロパティでセグメントを作成したり、Liquidを使用してチャネル経由でカスタムメッセージを送信したりできます。たとえば、「こんにちは Ann F. さん、赤のミディアムバックパックを $40.00 でご購入いただきありがとうございます！Backpack Locker でのお買い物ありがとうございました！」のようなメッセージです。

プロパティを保存、保管、追跡してセグメント化に使用したい場合は、それらをカスタム属性として設定する必要があります。これはセグメントエクステンションを使用して行うことができます。セグメントエクステンションでは、そのユーザープロファイルの存続期間中保存されるカスタムイベントや購入行動に基づいてユーザーをターゲットにできます。

New Stuff!