Como os atributos de Campaign e Canvas diferem entre as fontes na Braze
Nomes e IDs de Campaign, Canvas e etapa do Canvas estão disponíveis no Liquid, na REST API e no Currents. Esses atributos mapeiam o mesmo valor em todas as três fontes, mas podem ter nomes diferentes. Esta página tem o objetivo de ajudar você a fazer conexões entre os três.
Casos de uso
Liquid
Os atributos de Campaign e Canvas estão disponíveis como Liquid tags no dashboard (como {{campaign.${api_id}}}). Você pode usar Liquid para passar esses atributos na própria mensagem, em uma chamada de Conteúdo conectado ou como pares de chave-valor. Isso geralmente é feito para fins de rastreamento.
REST API
Os atributos de Campaign e Canvas também estão disponíveis no endpoint Exportar detalhes da campanha ou no endpoint Exportar detalhes do Canvas. Você pode usar a REST API para criar mapeamentos — ou seja, uma lista de todos os nomes de Canvas e seus IDs correspondentes.
Currents
Os atributos de Campaign e Canvas estão vinculados a eventos de engajamento com mensagem do Currents. Observe que apenas etapas de Mensagem têm acesso aos atributos de Campaign, e as demais etapas do Canvas têm acesso apenas aos atributos de Canvas. Isso é importante para que você possa determinar a qual Campaign ou componente do Canvas um envio de push ou abertura de e-mail está associado.
Atributos de Campaign
| Atributo | Liquid | REST API | Currents |
|---|---|---|---|
| Nome da Campaign | {{campaign.${name}}} |
name |
campaign_name |
| ID da Campaign | {{campaign.${api_id}}} |
N/A (usado como entrada para a própria chamada da API) | campaign_id |
| Nome da variante | {{campaign.${message_name}}} |
messages.message_variation_id.name |
N/A (mapeie o nome da variante para o ID da variante usando o endpoint Exportar detalhes da campanha) |
| ID da variante | {{campaign.${message_api_id}}} |
messages.message_variation_id |
message_variation_api_id |
Atributos do Canvas
| Atributo | Liquid | REST API | Currents |
|---|---|---|---|
| Nome do Canvas | {{canvas.${name}}} |
name |
canvas_name |
| ID do Canvas | {{canvas.${api_id}}} |
N/A (usado como entrada para a própria chamada da API) | canvas_id |
| Nome da variante | {{canvas.${variant_name}}} |
variants.name |
canvas_variation_name |
| ID da variante | {{canvas.${variant_api_id}}} |
variants.name.id |
canvas_variation_id |
| Nome da etapa (apenas para etapas de Mensagem) | {{campaign.${name}}} |
steps.name |
canvas_step_name |
| ID da etapa | {{campaign.${api_id}}} |
steps.id |
canvas_step_id |
| Canal de mensagem | N/A | steps.messages.message_variation_id.channel |
N/A (inerente ao tipo de evento, como envio de push ou abertura de e-mail) |
| ID da mensagem | {{campaign.${message_api_id}}} |
steps.message.message_variation_id |
canvas_step_message_variation_api_id |