[Disponibilidade limitada]{class="badge informative"}

Configurar um canal personalizado create-custom-channel

Para poder usar um canal personalizado em campanhas e jornadas, um administrador deve primeiro criar o canal. Isso envolve a definição do endpoint, a autenticação, a política de limitação e a estrutura de payload da mensagem.

A seção Channel Builder é a interface central para a definição de novos canais personalizados. Ele permite criar e configurar canais personalizados, mas também gerenciar credenciais de API e delegar subdomínios.

IMPORTANT
Para acessar o Construtor de Canais e criar e gerenciar canais personalizados, você deve ter as permissões Exibir canais personalizados e Gerenciar canais personalizados concedidas. Saiba como gerenciar permissões em esta seção.

Acessar e gerenciar canais personalizados access-channel-builder

Para acessar o Channel Builder e gerenciar seus canais personalizados, siga as etapas abaixo.

  1. Vá para Administração > Canais no painel de navegação esquerdo.

  2. Selecione Canais personalizados na seção Construtor de canais.

    Inventário de canais personalizados {width="70%"}

  3. O inventário lista todos os canais personalizados em sua sandbox, incluindo o status atual e o tipo de autenticação usado para se conectar ao endpoint externo.

  4. Você pode filtrar os canais personalizados por status (Rascunho, Ativo ou Arquivado), que os criou e pesquisar por nome.

  5. Para editar um canal, clique no nome dele no inventário, faça as alterações e salve. Para canais ativos, você só pode editar determinados campos - saiba mais.

    note caution
    CAUTION
    A modificação das configurações de limitação ou repetição em um canal ativo entra em vigor imediatamente para todas as execuções em andamento e futuras.
  6. Para arquivar um canal, abra-o no inventário e clique em Arquivar.

    O arquivamento de um canal ativo o remove de todos os menus suspensos de seleção — seletor de ação de campanha, paleta de ações de jornada, lista de canais de campanhas orquestradas, configurações de canal e modelos de conteúdo. As jornadas e campanhas existentes que já usam o canal continuam a funcionar normalmente.

Criar um canal personalizado create-channel

Para criar um novo canal personalizado, siga as etapas abaixo.

  1. Clique no botão Criar canal personalizado para abrir o formulário de criação de canal. Comece definindo as configurações gerais do seu canal personalizado.

    Configurações gerais {width="70%"}

  2. Na seção Propriedades, digite um Nome para o canal personalizado. Esse nome aparecerá na tela do jornada, no seletor de ações de campanha e na lista de canais de campanhas orquestradas.

    note
    NOTE
    O nome deve ser exclusivo, começar com uma letra (A-Z), incluir apenas caracteres alfanuméricos ou caracteres especiais ( _, ., -) e deve ter mais de 1 caractere.
  3. Você pode selecionar um ícone na biblioteca de ícones padrão ou selecionar um arquivo do SVG no computador.

    note
    NOTE
    O arquivo não deve ter mais de 150 KB.

    Esse ícone será exibido ao lado do nome do canal na tela de jornada. Se nenhum ícone for carregado, o ícone padrão será usado.

  4. Insira uma Descrição opcional.

Definir a configuração do ponto de extremidade endpoint-configuration

Você deve configurar o endpoint, que é o URL HTTP do seu sistema de mensagens externo. Journey Optimizer envia uma solicitação POST para este ponto de extremidade com a carga personalizada quando um perfil é qualificado em uma campanha ou jornada.

Configuração de ponto de extremidade {width="70%"}

  1. Na seção Configuração de ponto de extremidade, insira o host URL do sistema de mensagens externo.

    note important
    IMPORTANT
    Seu sistema de mensagens externo deve expor um ponto de extremidade HTTPS que Journey Optimizer pode chamar via HTTP POST. O endpoint deve:
    • Aceite o formato de conteúdo definido pelo seu canal (JSON).
    • Suporte a um dos métodos de autenticação disponíveis no Channel Builder. Saiba mais
    • Retorne uma resposta HTTP 2xx para confirmar o recebimento da solicitação.
  2. Adicione Cabeçalhos conforme necessário. Cabeçalhos são pares de valores chave transmitidos no nível de solicitação HTTP. Eles são enviados junto com cada solicitação para o endpoint e normalmente são usados para tokens de autenticação, especificação de tipo de conteúdo ou quaisquer outros metadados exigidos pelo sistema externo.

    Configuração de cabeçalhos

    Para cada cabeçalho, é possível definir se o valor é:

    • Constante - Um valor estático definido uma vez e incluído em cada solicitação. Por exemplo, você pode definir o parâmetro Content-Type com o valor application/json ou o parâmetro Charset com o valor UTF-8.
    • Variável - Se um valor padrão for inserido aqui, ele será usado, a menos que seja substituído na configuração do canal. Por exemplo, é possível definir uma variável para a ID do usuário que é resolvida no tempo de execução. Saiba mais
  3. Opcionalmente, adicione Parâmetros de consulta usando o mesmo padrão de constante/variável. Os parâmetros de consulta são anexados ao URL do endpoint no momento da entrega. Parâmetros constantes são sempre adicionados com o mesmo valor; parâmetros variáveis são resolvidos no momento do envio, por exemplo, para passar um identificador do usuário do perfil.

    Parâmetros de consulta {width="70%"}

  4. Na seção Configuração de política, defina como Journey Optimizer lida com a taxa de transferência de solicitação e falhas. Isso é importante para garantir que seu sistema externo possa lidar com o volume de solicitações e evitar sobrecarregá-lo.

    Configuração de política

    • Habilitar limitação - Desabilitado por padrão. Defina o número máximo de solicitações por segundo (padrão: 5.000c). Quando o limite é atingido, as solicitações são enfileiradas e enviadas o mais rápido possível.
    • Habilitar nova tentativa - Habilitado por padrão. Defina a contagem máxima de novas tentativas (padrão: 3, intervalo configurável: 0-10) para solicitações com falha. Isso ajuda a evitar sobrecarregar o endpoint durante falhas transitórias.
    • Tempo limite - Padrão: 5.000 milissegundos. Defina o tempo máximo de espera por uma resposta do ponto de extremidade antes de considerar que a solicitação falhou.

