Acione campanhas usando APIs trigger-campaigns
Sobre campanhas acionadas por API about
Com Journey Optimizer, você pode criar campanhas e executá-las a partir de um sistema externo com base no gatilho do usuário usando a API REST de Execução de Mensagem Interativa. Isso permite cobrir várias necessidades de mensagens de marketing e transacionais, como redefinições de senha, token OTP, entre outras.
Para fazer isso, primeiro é necessário criar uma campanha acionada por API no Journey Optimizer e, em seguida, iniciar a execução por meio de uma chamada de API.
Os canais disponíveis para campanhas acionadas por API são mensagens de email, SMS e push.
➡️ Descubra este recurso no vídeo
Criar uma campanha acionada por API create
Configurar e ativar a campanha create-activate
Para criar uma campanha acionada por API, siga as etapas abaixo. Informações detalhadas sobre como criar uma campanha estão disponíveis em esta seção.
-
Crie uma nova campanha com o tipo acionado por API.
-
Escolha a categoria Marketing ou Transacional, dependendo do tipo de comunicação que você deseja enviar.
-
Escolha um dos canais com suporte e a configuração de canal associada a serem usados para enviar a mensagem e clique em Criar.
-
Especifique um título e uma descrição para a campanha e clique em Editar conteúdo para configurar a mensagem a ser enviada.
note note NOTE Você pode transmitir dados adicionais para a carga da API que você pode usar para personalizar sua mensagem. Saiba mais O uso de um grande número ou de dados contextuais pesados em seu conteúdo pode afetar o desempenho. -
Na seção Audience, especifique o namespace a ser usado para identificar os indivíduos.
-
Se você estiver criando uma campanha do tipo transacional, os perfis segmentados precisarão ser definidos na chamada de API. A opção Criar novos perfis permite criar automaticamente perfis que não existem no banco de dados. Saiba mais sobre a criação de perfil na execução da campanha
note note NOTE Uma única chamada de API suporta até 20 recipients únicos. Cada recipient deve ter uma ID de usuário exclusiva. IDs de usuário duplicadas não são permitidas. Saiba mais na Documentação da API de execução de mensagens interativas -
Para campanhas do tipo marketing, clique no botão Público-alvo para escolher o público-alvo a ser direcionado.
-
-
Configure as datas de início e término da campanha.
Se você configurar uma data de início e/ou término específica para uma campanha, ela não será executada fora dessas datas, e as chamadas de API falharão se a campanha for acionada por APIs.
-
Clique em Revisar para ativar para verificar se a campanha está configurada corretamente e, em seguida, ativá-la.
Agora você está pronto para executar a campanha das APIs. Saiba mais
Executar a campanha execute
Depois que sua campanha for ativada, é necessário recuperar a solicitação de cURL de amostra gerada e usá-la na API para criar sua carga e acionar a campanha.
-
Abra a campanha e copie e cole a solicitação de carga da seção cURL request. Essa carga inclui todas as variáveis de personalização (perfil e contexto) usadas na mensagem. Ele fica disponível assim que a campanha é ativada.
-
Use essa solicitação de cURL nas APIs para criar sua carga e acionar a campanha. Para obter mais informações, consulte a documentação da API de Execução de Mensagens Interativas.
Exemplos de chamadas de API também estão disponíveis em esta página.
note note NOTE Se você tiver configurado uma data de início e/ou término específica ao criar a campanha, ela não será executada fora dessas datas e as chamadas de API falharão.
Usar atributos contextuais em campanhas acionadas por API contextual
Com campanhas acionadas por API, você pode transmitir dados adicionais na carga da API e usá-los na campanha para personalizar sua mensagem.
Vejamos este exemplo, em que os clientes desejam redefinir suas senhas e você deseja enviar a eles um URL de redefinição de senha gerado em uma ferramenta de terceiros. Com campanhas acionadas por API, é possível passar esse URL gerado para a carga da API e aproveitá-lo na campanha para adicioná-lo à mensagem.
Para usar esses dados em suas campanhas, você precisa passá-los para a carga da API e adicioná-los em sua mensagem usando o editor de personalização. Para fazer isso, use a sintaxe {{context.<contextualAttribute>}}, em que <contextualAttribute> deve corresponder ao nome da variável na carga da API que contém os dados que você deseja passar.
A sintaxe {{context.<contextualAttribute>}} está mapeada somente para um tipo de dados String.
context.system está restrita somente ao uso interno de Adobe e não deve ser usada para transmitir atributos contextuais.Observe que, por enquanto, nenhum atributo contextual está disponível para uso no menu do painel esquerdo. Os atributos devem ser digitados diretamente na sua expressão de personalização, sem que nenhuma verificação seja executada por Journey Optimizer.
Criação de perfil na execução da campanha profile-creation
Em alguns casos, pode ser necessário enviar mensagens transacionais para perfis que não existem no sistema. Por exemplo, se um usuário desconhecido tentar redefinir a senha no seu site.
Quando um perfil não existe no banco de dados, o Journey Optimizer permite que você o crie automaticamente ao executar a campanha para permitir o envio da mensagem para esse perfil.
Para ativar a criação de perfil na execução da campanha, alterne a opção Criar novos perfis na seção Público. Se essa opção estiver desativada, perfis desconhecidos serão rejeitados para qualquer envio e a chamada à API falhará.
Vídeo tutorial video
Saiba como criar uma campanha e acioná-la a partir de um sistema externo com base em interações do usuário, usando a API REST de execução de mensagem interativa.