Campanhas de API de Código Personalizado para a Web

Campanhas de API personalizadas permitem que você use o poder do teste A/B e da alocação automática da Dynamic Yield enquanto controla totalmente a forma como as campanhas são renderizadas em seu site. As variações das suas campanhas de API personalizadas são arquivos JSON, portanto, cada chamada resulta em um arquivo JSON que você pode usar para renderizar um elemento em seu site. 

Criando campanhas de API personalizadas no back-end 

Passo 1: crie a campanha

1. Na seção Web Personalization, clique em Create Campaign.
2. Selecione API Custom Code.
   
3. Insira um nome e adicione notas e etiquetas (opcional).
4. Especifique o seletor de API. Esse seletor é necessário nas chamadas da API para a campanha. 
5. Opcionalmente, especifique um grupo de seletores. Saiba mais sobre grupos de seletores.
6. Opcionalmente, em Advanced Settings, você pode escolher informar várias variações por decisão (digamos, para variações de carrossel ou grade). 
7. Clique em Next.

Passo 2: crie variações

1. Na tela Experience, nomeie sua experiência e decida se quer criar uma nova variação ou copiar uma variação existente. Você também pode optar por gerenciar sua experiência sincronizando um feed de dados.
   
   
   • Se você selecionar New Variation, a tela de modelos aparecerá. Clique no modelo que deseja e, em seguida, crie sua variação em formato JSON. 
     
   • Se você selecionar Copy from Another Experience, sua lista de experiências aparecerá. 
     
     Selecione a experiência que deseja e, em seguida, selecione Copy Variation (leva você até a etapa de alocação) ou Copy and Edit (editar o JSON).
   • Se você clicar em sync it with a data feed, a lista de modelos aparecerá. Selecione um modelo e, em seguida, selecione o feed para sincronizar.
2. Clique em Save Variation.
3. Repita o processo para quantas variações forem necessárias.

Etapa 3: configure e salve a experiência 

1. Alocação:
   1. Defina a alocação, métrica primária e configurações avançadas da experiência.
   2. Configure quanto do seu tráfego alocar para cada variação e o grupo de controle.
   3. Clique em Next.
2. Segmentação:
   1. Defina as configurações de segmentação da experiência para determinar quando, onde e para quem a experiência será exibida e, em seguida, clique em Next. 
3. Salvar, visualizar e publicar:
   1. Salve sua experiência como um rascunho se quiser visualizá-la e editá-la antes que ela seja publicada. Quando estiver pronto, defina-a como ativa e salve-a.
   2. Clique no ícone de adição  para criar uma experiência direcionada adicional.
   3. Pré-visualização:
      • Depois de salvar a campanha, você pode visualizar as variações enquanto as edita.
      • Para pré-visualizar a campanha, acesse sua lista de campanhas, passe o mouse sobre a campanha e clique no ícone de pré-visualização  Para ver como ficará a variação para seu visitante. 
   4. Quando terminar, clique em Publish.

Chamando uma campanha personalizada no back-end

No seu código, você usará DYAP.choose () para solicitar uma variação de uma campanha.  

Caminho 

https://dy-api.com/v2/serve/user/choose 

Exemplo Node.JS

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://dy-api.com/v2/serve/user/choose',
  headers: {'content-type': 'application/json', 'dy-api-key': 'your-api-key'},
  body: `{
  "selector": {
  "names": [
  "test1"
  ]
  },
  "user": {
  "id": "customUserId123"
  },
  "session": {
  "custom": "myCustomSession345"
  },
  "context": {
  "page": {
  "type": "HOMEPAGE",
  "location": "https://example.org",
  "locale": "en_US",
  "data":[]
  },
  "device": {
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
  "ip": "54.100.200.255"
  }
  },
  "options": {
  "isImplicitPageview": false,
  " returnAnalyticsMetadata": false
  }}`
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Para mais detalhes, acesse a Referência da API. 

Relatando engajamento

Para relatar cliques em suas campanhas para a Dynamic Yield, use a chamada de API do Relatório de Engajamento.

Para mais detalhes, consulte a referência da API.  

Validando sua implementação

Confira os Registros da API para ver um histórico de chamadas recentes da API, seu status e muito mais.