Registro do lado do cliente para dados A4T no SDK da Web da plataforma

Visão geral

O SDK da Web da Adobe Experience Platform permite coletar Adobe Analytics for Target (A4T) dados no lado do cliente do aplicativo da Web.

O registro no lado do cliente significa que Target Os dados são retornados no lado do cliente, permitindo coletá-los e compartilhá-los com o Analytics. Essa opção deve ser ativada se você pretende enviar dados manualmente para o Analytics usando o API de inserção de dados.

OBSERVAÇÃO

Um método para executar isso usando AppMeasurement.js está atualmente em desenvolvimento e estará disponível num futuro próximo.

Este documento aborda as etapas para configurar o registro do A4T no lado do cliente para o SDK da Web e fornece alguns exemplos de implementação para casos de uso comuns.

Pré-requisitos

Este tutorial assume que você está familiarizado com os conceitos e processos fundamentais relacionados ao uso do SDK da Web para fins de personalização. Revise a seguinte documentação se você precisar de uma introdução:

Configurar o registro no lado do cliente do Analytics

As subseções a seguir descrevem como ativar o registro do lado do cliente do Analytics para sua implementação do SDK da Web.

Ativar o registro no lado do cliente do Analytics

Para considerar o registro do lado do cliente do Analytics habilitado para sua implementação, você deve desativar a configuração do Adobe Analytics em datastream.

Configuração de armazenamento de dados do Analytics desabilitada

Recuperar A4T dados do SDK e enviá-los para o Analytics

Para que esse método de relatório funcione corretamente, é necessário enviar a variável A4T dados relacionados recuperados do sendEvent na ocorrência do Analytics.

Quando o Target Edge calcula uma resposta de propostas, ele verifica se o registro do lado do cliente do Analytics está ativado (ou seja, se o Analytics está desativado no armazenamento de dados). Se o registro no lado do cliente estiver ativado, o sistema adicionará um token do Analytics a cada proposta na resposta.

O fluxo é semelhante a este:

Fluxo de registro do lado do cliente

Este é um exemplo de um interact resposta quando o registro do lado do cliente do Analytics estiver ativado. Se a proposta for para uma atividade que tem relatórios do Analytics, ela terá um scopeDetails.characteristics.analyticsToken propriedade.

{
  "requestId": "1234",
  "handle": [
    {
      "payload": [
        {
          "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
          "scope": "a4t-test",
          "scopeDetails": {
            "decisionProvider": "TGT",
            "activity": {
              "id": "434689"
            },
            "experience": {
              "id": "0"
            },
            "strategies": [
              {
                "algorithmID": "0",
                "trafficType": "0"
              }
            ],
            "characteristics": {
              "eventToken": "2lTS5KA6gj4JuSjOdhqUhGqipfsIHvVzTQxHolz2IpTMromRrB5ztP5VMxjHbs7c6qPG9UF4rvQTJZniWgqbOw==",
              "analyticsToken": "434689:0:0|2,434689:0:0|1"
            }
          },
          "items": [
            {
              "id": "1184844",
              "schema": "https://ns.adobe.com/personalization/html-content-item",
              "meta": {
                "geo.state": "bucuresti",
                "activity.id": "434689",
                "experience.id": "0",
                "activity.name": "a4t test form based activity",
                "offer.id": "1184844",
                "profile.tntId": "04608610399599289452943468926942466370-pybgfJ"
              },
              "data": {
                "id": "1184844",
                "format": "text/html",
                "content": "<div> analytics impressions </div>"
              }
            }
          ]
        },
        {
          "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
          "scope": "a4t-test",
          "scopeDetails": {
            "decisionProvider": "TGT",
            "activity": {
              "id": "434689"
            },
            "characteristics": {
              "eventToken": "E0gb6q1+WyFW3FMbbQJmrg==",
              "analyticsToken": "434689:0:0|32767"
            }
          },
          "items": [
            {
              "id": "434689",
              "schema": "https://ns.adobe.com/personalization/measurement",
              "data": {
                "type": "click",
                "format": "application/vnd.adobe.target.metric"
              }
            }
          ]
        }
      ],
      "type": "personalization:decisions",
      "eventIndex": 0
    }
  ]
}

As propostas de atividades do Experience Composer baseadas em formulário podem conter itens de métrica de conteúdo e clique na mesma proposta. Assim, em vez de ter um único token de análise para a exibição de conteúdo em scopeDetails.characteristics.analyticsToken podem ter um token de análise de exibição e de clique especificado em scopeDetails.characteristics.analyticsTokens objeto, em display e click propriedades, de forma correspondente.

