DocumentaçãoCampaignDocumentação do Campaign Standard

Caso de uso use-case

Last update: Fri Jul 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Intermediário
  • Desenvolvedor

O caso de uso abaixo mostra como chamar o workflow com parâmetros dentro dos workflows.

O objetivo é acionar um workflow a partir de uma chamada à API com parâmetros externos. Esse fluxo de trabalho carregará dados em seu banco de dados a partir de um arquivo e criará um público-alvo associado. Depois que o público-alvo for criado, um segundo workflow será acionado para enviar uma mensagem personalizada com os parâmetros externos definidos na chamada de API.

Para executar esse caso de uso, é necessário executar as ações abaixo:

  1. Fazer uma chamada de API para acionar o Fluxo de Trabalho 1 com parâmetros externos. Consulte Etapa 1: configuração da chamada de API.
  2. Fluxo de trabalho de compilação 1: o fluxo de trabalho transferirá um arquivo e o carregará no banco de dados. Em seguida, ele testará se os dados estão vazios ou não e eventualmente salvará os perfis em um público-alvo. Por fim, ele acionará o Workflow 2. Consulte Etapa 2: Configuração do Fluxo de Trabalho 1.
  3. Criar Fluxo de Trabalho 2: o fluxo de trabalho lerá o público-alvo criado no Fluxo de Trabalho 1 e enviará uma mensagem personalizada para os perfis, com um código de segmento personalizado com os parâmetros. Consulte Etapa 3: Configuração do Fluxo de Trabalho 2.

Pré-requisitos prerequisites

Antes de configurar os fluxos de trabalho, é necessário criar o Fluxo de trabalho 1 e 2 com uma atividade External signal em cada um deles. Dessa forma, você poderá direcionar essas atividades de sinal ao chamar os workflows.

Etapa 1: configuração da chamada de API step-1--configuring-the-api-call

Faça uma chamada de API para acionar o Fluxo de trabalho 1 com parâmetros. Para obter mais informações sobre a sintaxe de chamada da API, consulte a documentação das APIs REST do Campaign Standard.

