Comparar a biblioteca at.js com a Adobe Experience Platform Web SDK
Visão geral
Este artigo fornece uma visão geral das diferenças entre a biblioteca at.js
e o Experience Platform Web SDK.
Instalação de bibliotecas
Instalação da at.js
O Adobe permite que os clientes baixem a biblioteca diretamente da guia Adobe Experience Cloud, Implementation. A biblioteca at.js é personalizada com configurações que o cliente tem como: clientCode, imsOrgId etc.
Instalação do Web SDK
A versão pré-criada está disponível em um CDN. Você pode fazer referência à biblioteca na CDN diretamente na sua página ou baixá-la e hospedá-la em sua própria infraestrutura. Ele está disponível em formatos minificados e não minificados. A versão não reduzida é útil para fins de depuração.
Consulte Instalar o Web SDK usando a biblioteca JavaScript para obter mais informações.
Configuração das bibliotecas
Configuração da at.js
No final de cada arquivo at.js, você verá uma seção em que Adobe instancia e passa um objeto de configuração. É personalizável. No download, o Adobe preenche essa seção com as configurações atuais do cliente.
window.adobe.target.init(window, document, {
"clientCode": "demo",
"imsOrgId": "",
"serverDomain": "localhost:5000",
"timeout": 2000,
"globalMboxName": "target-global-mbox",
"version": "2.0.0",
"defaultContentHiddenStyle": "visibility: hidden;",
"defaultContentVisibleStyle": "visibility: visible;",
"bodyHiddenStyle": "body {opacity: 0 !important}",
"bodyHidingEnabled": true,
"deviceIdLifetime": 63244800000,
"sessionIdLifetime": 1860000,
"selectorsPollingTimeout": 5000,
"visitorApiTimeout": 2000,
"overrideMboxEdgeServer": false,
"overrideMboxEdgeServerTimeout": 1860000,
"optoutEnabled": false,
"optinEnabled": false,
"secureOnly": false,
"supplementalDataIdParamTimeout": 30,
"authoringScriptUrl": "//cdn.tt.omtrdc.net/cdn/target-vec.js",
"urlSizeLimit": 2048,
"endpoint": "/rest/v1/delivery",
"pageLoadEnabled": true,
"viewsEnabled": true,
"analyticsLogging": "server_side",
"serverState": {},
"decisioningMethod": "server-side",
"legacyBrowserSupport": false
});
Configuração do Platform Web SDK
A configuração da SDK é feita com o comando configure
. O comando configure
é sempre chamado primeiro.
Como solicitar e renderizar automaticamente ofertas de Carregamento de página Target
Uso da at.js
Usando a at.js 2.x, se você habilitar a configuração pageLoadEnabled,
, a biblioteca acionará uma chamada para o Edge Target com execute -> pageLoad
. Se todas as configurações forem definidas com os valores padrão, nenhuma codificação personalizada será necessária. Depois que a at.js é adicionada à página e carregada pelo navegador, uma chamada do Edge Target é executada.
Usando o PLatform Web SDK
O conteúdo criado no Target Visual Experience Composer pode ser recuperado e renderizado automaticamente pelo SDK.
Para solicitar e renderizar automaticamente Target ofertas, use o comando sendEvent
e defina a opção renderDecisions
como true.
. Isso força o SDK a renderizar automaticamente qualquer conteúdo personalizado que esteja qualificado para renderização automática.
Exemplo:
alloy("sendEvent", {
"renderDecisions": true,
"xdm": {
"commerce": {
"order": {
"purchaseID": "a8g784hjq1mnp3",
"purchaseOrderNumber": "VAU3123",
"currencyCode": "USD",
"priceTotal": 999.98
}
}
}
});
Experience Platform Web SDK envia automaticamente uma notificação com as ofertas que foram executadas pelo Platform WEB SDK. Este é um exemplo de como uma carga de solicitação de notificação é exibida:
{
"events": [{
"xdm": {
"_experience": {
"decisioning": {
"propositions": [
{
"id": "AT:eyJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
"scope": "cart",
"scopeDetails": {
"decisionProvider": "TGT",
"activity": {
"id": "127019"
},
"experience": {
"id": "0"
},
"strategies": [
{
"step": "entry",
"algorithmID": "0",
"trafficType": "0"
},
{
"step": "display",
"algorithmID": "0",
"trafficType": "0"
}
],
"characteristics": {
"eventToken": "bKMxJ8dCR1XlPfDCx+2vSGqipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q=="
}
}
}
]
}
},
"eventType": "display",
"web": {
"webPageDetails": {
"viewName": "cart",
"URL": "https://alloyio.com/personalizationSpa/cart"
},
"webReferrer": {
"URL": ""
}
},
"device": {
"screenHeight": 800,
"screenWidth": 1280,
"screenOrientation": "landscape"
},
"environment": {
"type": "browser",
"browserDetails": {
"viewportWidth": 1280,
"viewportHeight": 284
}
},
"placeContext": {
"localTime": "2021-12-10T15:50:34.467+02:00",
"localTimezoneOffset": -120
},
"timestamp": "2021-12-10T13:50:34.467Z",
"implementationDetails": {
"name": "https://ns.adobe.com/experience/alloy",
"version": "2.6.2",
"environment": "browser"
}
}
}
]
}
Como solicitar e NÃO renderizar automaticamente as ofertas do Target de Carregamento de Página
Uso da at.js
Há duas maneiras de disparar uma chamada para o Edge Target que busca ofertas para carregamento de página.
Exemplo 1:
adobe.target.getOffer({
mbox: "target-global-mbox",
success: console.log,
error: console.error
});
Exemplo 2:
adobe.target.getOffers({
request: {
execute: {
pageLoad: {}
}
}
})
.then(console.log)
.catch(console.error);
Usando o Platform Web SDK
Execute um comando sendEvent
com um escopo especial em decisionScopes
: __view__
. Adobe usa este escopo como um sinal para buscar todas as atividades de carregamento de página de Target e realizar uma busca prévia de todas as exibições. O Platform Web SDK também tenta avaliar todas as atividades baseadas em visualização do VEC. No momento, não há suporte para a desabilitação da pré-busca de exibição no Platform Web SDK.
Para acessar qualquer conteúdo de personalização, você pode fornecer uma função de retorno de chamada, que será chamada depois que o SDK receber uma resposta bem-sucedida do servidor. Seu retorno de chamada recebe um objeto de resultado, que pode conter propriedades de apresentações contendo qualquer conteúdo de personalização retornado.
Exemplo:
alloy("sendEvent", {
xdm: {...},
decisionScopes: ["__view__"]
}).then(function(result) {
if (result.propositions) {
result.propositions.forEach(proposition => {
proposition.items.forEach(item => {
if (item.schema === HTML_SCHEMA) {
// manually apply offer
document.getElementById("form-based-offer-container").innerHTML =
item.data.content;
const executedPropositions = [
{
id: proposition.id,
scope: proposition.scope,
scopeDetails: proposition.scopeDetails
}
];
// manually send the display notification event, so that Target/Analytics impressions aare increased
alloy("sendEvent",{
"xdm": {
"eventType": "decisioning.propositionDisplay",
"_experience": {
"decisioning": {
"propositions": executedPropositions
}
}
}
});
}
});
});
}
});
Como solicitar mboxes específicas do Target com base em formulário
Uso da at.js
Você pode obter f atividades usando a função getOffer
:
Exemplo 1:
adobe.target.getOffer({
mbox: "hero-banner",
success: console.log,
error: console.error
});
Exemplo 2:
adobe.target.getOffers({
request: {
execute: {
mboxes: [
{
index: 0,
name: "hero-banner"
}]
}
}
})
.then(console.log)
.catch(console.error);
Usando o Platform Web SDK
Você pode buscar Form-Based Composer atividades com base em usando o comando sendEvent
e passando os nomes da mbox na opção decisionScopes
. O comando sendEvent
retorna uma promessa que é resolvida com um objeto que contém as atividades/propostas solicitadas:
Este trecho de código é a aparência da matriz propositions
:
[
{
"id": "AT:eyJhY3Rpdml0eUlkIjoiNDM0Njg5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
"scope": "hero-banner",
"scopeDetails": {
"decisionProvider": "TGT",
"activity": {
"id": "434689"
},
"experience": {
"id": "0"
},
"strategies": [
{
"algorithmID": "0",
"trafficType": "0"
}
],
"characteristics": {
"eventToken": "2lTS5KA6gj4JuSjOdhqUhGqipfsIHvVzTQxHolz2IpTMromRrB5ztP5VMxjHbs7c6qPG9UF4rvQTJZniWgqbOw=="
}
},
"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": "hero-banner",
"scopeDetails": {
"decisionProvider": "TGT",
"activity": {
"id": "434689"
},
"characteristics": {
"eventToken": "E0gb6q1+WyFW3FMbbQJmrg=="
}
},
"items": [
{
"id": "434689",
"schema": "https://ns.adobe.com/personalization/measurement",
"data": {
"type": "click",
"format": "application/vnd.adobe.target.metric"
}
}
]
}
]
Exemplo:
alloy("sendEvent", {
xdm: { ...},
decisionScopes: ["hero-banner"]
}).then(function (result) {
var propositions = result.propositions;
if (propositions) {
// Find the discount proposition, if it exists.
for (var i = 0; i < propositions.length; i++) {
var proposition = propositions[i];
for (var j = 0; j < proposition.items; j++) {
var item = proposition.items[j];
if (item.schema === HTML_SCHEMA) {
// apply offer
document.getElementById("form-based-offer-container").innerHTML =
item.data.content;
const executedPropositions = [
{
id: proposition.id,
scope: proposition.scope,
scopeDetails: proposition.scopeDetails
}
];
alloy("sendEvent", {
"xdm": {
"eventType": "decisioning.propositionDisplay",
"_experience": {
"decisioning": {
"propositions": executedPropositions
}
}
}
});
}
}
}
}
});
Como aplicar as atividades de Target
Uso da at.js
Você pode aplicar as atividades Target usando a função applyOffers
: adobe.target.applyOffer(options).
Exemplo:
adobe.target.getOffers({...})
.then(response => adobe.target.applyOffers({ response: response }))
.then(() => console.log("Success"))
.catch(error => console.log("Error", error));
Saiba mais sobre o comando applyOffers
na documentação dedicada.
Usando o Platform Web SDK
Você pode aplicar as atividades Target usando o comando applyPropositions
.
Exemplo:
alloy("applyPropositions", {
propositions: [...]
});
Saiba mais sobre o comando applyPropositions
na documentação dedicada.
Como rastrear eventos
Uso da at.js
Você pode rastrear eventos usando a função trackEvent
ou sendNotifications.
Essa função aciona uma solicitação para relatar ações do usuário, como cliques e conversões. Esta função não fornece atividades na resposta.
Exemplo 1
adobe.target.trackEvent({
"type": "click",
"mbox": "some-mbox"
});
Exemplo 2
adobe.target.sendNotifications({
request: {
notifications: [{
...,
mbox: {
name: "some-mbox"
},
type: "click",
...
}]
}
});
Usando o Platform Web SDK
Você pode rastrear eventos e ações do usuário chamando o comando sendEvent
, preenchendo o _experience.decisioning.propositions
XDM fieldgroup
e definindo o eventType
como um de dois valores:
decisioning.propositionDisplay
: Sinaliza a renderização da atividade Target.decisioning.propositionInteract
: Sinaliza uma interação do usuário com a atividade, como um clique do mouse.
O _experience.decisioning.propositions
XDM fieldgroup
é uma matriz de objetos. As propriedades de cada objeto são derivadas do result.propositions
que é retornado no comando sendEvent
: { id, scope, scopeDetails }.
Exemplo 1 - Rastrear um evento decisioning.propositionDisplay
após renderizar uma atividade
alloy("sendEvent", {
xdm: {},
decisionScopes: ['discount']
}).then(function(result) {
var propositions = result.propositions;
var discountProposition;
if (propositions) {
// Find the discount proposition, if it exists.
for (var i = 0; i < propositions.length; i++) {
var proposition = propositions[i];
if (proposition.scope === "discount") {
discountProposition = proposition;
break;
}
}
}
if (discountProposition) {
// Find the item from proposition that should be rendered.
// Rather than assuming there a single item that has HTML
// content, find the first item whose schema indicates
// it contains HTML content.
for (var j = 0; j < discountProposition.items.length; j++) {
var discountPropositionItem = discountProposition.items[i];
if (discountPropositionItem.schema === "https://ns.adobe.com/personalization/html-content-item") {
var discountHtml = discountPropositionItem.data.content;
// Render the content
var dailySpecialElement = document.getElementById("daily-special");
dailySpecialElement.innerHTML = discountHtml;
// For this example, we assume there is only a single place to update in the HTML.
break;
}
}
// Send a "decisioning.propositionDisplay" event signaling that the proposition has been rendered.
alloy("sendEvent", {
"xdm": {
"eventType": "decisioning.propositionDisplay",
"_experience": {
"decisioning": {
"propositions": [{
"id": id,
"scope": scope,
"scopeDetails": scopeDetails
}],
"propositionEventType": {
"display": 1
}
}
}
}
});
}
});
Exemplo 2 - Rastrear um evento decisioning.propositionInteract
após a ocorrência de uma métrica de cliques
alloy("sendEvent", {
xdm: { ...},
decisionScopes: ["hero-banner"]
}).then(function (result) {
var propositions = result.propositions;
if (propositions) {
// Find the discount proposition, if it exists.
for (var i = 0; i < propositions.length; i++) {
var proposition = propositions[i];
for (var j = 0; j < proposition.items.length; j++) {
var item = proposition.items[j];
if (item.schema === "https://ns.adobe.com/personalization/measurement") {
// add metric to the DOM element
const button = document.getElementById("form-based-click-metric");
button.addEventListener("click", event => {
const executedPropositions = [
{
id: proposition.id,
scope: proposition.scope,
scopeDetails: proposition.scopeDetails
}
];
// send the click track event
alloy("sendEvent", {
"xdm": {
"eventType": "decisioning.propositionInteract",
"_experience": {
"decisioning": {
"propositions": executedPropositions
}
}
}
});
});
}
}
}
}
});
Exemplo 3 - Rastrear um evento disparado após executar uma ação
Este exemplo rastreia um evento que foi acionado após a execução de uma ação específica, como clicar em um botão.
Você pode adicionar outros parâmetros personalizados por meio do objeto de dados __adobe.target
.
Você também pode adicionar o objeto XDM commerce
.
alloy("sendEvent", {
"xdm": {
"_experience": {
"decisioning": {
"propositions": [
{
"scope": "orderConfirm" //example scope name
}
],
"propositionEventType": {
"display": 1
}
}
},
"eventType": "decisioning.propositionDisplay"
},
"commerce": {
"order": {
"purchaseID": "a8g784hjq1mnp3",
"purchaseOrderNumber": "VAU3123",
"currencyCode": "USD",
"priceTotal": 999.98
}
},
"data": {
"__adobe": {
"target": {
"pageType": "Order Confirmation",
"user.categoryId": "Insurance"
}
}
}
})
Como acionar uma alteração de exibição em um Aplicativo de página única
Uso da at.js
Use a função adobe.target.triggerView
. Essa função pode ser chamada sempre que uma nova página é carregada ou quando um componente em uma página é renderizado novamente. A função adobe.target.triggerView()
deve ser implementada para aplicativos de página única (SPAs) para usar o Visual Experience Composer (VEC) para criar atividades do A/B Test e do Experience Targeting (XT). Se adobe.target.triggerView()
não estiver implementado no site, o VEC não poderá ser usado para SPAs.
Exemplo
adobe.target.triggerView("homeView")
Usando o Platform Web SDK
Para acionar ou sinalizar um aplicativo de página única View Change, defina a propriedade web.webPageDetails.viewName
na opção xdm
do comando sendEvent
. O Platform Web SDK verifica o cache de exibição. Se houver ofertas para o viewName
especificado em sendEvent
, ele as executará e enviará um evento de notificação de exibição.
Exemplo
alloy("sendEvent", {
renderDecisions: true,
xdm:{
web:{
webPageDetails:{
viewName: "homeView"
}
}
}
});
Como aproveitar o Response Tokens
O conteúdo do Personalization retornado de Target inclui tokens de resposta. Os tokens de resposta são detalhes sobre a atividade, oferta, experiência, perfil do usuário, informações geográficas e muito mais. Esses detalhes podem ser compartilhados com ferramentas de terceiros ou usados para depuração. Os tokens de resposta podem ser configurados na interface do usuário Target.
Uso da at.js
Use eventos personalizados da at.js para ouvir a resposta do Target e ler os tokens de resposta.
Exemplo
document.addEventListener(adobe.target.event.REQUEST_SUCCEEDED, function(e) {
console.log("Request succeeded", e.detail);
});
Usando o Platform Web SDK
Os tokens de resposta são retornados como parte de propositions
, que são expostos no resultado do comando sendEvent
. Cada proposta contém uma matriz de items,
e cada item tem um objeto meta
preenchido com tokens de resposta se eles estiverem habilitados na interface do administrador Target. Saiba mais
Exemplo
alloy("sendEvent", {
renderDecisions: true,
xdm: {}
}).then(function(result) {
if (result.propositions) {
// Format of result.propositions:
/*
[
{
"id": "",
"scope": "",
"items": [
{
"id": "",
"schema": "",
"data": {},
"meta": { // RESPONSE TOKENS
"activity.name": ...,
"offer.id": ...,
"profile.activeActivities": ...
}
}
],
"scopeDetails": {}
"renderAttempted": false
}
]
*/
}
});
Como gerenciar a cintilação
Uso da at.js
Usando a at.js, você pode gerenciar a cintilação definindo bodyHidingEnabled: true
para que a at.js seja a pessoa que cuidará disso
pré-ocultar os contêineres personalizados antes de buscar e aplicar as alterações do DOM.
As seções de página que contêm conteúdo personalizado podem ser pré-ocultas substituindo a at.js bodyHiddenStyle.
Por padrão, bodyHiddenStyle
oculta todo o HTML body.
Ambas as configurações podem ser substituídas usando window.targetGlobalSettings.
window.targetGlobalSettings
deve ser colocado antes de carregar a at.js.
Usando o Platform Web SDK
Usando o Platform Web SDK, o cliente pode definir seu estilo de pré-ocultação no comando de configuração, como no exemplo a seguir:
alloy("configure", {
datastreamId: "configurationId",
orgId: "orgId@AdobeOrg",
debugEnabled: true,
prehidingStyle: "body { opacity: 0 !important }"
});
Ao carregar o Platform Web SDK assíncrono, Adobe recomenda que o seguinte trecho seja inserido na página antes da inserção de Platform Web SDK:
<script>
!function(e,a,n,t){
if (a) return;
var i=e.head;if(i){
var o=e.createElement("style");
o.id="alloy-prehiding",o.innerText=n,i.appendChild(o),
setTimeout(function(){o.parentNode&&o.parentNode.removeChild(o)},t)}}
(document, document.location.href.indexOf("adobe_authoring_enabled") !== -1, "body { opacity: 0 !important }", 3000);
</script>
Como o A4T está sendo tratado
Uso da at.js
Há dois tipos de registro A4T compatíveis com o at.js:
- Registro do Analytics no lado do cliente
- Registro do lado do servidor do Analytics
Registro do Analytics no lado do cliente
Exemplo 1: Usando Target Configuração Global
O registro de log do cliente do Analytics pode ser habilitado definindo-se analyticsLogging: client_side
nas configurações da at.js ou substituindo-se o objeto window.targetglobalSettings
.
Quando essa opção é configurada, o formato da carga retornada é semelhante ao seguinte:
{
"analytics": {
"payload": {
"pe": "tnt",
"tnta": "167169:0:0|0|100,167169:0:0|2|100,167169:0:0|1|100"
}
}
}
A carga pode ser encaminhada para Analytics por meio de Data Insertion API.
Exemplo 2: configurando-o em cada função getOffers
:
adobe.target.getOffers({
request: {
experienceCloud: {
analytics: {
logging: "client_side"
}
},
prefetch: {
mboxes: [{
index: 0,
name: "a1-serverside-xt"
}]
}
}
})
.then(console.log)
Este trecho de código é a aparência da carga de resposta:
{
"prefetch": {
"mboxes": [{
"index": 0,
"name": "a1-serverside-xt",
"options": [{
"content": "<img src=\"http://s7d2.scene7.com/is/image/TargetAdobeTargetMobile/L4242-xt-usa?tm=1490025518668&fit=constrain&hei=491&wid=980&fmt=png-alpha\"/>",
"type": "html",
"eventToken": "n/K05qdH0MxsiyH4gX05/2qipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q==",
"responseTokens": {
"profile.memberlevel": "0",
"geo.city": "bucharest",
"activity.id": "167169",
"experience.name": "USA Experience",
"geo.country": "romania"
}
}],
"analytics": {
"payload": {
"pe": "tnt",
"tnta": "167169:0:0|0|100,167169:0:0|2|100,167169:0:0|1|100"
}
}
}]
}
}
A carga Analytics (token tnta
) deve ser incluída na ocorrência Analytics usando a API de Inserção de Dados.
Registro do lado do servidor do Analytics
O log do Servidor do Analytics pode ser habilitado ao configurar analyticsLogging: server_side
nas configurações da at.js ou ao substituir o objeto window.targetglobalSettings
.
Em seguida, os dados fluem da seguinte maneira:
Usando o Platform Web SDK
O Web SDK também é compatível com:
- Registro do Analytics no lado do cliente
- Registro do Analytics Server Side
Log do lado do cliente do Analytics
O Log do Lado do Cliente Analytics é habilitado quando Adobe Analytics é desabilitado para essa configuração de DataStream.
O cliente tem acesso ao token Analytics (tnta
) que precisa ser compartilhado com Analytics usando a API de Inserção de Dados encadeando o comando sendEvent
e iterando através da matriz de propostas resultante.
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 = results.propositions[i];
var renderAttempted = proposition.renderAttempted;
if (renderAttempted === true) {
var analyticsPayload = getAnalyticsPayload(proposition);
if (analyticsPayload !== undefined) {
analyticsPayloads.add(analyticsPayload);
}
}
}
var analyticsPayloadsToken = concatenateAnalyticsPayloads(analyticsPayloads);
// send the page view Analytics hit with collected Analytics payload using Data Insertion API
});
Este é um diagrama para mostrar como os dados fluem quando o Analytics Client Side está habilitado:
Registro do lado do servidor do Analytics
O Log do Lado do Servidor do Analytics é habilitado quando Analytics é habilitado para essa configuração de DataStream.
Quando o Log do Lado do Servidor Analytics está habilitado, a carga do A4T que precisa ser compartilhada com Analytics para que os relatórios Analytics mostrem impressões e conversões corretas são compartilhadas no nível do Edge Network, para que o cliente não precise fazer nenhum processamento adicional.
Veja como os dados fluem para os sistemas quando o registro do Server Side Analytics está ativado:
Como definir Configurações Globais de Target
Uso da at.js
Você pode substituir as configurações na biblioteca at.js usando window.targetGlobalSettings,
em vez de definir as configurações na interface do usuário Target ou usar REST APIs.
A substituição deve ser definida antes que a at.js seja carregada ou em Administração > Implementação > Editar configurações da at.js > Configurações de código > Cabeçalho da biblioteca.
Exemplo:
window.targetGlobalSettings = {
timeout: 200, // using custom timeout
visitorApiTimeout: 500, // using custom API timeout
enabled: document.location.href.indexOf('https://www.adobe.com') >= 0 // enabled ONLY on adobe.com
};
Usando o Platform Web SDK
Este recurso não tem suporte no Web SDK.
Como atualizar os atributos do perfil do Target
Uso da at.js
Exemplo 1
adobe.target.getOffer({
mbox: "target-global-mbox",
params: {
"profile.name": "test",
"profile.gender": "female"
},
success: console.log,
error: console.error
});
Exemplo 2
adobe.target.getOffers({
request: {
execute: {
pageLoad: {
profileParameters: {
name: "test",
gender: "female"
}
}
}
}
})
.then(console.log)
.catch(console.error);
Usando o Platform Web SDK
Para atualizar um perfil Target, use o comando sendEvent
e defina a propriedade data.__adobe.target
, prefixando os nomes de chave com profile.
Exemplo
alloy("sendEvent", {
renderDecisions: true,
data: {
__adobe: {
target: {
"profile.gender": "female",
"profile.age": 30
}
}
}
});
Como usar o Target Recommendations
Uso da at.js
Exemplo 1
adobe.target.getOffer({
mbox: "target-global-mbox",
params: {
"entity.name": "T-shirt",
"entity.id": "1234"
},
success: console.log,
error: console.error
});
Exemplo 2
adobe.target.getOffers({
request: {
execute: {
pageLoad: {
parameters: {
"entity.name": "T-shirt",
"entity.id": "1234"
}
}
}
}
})
.then(console.log)
.catch(console.error);
Usando o Platform Web SDK
Para enviar dados de Recommendations, use o comando sendEvent
e defina a propriedade data.__adobe.target
, prefixando os nomes de chave com entity.
Exemplo
alloy("sendEvent", {
renderDecisions: true,
data: {
__adobe: {
target: {
"entity.name": "T-shirt",
"entity.id": "1234"
}
}
}
});
Como usar IDs de terceiros
Uso da at.js
Ao usar a at.js, há várias maneiras de enviar mbox3rdPartyId
, usando getOffer,
ou getOffers
:
Exemplo 1
adobe.target.getOffer({
mbox:"test",
params:{
"mbox3rdPartyId": "1234"
},
success: console.log,
error: console.error
});
Exemplo 2
adobe.target.getOffers({
request: {
id:{
thirdPartyId: "1234"
},
execute: {
pageLoad: {}
}
}
})
.then(console.log)
.catch(console.error);
Ou há uma maneira de configurar o mbox3rdPartyId
em targetPageParams
ou targetPageParamsAll.
Ao configurar targetPageParams
, ele envia as solicitações para target-global-mbox
também conhecidas como pag-lLoad
.
A recomendação deve ser definida usando targetPageParamsAll
, pois será enviada a cada solicitação Target. A vantagem de usar o targetPageParamsAll
é que você pode definir o mbox3rdPartyId
na página uma vez para garantir que todas as solicitações Target tenham o mbox3rdPartyId.
correto
window.targetPageParamsAll = function() {
return {
"mbox3rdPartyId": "1234"
};
};
window.targetPageParams = function() {
return {
"mbox3rdPartyId": "1234"
};
};
Usando o Platform Web SDK
Platform Web SDK dá suporte a Target ID de Terceiros. No entanto, requer mais algumas etapas.
O Mapa de identidade permite que os clientes enviem várias identidades. Todas as identidades têm namespace. Cada namespace pode ter uma ou mais identidades. Uma identidade específica pode ser marcada como primária. Com esse conhecimento em mente, você pode ver quais são as etapas necessárias para configurar o Platform Web SDK para usar a ID de terceiros do Target.
- Configure o namespace que contém a ID de terceiros Target na página de configuração da sequência de dados:
- Envie esse namespace de identidade em cada comando
sendEvent
como este:
alloy("sendEvent", {
"renderDecisions": true,
"xdm": {
"identityMap": {
"TGT3PID": [
{
"id": "1234",
"primary": true
}
]
}
}
});
Como definir tokens de propriedade
Uso da at.js
Usando a at.js, há duas maneiras de configurar os tokens de propriedade: usar targetPageParams
ou targetPageParamsAll.
Usar targetPageParams
adiciona o token de propriedade à chamada target-global-mbox
, mas usar targetPageParamsAll
adiciona o token a todas as chamadas Target:
Exemplo 1
window.targetPageParamsAll = function() {
return {
"at_property": "1234"
};
};
Exemplo 2
window.targetPageParams = function() {
return {
"at_property": "1234"
};
};
Usando o Platform Web SDK
Os clientes que usam o Platform Web SDK podem definir a propriedade em um nível superior, ao definir a configuração da sequência de dados, no namespace Adobe Target:
Isso significa que cada chamada Target para essa configuração específica do Fluxo de Dados contém esse token de propriedade.
Como realizar uma busca prévia de mboxes
Uso da at.js
Essa funcionalidade está disponível somente na at.js 2.x. A at.js 2.x tem uma nova função chamada getOffers
. A função getOffers
permite que os clientes busquem previamente conteúdo para uma ou mais mboxes. Exemplo:
adobe.target.getOffers({
request: {
prefetch: {
mboxes: [{
index: 0,
name: "test-mbox",
parameters: {
...
},
profileParameters: {
...
}
}]
}
}
})
.then(console.log)
.catch(console.error);
mbox
na matriz mboxes
tenha seu próprio índice. Normalmente, a primeira mbox tem index=0
a próxima index=1,
e assim por diante.Usando o Platform Web SDK
No momento, não há suporte para esta funcionalidade no Platform Web SDK.
Como depurar minha implementação do Target
Uso da at.js
A biblioteca at.js expõe estes recursos de depuração:
- Desabilitação de Mbox - desabilitação de Target da busca e renderização para verificação de quebra de página sem Target interações
- Depuração da mbox - a at.js registra cada ação
- Rastreamento de Destino - com um token de rastreamento de mbox gerado em um objeto de rastreamento com detalhes que participaram do processo de decisão está disponível no objeto
window.___target_trace
.
Usando o Platform Web SDK
Você tem vários recursos de depuração ao usar o Platform Web SDK:
- Usando o Assurance
- Depuração do Web SDK habilitada
- Usar ganchos de monitoramento do Web SDK
- Usar Adobe Experience Platform Debugger
- Rastreamento de destino