Skip to content

トリガープロパティオブジェクト

APIトリガー配信でキャンペーンを送信するためにエンドポイントの1つを使用する場合、メッセージをカスタマイズするためにキーと値のマップを提供できます。

trigger_propertiesのオブジェクトを含むAPIリクエストを行った場合、そのオブジェクトの値は、api_trigger_properties名前空間の下のメッセージテンプレートで参照できます。例えば、以下のようなリクエストでは、{{api_trigger_properties.${product_name}}}を追加することで、メッセージに"shoes"という単語を追加できます。

トリガープロパティはメッセージにテンプレート化できますが、デフォルトではユーザープロファイルに自動的には保存されないことに注意してください。

オブジェクト本文

trigger_properties オブジェクトは、データ型として文字列、数値、ブール値、日付、オブジェクト、および配列をサポートしています。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "trigger_properties" : {
    "product_name" : "shoes",
    "product_price" : 79.99,
    "details" : {
      "color" : "red",
      "size" : {
        "numerical" : 10,
        "country" : "US"
      }
    },
    "related_skus": ["123", "456", "789"],
    "line_items": [
      {
        "sku": "WH-9000",
        "name": "Wireless Headphones",
        "quantity": 1,
        "pricing": {
          "amount": 79.99,
          "currency": "USD"
        }
      },
      {
        "sku": "RS-450",
        "name": "Running Shoes",
        "quantity": 2,
        "pricing": {
          "amount": 129.99,
          "currency": "USD"
        }
      }
    ]
  }
}

Liquidテンプレートの例

api_trigger_properties名前空間を使用して、メッセージテンプレート内でトリガープロパティを参照できます。

  • 文字列: {{api_trigger_properties.${product_name}}}"shoes"を返します
  • 数値: {{api_trigger_properties.${product_price}}}79.99を返します
  • ネストされたオブジェクト: {{api_trigger_properties.${details}.${color}}}"red"を返します
  • 配列要素: {{api_trigger_properties.${related_skus}[0]}}"123"を返します
  • 複合オブジェクト配列: {{api_trigger_properties.${line_items}[0]}} は最初のラインアイテムオブジェクトを返します
New Stuff!