No nosso caso, queremos chamar o workflow com os parâmetros abaixo:

  • fileToTarget: o nome do arquivo que queremos importar para o banco de dados.
  • discountDesc: a descrição que queremos exibir na entrega do desconto.
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/<TRIGGER_URL>
-H 'Authorization: Bearer <ACCESS_TOKEN>'
-H 'Cache-Control: no-cache'
-H 'X-Api-Key: <API_KEY>'
-H 'Content-Type: application/json;charset=utf-8'
-H 'Content-Length:79'
-i
-d {
-d "source:":"API",
-d "parameters":{
-d "fileToTarget":"profile.txt",
-d "discountDesc":"Running shoes"
-d }

Etapa 2: configuração do workflow 1 step-2--configuring-workflow-1

O fluxo de trabalho 1 será criado conforme abaixo:

  • Atividade External signal: onde os parâmetros externos devem ser declarados para serem usados dentro do fluxo de trabalho.
  • Atividade Transfer file: importa o arquivo com o nome definido nos parâmetros.
  • Atividade Load file: carrega dados do arquivo importado no banco de dados.
  • Atividade Update data: inserir ou atualizar o banco de dados com dados do arquivo importado.
  • Atividade Test: verifica se há dados importados.
  • Atividade Save audience: se o arquivo contiver dados, salva os perfis em uma audiência.
  • Atividade End activity: chama o Fluxo de Trabalho 2 com os parâmetros que você deseja usar dentro dele.

Siga as etapas abaixo para configurar o workflow:

  1. Declarar os parâmetros que foram definidos na chamada à API. Para fazer isso, abra a atividade External signal e adicione os nomes e tipos dos parâmetros.

  2. Adicione uma atividade Transfer file para importar dados para o banco de dados.Para fazer isso, arraste e solte a atividade, abra-a e selecione a guia Protocol.

  3. Selecione a opção Use a dynamic file path e use o parâmetro fileToTarget como o arquivo a ser transferido:

    code language-none 
    $(vars/@fileToTarget)

  4. Carregue os dados do arquivo no banco de dados.

    Para fazer isso, arraste e solte uma atividade Load file no fluxo de trabalho e configure-a de acordo com suas necessidades.

  5. Insira e atualize o banco de dados com os dados do arquivo importado.

    Para fazer isso, arraste e solte uma atividade Update data e selecione a guia Identification para adicionar um critério de reconciliação (neste caso, o campo email).

  6. Selecione a guia Fields to update e especifique os campos a serem atualizados no banco de dados (neste caso, os campos firstname e email).

  7. Verifique se os dados foram recuperados do arquivo. Para fazer isso, arraste e solte uma atividade Test no fluxo de trabalho e clique no botão Add an element para adicionar uma condição.

  8. Nomeie e defina a condição. Em nosso caso, queremos testar se a transição de saída contém dados com a sintaxe abaixo:

    code language-none 
    $long(vars/@recCount)>0

  9. Se os dados forem recuperados, salve-os em um público-alvo. Para fazer isso, adicione uma atividade Save audience à transição Target not empty e, em seguida, abra-a.

  10. Selecione a opção Use a dynamic label e use o parâmetro fileToTarget como o rótulo do público-alvo:

    code language-none 
    $(vars/@fileToTarget)

  11. Arraste e solte uma atividade End que chamará o Fluxo de Trabalho 2 com parâmetros e, em seguida, a abra.

  12. Selecione a guia External signal e especifique o fluxo de trabalho a ser acionado e sua atividade de sinal associada.

  13. Defina os parâmetros que deseja usar no Workflow 2 e seus valores associados.

    Em nosso caso, queremos passar os parâmetros originalmente definidos na chamada de API (fileToTarget e discountDesc) e um parâmetro segmentCode adicional com um valor constante ("20% de desconto").

O fluxo de trabalho 1 está configurado, agora é possível criar o Fluxo de trabalho 2. Para obter mais informações, consulte esta seção.

Etapa 3: configuração do workflow 2 step-3--configuring-workflow-2

O fluxo de trabalho 2 será criado conforme abaixo:

  • Atividade External signal: onde os parâmetros devem ser declarados para serem usados dentro do fluxo de trabalho.
  • Atividade Read audience: lê o público salvo no Fluxo de trabalho 1.
  • Atividade Email delivery: envia uma mensagem recorrente para o público alvo, personalizada com parâmetros.

Siga as etapas abaixo para configurar o workflow:

  1. Declare os parâmetros que foram definidos no Workflow 1.

    Para fazer isso, abra a atividade External signal e adicione o nome e o tipo de cada parâmetro definido na atividade End do Fluxo de Trabalho 1.

  2. Use o público que foi salvo no Fluxo de trabalho 1. Para fazer isso, arraste e solte uma atividade Read audience no fluxo de trabalho e depois a abra.

  3. Selecione a opção Use a dynamic audience e use o parâmetro fileToTarget como o nome do público-alvo a ser lido:

    code language-none 
    $(vars/@fileToTarget)

  4. Nomeie a transição de saída de acordo com o parâmetro segmentCode.

    Para fazer isso, selecione a guia Transition e depois a opção Use a dynamic segment code.

  5. Use o parâmetro segmentCode como o nome da transição de saída:

    code language-none 
    $(vars/@segmentCode)

  6. Arraste e solte uma atividade Email delivery para enviar uma mensagem ao público-alvo.

  7. Identifique os parâmetros a serem usados na mensagem para personalizá-la com o parâmetro discountDesc. Para fazer isso, abra as opções avançadas da atividade e adicione o nome e o valor do parâmetro.

  8. Agora você pode configurar a mensagem. Abra a atividade e selecione Recurring email.

  9. Selecione o template a ser usado e defina as propriedades do email de acordo com suas necessidades.

  10. Use o parâmetro discountDesc como um campo de personalização. Para fazer isso, selecione-o na lista de campos de personalização.

  11. Agora você pode concluir a configuração da mensagem e enviá-la como de costume.

Execução de workflows executing-the-workflows

Depois que os workflows forem criados, você poderá executá-los. Verifique se os dois workflows foram iniciados antes de executar a chamada de API.

recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff