Objeto de propiedades de activación

Cuando utilices uno de los puntos de conexión para enviar una Campaign con entrega desencadenada por API, puedes proporcionar un mapeado de claves y valores para personalizar tu mensaje.

Si realizas una solicitud a la API que contenga un objeto en trigger_properties, los valores de ese objeto pueden referenciarse en tu plantilla de mensajes bajo el espacio de nombres api_trigger_properties. Por ejemplo, una solicitud con lo siguiente podría añadir la palabra "shoes" a un mensaje añadiendo {{api_trigger_properties.${product_name}}}.

Ten en cuenta que, aunque las propiedades de activación pueden incluirse en plantillas de mensajes, no se almacenan automáticamente en el perfil de usuario de forma predeterminada.

Nota

El objeto trigger_properties y la sintaxis api_trigger_properties.${product_name} solo se admiten en Campaigns. Para personalizar mensajes con claves y valores de una solicitud de activación de API para Canvas, utiliza el objeto de propiedades de entrada de Canvas. El objeto trigger_properties tiene un límite de tamaño máximo de 50 KB.

Cuerpo del objeto

El objeto trigger_properties admite cadenas, números, booleanos, fechas, objetos y matrices como tipos de datos.

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"
        }
      }
    ]
  }
}

Ejemplos de plantillas Liquid

Haz referencia a las propiedades de desencadenamiento en tus plantillas de mensaje usando el espacio de nombres api_trigger_properties:

• Cadenas: {{api_trigger_properties.${product_name}}} devuelve "shoes"
• Números: {{api_trigger_properties.${product_price}}} devuelve 79.99
• Objetos anidados: {{api_trigger_properties.${details}.${color}}} devuelve "red"
• Elementos de matriz: {{api_trigger_properties.${related_skus}[0]}} devuelve "123"
• Matrices de objetos complejas: {{api_trigger_properties.${line_items}[0]}} devuelve el primer objeto de línea de pedido