{
  "requestId": "1234",
  "handle": [
    {
      "payload": [
        {
          "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
          "scope": "a4t-test",
          "scopeDetails": {
            "decisionProvider": "TGT",
            "activity": {
              "id": "434689"
            },
            "experience": {
              "id": "0"
            },
            "strategies": [
              {
                "algorithmID": "0",
                "trafficType": "0"
              }
            ],
            "characteristics": {
              "eventTokens": {
                "display": "2lTS5KA6gj4JuSjOdhqUhGqipfsIHvVzTQxHolz2IpTMromRrB5ztP5VMxjHbs7c6qPG9UF4rvQTJZniWgqbOw==",
                "click": "E0gb6q1+WyFW3FMbbQJmrg=="
              },
              "analyticsTokens": {
                "display": "434689:0:0|2,434689:0:0|1",
                "click": "434689:0:0|32767"
              }
            }
          },
          "items": [
            {
              "id": "1184844",
              "schema": "https://ns.adobe.com/personalization/html-content-item",
              "meta": {
                "geo.state": "bucuresti",
                "activity.id": "434689",
                "experience.id": "0",
                "activity.name": "a4t test form based activity",
                "offer.id": "1184844",
                "profile.tntId": "04608610399599289452943468926942466370-pybgfJ"
              },
              "data": {
                "id": "1184844",
                "format": "text/html",
                "content": "<div> analytics impressions </div>"
              }
            },
            {
              "id": "434689",
              "schema": "https://ns.adobe.com/personalization/measurement",
              "data": {
                "type": "click",
                "format": "application/vnd.adobe.target.metric"
              }
            }
          ]
        }
      ],
      "type": "personalization:decisions",
      "eventIndex": 0
    }
  ]
}

Todos os valores de scopeDetails.characteristics.analyticsToken, bem como scopeDetails.characteristics.analyticsTokens.display (para conteúdo exibido) e scopeDetails.characteristics.analyticsTokens.click (para métricas de cliques) são as cargas A4T que precisam ser coletadas e incluídas como tnta na API de inserção de dados chame.

IMPORTANTE

Observe que alguns analyticsToken/analyticsTokens As propriedades podem conter vários tokens, concatenados como uma única string delimitada por vírgulas.

Nos exemplos de implementação fornecidos na próxima seção, vários tokens do Analytics estão sendo coletados iterativamente. Para concatenar uma matriz de tokens do Analytics, use uma função semelhante a esta:

var concatenateAnalyticsPayloads = function concatenateAnalyticsPayloads(analyticsPayloads) {
   if (analyticsPayloads.size > 1) {
       return [].concat(analyticsPayloads).join(',');
   }
   return [].concat(analyticsPayloads).join();
};

Exemplos de implementação

As subseções a seguir demonstram como implementar o registro no lado do cliente do Analytics para casos de uso comuns.

Atividades do Experience Composer baseado em formulário

Você pode usar o SDK da Web para controlar a execução de propostas de Experience Composer baseado em formulário do Adobe Target atividades.

Quando você solicita propostas para um escopo de decisão específico, a proposta retornada contém o token adequado do Analytics. A prática recomendada é encadear o SDK da Web da plataforma sendEvent e percorra as apresentações retornadas para executá-las ao coletar os tokens do Analytics ao mesmo tempo.

Você pode acionar um sendEvent comando para um escopo de atividade do Experience Composer baseado em formulário como este:

alloy("sendEvent", {
    "decisionScopes": ["a4t-test"],
    "xdm": {
      "web": {
        "webPageDetails": {
          "name": "Home Page"
        }
      }
    }
  }
).then(function(results) {
  for (var i = 0; i < results.propositions.length; i++) {
    //Execute the propositions and collect the Analytics payload
  }
});

A partir daqui, você deve implementar o código para executar as propostas e construir uma carga útil que será enviada para o Analytics. Este é um exemplo do que results.propositions pode conter:

