Este artigo explica como ver uma prévia das campanhas por API do lado do servidor. Para a prévia de campanhas de personalização da seção (como Overlay ou Dynamic Content), consulte prévia de campanhas de personalização baseadas em scripts.
Você pode visualizar campanhas e variações das experiências de personalização da sua seção como se tivessem sido publicadas em seu website. Há duas maneiras de ver a prévia que ajudam você a testar e visualizar todos os aspectos de suas campanhas:
- Ver a prévia de uma variação: visualize uma variação, independentemente de cumprir condições de segmentação. Nesse modo, o código da variação é simplesmente injetado na página. Isso é útil para fazer o controle de qualidade (QA) do código e da aparência.
- Ver a prévia de uma campanha: visualize-a exatamente como um visitante a experimentaria em seu website. Isso significa que você verá a campanha somente se atender às condições de segmentação e configurações de frequência. Você verá a experiência com a maior prioridade (para a qual você é direcionado) e receberá variações de acordo com a alocação. Como isso inclui experiências em rascunho, você pode fazer o QA das experiências e campanhas antes de veiculá-las aos seus visitantes.
Ver a prévia de variações
Você pode ver a prévia das variações mesmo que elas não tenham sido salvas.
- Ao editar ou criar uma variação, clique em Preview On Site (ver prévia na seção).
- Insira o URL do website no qual você deseja visualizar a variação.
Uma nova guia é aberta, exibindo a prévia.
Observe que a variação é exibida independentemente de você corresponder ou não às condições de segmentação da experiência. No entanto, as condições de gatilho da campanha devem ser atendidas (por exemplo, uma sobreposição que é acionada após 30 segundos). Se a condição de gatilho não for atendida, uma mensagem será exibida explicando por que o a variação não foi servida.
Ver a prévia de campanhas
- Passe o mouse sobre a campanha por API da qual você deseja ver a prévia e clique no ícone Preview
.
- Faça um dos seguintes procedimentos:
- Insira o URL da prévia (se já não tiver feito) e clique em Preview (prévia). A página é aberta no modo de prévia.
- Envie por e-mail o URL da prévia para seus colegas para que eles possam ver a prévia da campanha sem entrar no console do Experience OS.
Observação: as prévias de variações representam um instantâneo do código de variação no momento em que o link da prévia é gerado. Os links permanecem ativos por 45 dias.
Observe que, quando você visualiza uma campanha, todas as segmentações, gatilhos e frequência são considerados antes de veiculá-la.
O modo de prévia permanece ativo até você fechar a guia.
Ativar o modo de prévia
Para ver a prévia das campanhas por API, seu aplicativo deve solicitar o modo de prévia. Essa é uma alteração única que seu desenvolvedor faz. Depois, ver a prévia de variações e campanhas não exige mais nenhum esforço de desenvolvimento.
Quando você clica em Preview para uma campanha ou variação no console do Experience OS, o website é aberto com o parâmetro de URL dyApiPreview=[token]. Por exemplo:
http://acme.com/dyApiPreview=5f30be92-dbd3-4053-904b-f83cd885574b
Como desenvolvedor, adicione a lógica: se o parâmetro de URL dyApiPreview existe no URL atual, inclua o token de prévia na solicitação de API no preview.ids[].
{
"user": {"dyid": "1679843083476146043",
“dyid_server”: "1679843083476146043" },
"session":{"dy": "a2719b4d6c4709128bf5f57a3bf3"},
"selector": {
"names": ["PDP Top Banner", "PDP Recs"],
“preview”: {
“ids”: [“PREVIEW TOKEN”] // É aqui que você injeta o token de prévia a partir do parâmetro de URL
}
},
"context": {
"page": { "type":"HOMEPAGE", "location":"https://shop.biz/", "locale":"en_US"
},
"device": { "userAgent":"Mozilla/5.0 (X11; Linux x86_64) Chrome/56.0.29", "ip":"54.100.200.255"}
},
} {
"cookies": [
{"name": "_dyid_server", "value": "16798430146043", "maxAge": "63072000"},
{"name": "_dyjsession", "value": "a2719b4d6c470383f1bf3", "maxAge": "63072000"}
],
"choices": [
"id": 5,
"name": "Homepage Banner Main",
"type": "DECISION",
"decisionId": "aGVsbG8K",
"isPreview": true,
"variations": [
{
"id": 52,
"payload": {
...
"type": "CUSTOM_JSON",
"data": {
"key1": "value1",
"key2": "value2"
}
{
"user": { "id": "yaexono4ohphania" },
"session": { "custom": "iquahngaishe2koh" },
"selector": {
"names": ["PDP Top Banner", "PDP Recs"],
“preview”: {
"ids": [“PREVIEW TOKEN”] // É aqui que você injeta o token de prévia a partir do parâmetro de URL
}
},
"context": {
// O contexto habitual...
}
}{
"choices": [
{
"id": 551993,
"name": "HP Top Banner",
"type": "DECISION",
"variations": [
{
"id": 25863143,
"payload": {
"type": "CUSTOM_JSON",
"data": {
"image": "http://lorempixel.com/400/200/",
"title": "Stay Sharp",
"subtitle": "Set the tone of elegance",
"cta": "Buy Now",
"link": ""
}
}
}
],
"decisionId": "l7QtNTg5MTkwODkyNDA4MTM1NDM3Oc4AEHLBpzk5MzA1ODQBkJHOAYqj56UzNjQzOQ=="
}
],
"isPreviewMode": true
}}Observações
- O escopo do token de prévia é para a solicitação inteira. Ou seja, ele “habilitará” todos os rascunhos de experiências nas campanhas. Se você quiser ver a prévia de rascunhos de uma única campanha, separe as solicitações.
- Os tokens de prévia expiram após 2 semanas.
- Um novo token de prévia é gerado toda vez que se clica em Preview.
- Ao solicitar o modo de prévia para várias campanhas, você receberá a melhor opção (com base na segmentação correspondida) de todas campanhas em execução e em rascunho.
- Se você enviar um token de prévia inválido, receberá um aviso: Request contains invalid previewId (a solicitação contém previewId inválido).
- Se você enviar uma solicitação sem token de prévia (ou seja, uma chamada de produção em execução), somente experiências de status ativo serão consideradas. Campanhas que incluem somente experiências em rascunho ou pausadas retornarão opções vazias.
- Você pode incluir vários tokens de prévia em uma única chamada separando os tokens por vírgula. Isso é útil se você quiser ver a prévia de diversas variações de diferentes campanhas ao mesmo tempo. Se você incluir diversos tokens, os tokens para ver a prévia de uma variação têm precedência sobre tokens para ver a prévia de uma campanha.
-
Observe a diferença entre tokens de prévia a nível de campanha e tokens a nível de variação: Um token de prévia a nível de campanha retorna o parâmetro “isPreviewMode”: true no final da resposta, que faz com que todas as campanhas retornadas sejam visualizadas no modo de prévia.Um token de prévia a nível de variação retorna o parâmetro “isPreview”: true dentro do parâmetro “choices” de cada variação separadamente, se o token corresponder a uma variação.