Skip to content

Campanhas da API

Este artigo de referência aborda como gerar um campaign_id para incluir em suas chamadas de API e como configurar essa campanha.

As campanhas da API são normalmente usadas para envio de mensagens transacionais. Ao criar campanhas da API (não campanhas disparadas por API), o dashboard da Braze é usado apenas para gerar um campaign_id, que permite rastrear a análise de dados para relatórios de campanha. Também é possível gerar um ID de variação de mensagem, que é diferente para cada variante da sua campanha.

Envie essas informações à sua equipe de desenvolvimento para serem usadas na solicitação da API, juntamente com:

  • Cópia da campanha
  • Participação do público
  • Ativos

Após o início da campanha, você pode visualizar os resultados no dashboard. As campanhas da API usam as APIs de envio de mensagens da Braze, que têm as mesmas opções detalhadas de relatórios e redirecionamento que as campanhas criadas completamente por meio do dashboard.

Como as campanhas da API sempre incluem um campaign_id, seus envios são refletidos nas estatísticas do dashboard. Se você chamar /messages/send sem um campaign_id, a Braze não incrementa essas métricas — os envios ainda aparecem no Registro de atividade de mensagens, mas não nas métricas de desempenho de e-mail no dashboard.

Criar uma nova campanha

Acesse Messaging > Campaigns e selecione Create Campaign, depois selecione API Campaigns. Agora, você pode prosseguir com a configuração da sua campanha de API.

Uma campanha disparada por API é diferente de uma campanha de API.

Configure sua campanha

Para configurar sua campanha, siga as etapas a seguir:

  1. Adicione um título descritivo para que você possa encontrar os resultados na página de Campaigns após enviar suas mensagens.
  2. Selecione Add Message e adicione os tipos de mensagem incluídos na sua campanha de API. Isso permite gerar um campaign_id e um ID de variação de mensagem, que é diferente para cada canal incluído.
  3. Opcionalmente, você pode adicionar um evento de conversão para rastrear conversões de usuários em uma ação ou meta de campanha específica.
  4. Selecione Save Campaign para iniciar sua campanha de API.

Chamadas de API

Após salvar sua Campaign de API, inclua o seguinte na sua solicitação de API:

  • Os campos campaign_id gerados na sua solicitação de API, conforme indicado nos Endpoints de envio de mensagens.
  • Um objeto de mensagem para cada plataforma incluída na Campaign. No objeto de mensagem, forneça o ID da variante da mensagem. Isso especifica que as estatísticas devem ser coletadas e exibidas nessa variante. Os seguintes objetos de mensagem são compatíveis: Android, Content Cards, e-mail, iOS, Kindle, SMS/MMS, web push e webhook.

Adicionar cancelamento de inscrição em um clique via lista a Campaigns de API

Por padrão, a Braze não adiciona o cabeçalho de cancelamento de inscrição em um clique via lista a Campaigns de API. Você pode adicionar esse cabeçalho a envios individuais de Campaigns de API incluindo a Liquid tag {{${set_user_to_one_click_list_unsubscribe}}} no campo de cabeçalhos de e-mail da sua solicitação de API.

Para estar em conformidade com a RFC 8058 para cancelamento de inscrição em um clique via lista, inclua os cabeçalhos List-Unsubscribe e List-Unsubscribe-Post na sua solicitação de API:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "external_user_ids": ["user_id"],
  "messages": {
    "email": {
      "app_id": "your_app_id",
      "subject": "Your Subject",
      "from": "Sender Name <[email protected]>",
      "body": "<p>Email body content</p>",
      "headers": {
        "List-Unsubscribe": "<{{${set_user_to_one_click_list_unsubscribe}}}>",
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
      }
    }
  }
}

Adicionar anexos de e-mail

Para adicionar anexos a e-mails de Campaigns de API, inclua um array attachments no objeto de e-mail. Você pode fazer referência a um modelo de e-mail criado no editor de arrastar e soltar ou no editor de HTML fornecendo o email_template_id no objeto de e-mail e, em seguida, adicionar anexos por meio da chamada de API.

Para detalhes sobre anexos, limites de tamanho e práticas recomendadas, consulte Exemplo de objeto de e-mail com anexo.
New Stuff!