[
  {
    "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
    "scope": "a4t-test",
    "scopeDetails": {
      "decisionProvider": "TGT",
      "activity": {
        "id": "434689"
      },
      "experience": {
        "id": "0"
      },
      "strategies": [
        {
          "algorithmID": "0",
          "trafficType": "0"
        }
      ],
      "characteristics": {
        "eventToken": "2lTS5KA6gj4JuSjOdhqUhGqipfsIHvVzTQxHolz2IpTMromRrB5ztP5VMxjHbs7c6qPG9UF4rvQTJZniWgqbOw==",
        "analyticsToken": "434689:0:0|2,434689:0:0|1"
      }
    },
    "items": [
      {
        "id": "1184844",
        "schema": "https://ns.adobe.com/personalization/html-content-item",
        "meta": {
          "geo.state": "bucuresti",
          "activity.id": "434689",
          "experience.id": "0",
          "activity.name": "a4t test form based activity",
          "offer.id": "1184844",
          "profile.tntId": "04608610399599289452943468926942466370-pybgfJ"
        },
        "data": {
          "id": "1184844",
          "format": "text/html",
          "content": "<div> analytics impressions </div>"
        }
      }
    ]
  },
  {
    "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
    "scope": "a4t-test",
    "scopeDetails": {
      "decisionProvider": "TGT",
      "activity": {
        "id": "434689"
      },
      "characteristics": {
        "eventToken": "E0gb6q1+WyFW3FMbbQJmrg==",
        "analyticsToken": "434689:0:0|32767"
      }
    },
    "items": [
      {
        "id": "434689",
        "schema": "https://ns.adobe.com/personalization/measurement",
        "data": {
          "type": "click",
          "format": "application/vnd.adobe.target.metric"
        }
      }
    ]
  },
  {
    "id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
    "scope": "a4t-test",
    "scopeDetails": {
      "decisionProvider": "TGT",
      "activity": {
        "id": "434688"
      },
      "experience": {
        "id": "0"
      },
      "strategies": [
        {
          "algorithmID": "0",
          "trafficType": "0"
        }
      ],
      "characteristics": {
        "eventTokens": {
          "display": "91TS5KA6gj4JuSjOdhqUhGqipfsIHvVzTQxHolz2IpTMromRrB5ztP5VMxjHbs7c6qPG9UF4rvQTJZniWgqgEt==",
          "click": "Tagb6q1+WyFW3FMbbQJrtg=="
        },
        "analyticsTokens": {
          "display": "434688:0:0|2,434688:0:0|1",
          "click": "434688:0:0|32767"
        }
      }
    },
    "items": [
      {
        "id": "1184845",
        "schema": "https://ns.adobe.com/personalization/html-content-item",
        "meta": {
          "geo.state": "bucuresti",
          "activity.id": "434688",
          "experience.id": "0",
          "activity.name": "a4t test form based activity 1",
          "offer.id": "1184845"
        },
        "data": {
          "id": "1184845",
          "format": "text/html",
          "content": "<div> analytics impressions 1</div>"
        }
      },
      {
        "id": "434688",
        "schema": "https://ns.adobe.com/personalization/measurement",
        "data": {
          "type": "click",
          "format": "application/vnd.adobe.target.metric"
        }
      }
    ]
  }
]

Para extrair o token do Analytics de uma proposta com itens de conteúdo, é possível implementar uma função semelhante ao seguinte:

function getDisplayAnalyticsPayload(proposition) {
  if (!proposition || !proposition.scopeDetails || !proposition.scopeDetails.characteristics) {
    return;
  }
  var characteristics = proposition.scopeDetails.characteristics;
  if (characteristics.analyticsTokens) {
    return characteristics.analyticsTokens.display;
  }
  return characteristics.analyticsToken;
}

Uma proposta pode ter tipos diferentes de itens, conforme indicado pela variável schema propriedade do item em questão. Há quatro esquemas de item de proposta compatíveis com atividades do Experience Composer baseado em formulário:

var HTML_SCHEMA = "https://ns.adobe.com/personalization/html-content-item";
var MEASUREMENT_SCHEMA = "https://ns.adobe.com/personalization/measurement";
var JSON_SCHEMA = "https://ns.adobe.com/personalization/json-content-item";
var REDIRECT_SCHEMA = "https://ns.adobe.com/personalization/redirect-item";

HTML_SCHEMA e JSON_SCHEMA são os esquemas que refletem o tipo da oferta, enquanto MEASUREMENT_SCHEMA O reflete as métricas que devem ser anexadas a um elemento DOM.

As cargas do Analytics para métricas de cliques devem ser coletadas e enviadas ao Analytics separadamente dos itens de conteúdo, no momento em que o visitante realmente clica no conteúdo exibido anteriormente.

A seguinte função auxiliar para obter as cargas da métrica de clique do A4T será útil neste caso:

function getClickAnalyticsPayload(proposition) {
  if (!proposition || !proposition.scopeDetails || !proposition.scopeDetails.characteristics) {
    return;
  }
  var characteristics = proposition.scopeDetails.characteristics;
  if (characteristics.analyticsTokens) {
    return characteristics.analyticsTokens.click;
  }
  return characteristics.analyticsToken;
}

Resumo da implementação

