Objeto de propriedades do gatilho

Ao usar um dos endpoints para enviar uma Campaign com entrega disparada por API, você pode fornecer um mapa de chaves e valores para personalizar sua mensagem.

Se você fizer uma solicitação de API que contenha um objeto em trigger_properties, os valores desse objeto poderão ser referenciados no seu modelo de mensagem no namespace api_trigger_properties. Por exemplo, uma solicitação como a seguinte poderia adicionar a palavra "shoes" a uma mensagem, incluindo {{api_trigger_properties.${product_name}}}.

Observe que, embora as propriedades de gatilho possam ser usadas como modelo em mensagens, elas não são armazenadas automaticamente no perfil do usuário por padrão.

Nota

O objeto trigger_properties e a sintaxe api_trigger_properties.${product_name} são compatíveis apenas com Campaigns. Para personalizar mensagens com chaves e valores de uma solicitação de gatilho de API para o Canvas, use o objeto de propriedades de entrada do Canvas. O objeto trigger_properties tem um limite máximo de tamanho de 50 KB.

Corpo do objeto

O objeto trigger_properties suporta strings, números, booleanos, datas, objetos e vetores como tipos de dados.

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

Exemplos de modelos Liquid

Referencie propriedades de disparo nos seus modelos de mensagem usando o namespace api_trigger_properties:

• Strings: {{api_trigger_properties.${product_name}}} retorna "shoes"
• Números: {{api_trigger_properties.${product_price}}} retorna 79.99
• Objetos aninhados: {{api_trigger_properties.${details}.${color}}} retorna "red"
• Elementos de vetor: {{api_trigger_properties.${related_skus}[0]}} retorna "123"
• Vetores de objeto complexos: {{api_trigger_properties.${line_items}[0]}} retorna o primeiro objeto de item de linha