Configurações de autenticação authentication-settings

Selecione o Tipo de autenticação que você precisa usar para este canal. As opções disponíveis dependem dos métodos de autenticação compatíveis com seu sistema de mensagens externo.

Tipo de autenticação {width="70%"}

Forneça os detalhes de autenticação, conforme exigido pelo seu endpoint.

  • Nenhum - A solicitação foi enviada sem credenciais.
  • Chave de API - Forneça o nome da chave, o valor e o local (parâmetro de consulta ou cabeçalho).
  • Autenticação básica - Forneça um nome de usuário e senha.
  • OAuth 2.0 - Configure a carga para a autenticação OAuth 2.0.

Quando o tipo de autenticação é qualquer coisa diferente de Nenhum, o Journey Optimizer gera automaticamente um conjunto inicial de credenciais de API para este canal quando ele é ativado. Você pode alterar essas credenciais e criar novas no inventário de credenciais da API. Saiba mais

No entanto, os detalhes de autenticação são necessários aqui para testar a conexão com seu endpoint antes de ativar o canal. Um botão Testar conexão está disponível para validar a configuração de autenticação. Saiba mais

Configuração de carga útil payload-configuration

A carga é enviada para o endpoint quando um perfil é qualificado em uma campanha ou jornada.

Na configuração de carga, defina a estrutura da carga da mensagem e quais campos os profissionais de marketing podem criar e personalizar.

  1. Clique em Definir carga e escolha como definir a carga:

    • Colar carga JSON de amostra - Cole um objeto JSON representativo e Journey Optimizer infere automaticamente um esquema dele.

    • Importar esquema JSON (em breve) - Carregue um arquivo de esquema JSON completo.

      note availability
      AVAILABILITY
      Esse recurso ainda não está disponível. Ele será adicionado em uma versão futura.
  2. Depois que o esquema é gerado, Journey Optimizer exibe todos os campos detectados em um modo de exibição de formulário.

  3. Para cada campo, defina as seguintes configurações:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    Configuração Descrição
    Valor padrão Opcional. Usado se nenhum valor personalizado for fornecido no momento da criação.
    Tipo Somente leitura, derivado da carga. Tipos com suporte: string, integer, decimal, boolean, dateTime, dateTimeOnly, dateOnly, listObject, listString, listInteger, listDecimal, listBoolean, listDateTime, listDateTimeOnly, listDateOnly.
    Obrigatório Se ativado, o campo deve ter um valor quando o canal é usado em uma campanha ou jornada. Campos obrigatórios ausentes acionam um erro de validação que impede a ativação.
    Configuração de canal Se estiver ativado, o campo aparece na configuração do canal, permitindo que os administradores definam valores diferentes por configuração (por exemplo, uma ID de remetente diferente por marca ou região). Saiba como

    Campos aninhados são representados com a notação de pontos (por exemplo, image.id).

Testar e ativar test-activate

Enquanto o canal está com o status Rascunho, use o botão Testar conexão na parte superior da tela para enviar uma solicitação de teste para o seu ponto de extremidade e validar a conexão ponta a ponta.

Botão de conexão de teste {width="70%"}

Verifique os logs do sistema externo para confirmar se a solicitação foi recebida com a autenticação e a carga esperadas.

Depois que o teste for bem-sucedido, você poderá salvar ou ativar o canal.

  • Clique em Salvar como rascunho para salvar seu progresso sem disponibilizar o canal.
  • Clique em Ativar para disponibilizar o canal para uso em configurações de canal, campanhas e jornadas.
IMPORTANT
Depois que um canal é ativado, apenas os seguintes campos permanecem editáveis: nome, descrição, ícone, limitação e configuração de repetição. A URL do ponto de extremidade, os cabeçalhos, os parâmetros de consulta, a autenticação e a estrutura de carga estão bloqueados.

Próximas etapas next-steps

Seu canal personalizado foi criado. Conclua a configuração seguindo as etapas restantes:

recommendation-more-help
journey-optimizer-help