Em resumo, as etapas a seguir devem ser executadas ao aplicar atividades do Experience Composer baseado em formulário com o SDK da Web da plataforma:

  1. Envie um evento que busque ofertas de atividade do Experience Composer baseadas em formulário;
  2. Aplicar as alterações de conteúdo à página;
  3. Envie o decisioning.propositionDisplay Evento de notificação;
  4. Colete os tokens de exibição do Analytics da resposta do SDK e construa uma carga para a ocorrência do Analytics;
  5. Envie a carga para o Analytics usando o API de inserção de dados;
  6. Se houver métricas de clique em apresentações entregues, os ouvintes de cliques devem ser configurados para que, quando um clique for executado, ele envie a variável decisioning.propositionInteract evento de notificação. O onBeforeEventSend O manipulador deve ser configurado de forma que, ao interceptar decisioning.propositionInteract , as seguintes ações ocorrem:
    1. Coleta dos tokens do Analytics de cliques xdm._experience.decisioning.propositions
    2. Enviar a ocorrência de clique do Analytics com a carga coletada do Analytics por API de inserção de dados;
alloy("sendEvent", {
    "decisionScopes": ["a4t-test"],
    "xdm": {
      "web": {
        "webPageDetails": {
          "name": "Home Page"
        }
      }
    }
  }
).then(function(results) {
  var analyticsPayload = new Set();
  results.propositions.forEach(function (proposition) {
    proposition.items.forEach(function (item) {
      if (item.schema === HTML_SCHEMA) {
        // 1. Apply offer
        // 2. Collect executed propositions and send the decisioning.propositionDisplay notification event
        // 3. Collect the display Analytics tokens
      }
      if (item.schema === MEASUREMENT_SCHEMA) {
        // Setup click listener, so that when clicked:
        // 1. Collect clicked propositions and send the decisioning.propositionInteract notification event
        // Note: onBeforeEventSend handler should be configured, so that when intercepting decisioning.propositionInteract events:
        //   1. Collect the click Analytics tokens from xdm._experience.decisioning.propositions
        //   2. Send the click Analytics hit with the collected Analytics payload via Data Insertion API
      }
    });
  });
  // Send the page view Analytics hit with the collected display Analytics payload via Data Insertion API
});

Atividades do Visual Experience Composer

O SDK da Web permite manipular ofertas que foram criadas usando Visual Experience Composer (VEC).

OBSERVAÇÃO

As etapas para implementar esse caso de uso são muito semelhantes às etapas para Atividades do Experience Composer baseado em formulário. Consulte a seção anterior para obter mais detalhes.

Quando a renderização automática é ativada, é possível coletar os tokens do Analytics a partir das apresentações que foram executadas na página. A prática recomendada é encadear o SDK da Web da plataforma sendEvent e percorra as propostas retornadas para filtrar aquelas que o SDK da Web tentou renderizar.

Exemplo

alloy("sendEvent", {
    "renderDecisions": true,
    "xdm": {
      "web": {
        "webPageDetails": {
          "name": "Home Page"
        }
      }
    }
  }
).then(function (results) {
  var analyticsPayloads = new Set();

  for (var i = 0; i < results.propositions.length; i++) {

    var proposition = propositions[i];
    var renderAttempted = proposition.renderAttempted;

    if (renderAttempted === true) {
      var analyticsPayload = getDisplayAnalyticsPayload(proposition);

      if (analyticsPayload !== undefined) {
        analyticsPayloads.add(analyticsPayload);
      }
    }
  }
  var analyticsPayloadsToken = concatenateAnalyticsPayloads(analyticsPayloads);
  // Send the page view Analytics hit with collected Analytics payload via Data Insertion API
});

Usando onBeforeEventSend para manipular métricas de página

Usando as atividades do Adobe Target, você pode configurar métricas diferentes na página, anexadas manualmente ao DOM ou anexadas automaticamente às Atividades de criação do DOM (VEC). Ambos os tipos são uma interação atrasada do usuário final na página da Web.

Para levar isso em conta, a prática recomendada é coletar as cargas do Analytics usando o onBeforeEventSend Gancho do SDK da Web da Adobe Experience Platform. O onBeforeEventSend o gancho deve ser configurado usando o configure , e serão refletidas em todos os eventos enviados pelo conjunto de dados.

Este é um exemplo de como onBeforeEventSent pode ser configurado para acionar ocorrências do Analytics:

alloy("configure", {
  edgeConfigId: "datastream configuration ID",
  orgId: "adobe ORG ID",
  onBeforeEventSend: function(options) {
    const xdm = options.xdm;
    const eventType = xdm.eventType;
    if (eventType === "decisioning.propositionInteract") {
      const analyticsPayloads = new Set();
      const propositions = xdm._experience.decisioning.propositions;

      for (var i = 0; i < propositions.length; i++) {
        var proposition = propositions[i];
        analyticsPayloads.add(getClickAnalyticsPayload(proposition));
      }
      // Trigger the Analytics hit
    }
  }
});

Próximas etapas

Este guia cobriu o registro do lado do cliente para dados A4T no SDK da Web. Consulte o guia sobre registro no lado do servidor para obter mais informações sobre como lidar com dados A4T na Edge Network.

Nesta página