DocumentaçãoGuia do desenvolvedor do Target

targetGlobalSettings()

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined

Você pode substituir as configurações na biblioteca at.js usando targetGlobalSettings(), em vez de configurá-las na interface do usuário Target ou usar REST APIs.

Configurações

É possível anular pelas seguintes configurações:

aepSandboxId

  • Tipo: String
  • Valor Padrão: nulo
  • Descrição: parâmetro opcional usado para enviar a ID da sandbox Adobe Experience Platform para compartilhar destinos Adobe Experience Platform criados na sandbox não padrão com Target. Se aepSandboxId não for nulo, aepSandboxName também deverá ser fornecido.

aepSandboxName

  • Tipo: String
  • Valor Padrão: nulo
  • Descrição: parâmetro opcional usado para enviar o nome da sandbox Adobe Experience Platform para compartilhar destinos Adobe Experience Platform criados na sandbox não padrão com Target. Se aepSandboxName não for nulo, aepSandboxId também deverá ser fornecido.

artifactLocation

bodyHiddenStyle

  • Tipo: String

  • Valor padrão: corpo

  • Descrição: usado apenas quando globalMboxAutocreate === true para minimizar a chance de cintilação.

    Para obter mais informações, consulte Como o at.js gerencia a cintilação.

bodyHidingEnabled

  • Tipo: Booleano
  • Valor padrão: verdadeiro
  • Descrição: usado para controlar a cintilação quando a target-global-mbox é usada para entregar ofertas criadas no Visual Experience Composer, também conhecido como ofertas visuais.

clientCode

  • Tipo: String
  • Valor padrão: valor definido pela interface do usuário.
  • Descrição: representa o código de cliente.

cookieDomain

  • Tipo: String
  • Valor padrão: se possível, definir como domínio de nível superior.
  • Descrição: representa o domínio usado ao salvar cookies.

crossDomain

  • Tipo: String
  • Valor padrão: valor definido pela interface do usuário.
  • Descrição: indica se o rastreamento de domínio cruzado está ativado ou não. Os valores permitidos dependem da versão da at.js. Para at.js v1.x, especifique se os recursos entre domínios são disabled (navegadores definem cookies somente no seu domínio (cookies próprios)), x only (navegadores definem cookies somente no domínio de Target), ou ambos, selecionando enabled (navegadores definem cookies próprios e de terceiros). Para at.js v2.10 e posterior, especifique se os recursos entre domínios são enabled (os navegadores definem cookies próprios e de terceiros) ou disabled (os navegadores não definem cookies de terceiros).

cspScriptNonce

cspStyleNonce

dataProviders

decisioningMethod

  • Tipo: String

  • Valor padrão: lado do servidor

  • Outros valores: no dispositivo, híbrido

  • Descrição: consulte os Métodos de decisão abaixo.

    Métodos de decisão

    Com a decisão no dispositivo, o Target introduz uma nova configuração chamada Método de decisão que determina como a at.js fornece suas experiências. O decisioningMethod tem três valores: somente do lado do servidor, somente no dispositivo e híbrido. Quando o decisioningMethod é definido no targetGlobalSettings(), ele age como o método de decisão padrão para todas as decisões do Target.

    Somente no lado do servidor:

    Somente no lado do servidor é o método de decisão padrão definido imediatamente quando a at.js 2.5+ é implementada e implantada em suas propriedades da Web.

    Usar somente no lado do servidor como configuração padrão significa que todas as decisões são tomadas na rede de borda Target, o que envolve uma chamada de servidor de bloqueio. Essa abordagem pode apresentar latência incremental, mas também oferece benefícios significativos, como a capacidade de aplicar os recursos de aprendizado de máquina do Target, que incluem as atividades de Recommendations, Automated Personalization (AP) e Direcionamento automático.

    Além disso, aprimorar suas experiências personalizadas usando o perfil de usuário do Target, que é mantido em sessões e canais, pode trazer resultados significativos para sua empresa.

    Por fim, somente no lado do servidor permite usar a Adobe Experience Cloud e refinar públicos-alvo que podem ser direcionados por meio de segmentos Audience Manager e Adobe Analytics.

    Somente no dispositivo:

    Somente no dispositivo é o método de decisão que deve ser definido na at.js 2.5+ quando a tomada de decisão no dispositivo precisar ser usada somente em suas páginas da Web.

    A decisão no dispositivo entrega experiências e atividades de personalização em uma velocidade extremamente rápida, pois as decisões são tomadas a partir de um artefato de regras em cache que contém todas as suas atividades qualificadas para decisões no dispositivo.

    Para saber mais sobre quais atividades se qualificam para decisões no dispositivo, consulte a seção de recursos compatíveis.

    Esse método de decisão deve ser usado somente se o desempenho for altamente crítico em todas as páginas que exigem decisões do Target. Além disso, lembre-se de que, quando esse método de decisão é selecionado, as atividades do Target que não se qualificam para a tomada de decisão no dispositivo não são entregues ou executadas. A biblioteca at.js 2.5+ está configurada para procurar somente pelo artefato de regras em cache para tomar decisões.

    Híbrido:

    O método de decisão híbrido é o que deve ser definido na at.js 2.5+, quando a decisão no dispositivo e as atividades que exigem uma chamada de rede para a rede Edge Adobe Target precisam ser executadas.

    Ao gerenciar atividades de decisão no dispositivo e atividades no lado do servidor, você pode achar complicado e cansativo pensar em como implantar e provisionar o Target em suas páginas. Com o método de decisão híbrido, o Target sabe quando deve fazer uma chamada de servidor para a rede Edge Adobe Target, no caso de atividades que exigem execução no lado do servidor, e quando deve apenas executar decisões no dispositivo.

    O artefato de regras JSON inclui metadados para informar à at.js se uma mbox tem uma atividade do lado do servidor em execução ou uma atividade de decisão no dispositivo. Esse método de decisão garante que as atividades que você pretende entregar rapidamente sejam realizadas por meio de decisões no dispositivo e, para atividades que exigem personalização mais avançada orientada por aprendizado de máquina, essas atividades são realizadas por meio da rede Edge Adobe Target.

defaultContentHiddenStyle

  • Tipo: String
  • Valor padrão: visibilidade: oculto
  • Descrição: usado apenas para mboxes de encapsulamento que usam DIV com nome de classe “mboxDefault” e são executadas por meio de mboxCreate(), mboxUpdate(), ou mboxDefine() para ocultar conteúdo padrão.

defaultContentVisibleStyle

  • Tipo: String
  • Valor padrão: visibilidade: visível
  • Descrição: usado apenas para mboxes de encapsulamento que usam DIV com nome de classe “mboxDefault” e são executadas por meio de mboxCreate(), mboxUpdate(), ou mboxDefine() para revelar uma oferta aplicada, caso exista, ou conteúdo padrão.

deviceIdLifetime

  • Tipo: número
  • Valor padrão: 63244800000 ms = 2 anos
  • Descrição: a quantidade de tempo deviceId é mantida nos cookies.
NOTE
A configuração deviceIdLifetime pode ser substituída na versão 2.3.1 ou posterior da at.js.

ativado

  • Tipo: Booleano

  • Valor padrão: verdadeiro

  • Descrição: quando habilitada, uma solicitação do Target para recuperar experiências e a manipulação de DOM para renderizar as experiências são executadas automaticamente. Além disso, as chamadas do Target podem ser executadas manualmente por meio de getOffer(s) / applyOffer(s).

    Quando desativadas, as solicitações do Target não são executadas automática ou manualmente.

globalMboxAutoCreate

  • Tipo: número
  • Valor padrão: valor definido pela interface do usuário.
  • Descrição: indica se a solicitação global de mbox deve ser disparada ou não.

imsOrgId

  • Tipo: String
  • Valor padrão: verdadeiro
  • Descrição: representa a ID de organização do IMS.

optinEnabled

  • Tipo: Booleano
  • Valor padrão: falso
  • Descrição: o Target oferece suporte à funcionalidade de aceitação por meio da Adobe Experience Platform, para ajudar a apoiar sua estratégia de gerenciamento de consentimento. A funcionalidade de opt-in permite que os clientes controlem como e quando a tag do Target é acionada. Além disso, há uma opção por meio do Adobe Experience Platform para pré-aprovar a tag Target. Para ativar a capacidade de usar a aceitação na biblioteca at.js do Target, você deve adicionar a configuração optinEnabled=true. No Adobe Experience Platform, você deve selecionar "ativar" na lista suspensa Aceitação de GDPR, na exibição de instalação da extensão. Consulte a documentação da Adobe Experience Platform para obter mais detalhes. Para obter mais informações sobre essa configuração, que está relacionada às regulamentações de privacidade e proteção de dados, incluindo o Regulamento Geral sobre a Proteção de Dados (GDPR) da União Europeia e a Lei de Privacidade do Consumidor da Califórnia (CCPA), consulte Regulamentos sobre proteção de dados e privacidade.

optoutEnabled

  • Tipo: Booleano
  • Valor padrão: falso
  • Descrição: indica se Target deve chamar a função da API de Visitante isOptedOut(). Isso é parte da ativação do gráfico de dispositivos.

overrideMboxEdgeServer

  • Tipo: Booleano

  • Valor padrão: verdadeiro (a partir da at.js versão 1.6.2)

  • Descrição: indica se deve-se usar o domínio <clientCode>.tt.omtrdc.net ou o domínio mboxedge<clusterNumber>.tt.omtrdc.net.

    Se este valor for true, o domínio mboxedge<clusterNumber>.tt.omtrdc.net será salvo em um cookie. No momento, não funciona com CNAME ao usar versões da at.js anteriores à 1.8.2 e 2.3.1. Se isso for um problema para você, considere atualizar a at.js para uma versão mais recente e compatível.

overrideMboxEdgeServerTimeout

  • Tipo: número
  • Valor padrão: 1860000 => 31 minutos
  • Descrição: indica o tempo de vida do cookie que contém o valor mboxedge<clusterNumber>.tt.omtrdc.net.

pageLoadEnabled

  • Tipo: Booleano
  • Valor padrão: verdadeiro
  • Descrição: quando ativado, recupera automaticamente as experiências que devem ser retornadas ao carregar a página.

pollingInterval

  • Tipo: número
  • Valor Padrão: 300000 (Cinco minutos em milissegundos)
  • Descrição: intervalo em que a at.js busca uma nova versão de um artefato de decisão no dispositivo e atualiza o cache. 300000 é o valor mínimo permitido para pollingInterval.

secureOnly

  • Tipo: Booleano
  • Valor padrão: falso
  • Descrição: indica se a at.js deve usar somente HTTPS ou se pode alternar entre HTTP e HTTPS com base no protocolo da página. Quando definido como verdadeiro, o secureOnly também define os atributos Secure e SameSite como o cookie da mbox.

selectorsPollingTimeout

  • Tipo: número

  • Valor padrão: 5000 ms = 5 s

  • Descrição: na at.js 0.9.6, o Target apresentou essa nova configuração, que pode ser substituída por meio de targetGlobalSettings.

    A configuração selectorsPollingTimeout representa quanto tempo o cliente está disposto a esperar até que todos os elementos identificados por seletores sejam exibidos na página.

    Atividades criadas pelo Visual Experience Composer (VEC) têm ofertas que contêm seletores.

serverDomain

  • Tipo: String
  • Valor padrão: valor definido pela interface do usuário.
  • Descrição: representa o servidor de borda Target.

serverState

telemetryEnabled

  • Tipo: Booleano
  • Valor padrão: verdadeiro
  • Descrição: quando habilitado, o Adobe coleta dados de uso de recursos do SDK e de telemetria de desempenho. Os dados pessoais não são coletados.

timeout

  • Tipo: número
  • Valor padrão: valor definido pela interface do usuário.
  • Descrição: representa o tempo limite da solicitação da borda do Target.

viewsEnabled viewsenabled

  • Tipo: Booleano
  • Valor padrão: verdadeiro
  • Descrição: quando habilitadas, as exibições são recuperadas automaticamente quando a página é carregada. Quando triggerView é chamado, as exibições aplicáveis são exibidas no navegador. Se esta opção estiver desabilitada, as exibições não serão recuperadas no momento do carregamento da página e triggerView não fará nada. As exibições são compatíveis com a at.js 2.somente x.

visitorApiTimeout

  • Tipo: número
  • Valor padrão: 2000 ms = 2 s
  • Descrição: representa o tempo limite da solicitação da API de visitante.

Uso

Esta função pode 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.

O campo Cabeçalho da biblioteca permite que você entre no JavaScript do formulário gratuito. O código de personalização deve ser semelhante ao seguinte 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
};

Provedores de dados data-providers

Essa configuração permite que clientes reúnam dados de provedores de dados de terceiros, como Demandbase, BlueKai e serviços personalizados, além de enviar os dados para Target como parâmetros da mbox na solicitação global da mbox. Ela é compatível com a coleta de dados de múltiplos provedores via solicitações síncronas e assíncronas. Usar esta abordagem facilita o gerenciamento de cintilação ou conteúdo padrão da página, enquanto inclui tempos limites independentes para cada provedor para limitar o impacto sobre o desempenho da página

NOTE
Os provedores de dados exigem o at.js 1.3 ou posterior.

Os seguintes vídeos contêm mais informações:

Vídeo
Descrição
Uso de provedores de dados do Adobe Target
Os provedores de dados são uma função que permite passar dados de terceiros facilmente para o Target. Um terceiro pode ser um serviço de clima, um DMP ou até mesmo o seu próprio serviço Web. É possível então usar esses dados para criar públicos-alvo, conteúdo de direcionamento e enriquecer o perfil do visitante.
Implementação de provedores de dados no Adobe Target
Detalhes de implementação e exemplos de como usar o recurso dataProviders do Adobe Target para recuperar dados de provedores de dados de terceiros e passá-los na solicitação Target.

A configuração window.targetGlobalSettings.dataProviders é uma matriz de provedores de dados.

Cada provedor de dados tem a seguinte estrutura:

Chave
Tipo
Descrição
name
String
Nome do provedor.
version
String
Versão do provedor. Essa tecla será usada para evolução do provedor.
timeout
Número
Representa o tempo limite do provedor se essa for uma solicitação de rede. Essa tecla é opcional.
provider
Função

A função que contém a lógica de obtenção de dados do provedor.

A função tem um único parâmetro obrigatório: callback. O parâmetro retorno de chamada é uma função que só deve ser invocada quando os dados forem obtidos com êxito ou houver um erro.

O retorno de chamada espera dois parâmetros:

  • error: Indica que ocorreu um erro. Se tudo estiver OK, este parâmetro deve ser definido como nulo.
  • params: um objeto JSON, representando os parâmetros que serão enviados em uma solicitação Target.

O exemplo a seguir mostra onde o provedor de dados está usando a execução sincrônica:

var syncDataProvider = {
  name: "simpleDataProvider",
  version: "1.0.0",
  provider: function(callback) {
    callback(null, {t1: 1});
  }
};

window.targetGlobalSettings = {
  dataProviders: [
    syncDataProvider
  ]
};

Após at.js processar window.targetGlobalSettings.dataProviders, a solicitação Target conterá um novo parâmetro: t1=1.

Veja a seguir um exemplo se os parâmetros que você deseja adicionar à solicitação Target forem obtidos de um serviço de terceiros, como Bluekai, Demandbase e assim por diante:

var blueKaiDataProvider = {
   name: "blueKai",
   version: "1.0.0",
   provider: function(callback) {
      // simulating network request
     setTimeout(function() {
       callback(null, {t1: 1, t2: 2, t3: 3});
     }, 1000);
   }
}

window.targetGlobalSettings = {
   dataProviders: [
      blueKaiDataProvider
   ]
};

Após at.js processar window.targetGlobalSettings.dataProviders, a solicitação Target conterá parâmetros adicionais: t1=1, t2=2 e t3=3.

O exemplo a seguir usa provedores de dados para coletar dados da API de tempo e enviá-los como parâmetros em uma solicitação Target. A solicitação Target terá parâmetros adicionais, como country e weatherCondition.

var weatherProvider = {
      name: "weather-api",
      version: "1.0.0",
      timeout: 2000,
      provider: function(callback) {
        var API_KEY = "caa84fc6f5dc77b6372d2570458b8699";
        var lat = 44.426767399999996;
        var lon = 26.1025384;
        var url = "//api.openweathermap.org/data/2.5/weather?";
        var data = {
          lat: lat,
          lon: lon,
          appId: API_KEY
        }

        $.ajax({
          type: "GET",
                url: url,
          dataType: "json",
          data: data,
          success: function(data) {
            console.log("Weather data", data);
            callback(null, {
              country: data.sys.country,
              weatherCondition: data.weather[0].main
            });
          },
          error: function(err) {
            console.log("Error", err);
            callback(err);
          }
        });
      }
    };

    window.targetGlobalSettings = {
      dataProviders: [weatherProvider]
    };

Leve em consideração o seguinte ao trabalhar com a configuração dataProviders:

  • Se os provedores de dados adicionados a window.targetGlobalSettings.dataProviders forem assíncronos, serão executados em paralelo. A solicitação da API de visitante será executada em paralelo com funções adicionadas a window.targetGlobalSettings.dataProviders para permitir um tempo mínimo de espera.
  • at.js não tentará armazenar os dados em cache. Se o provedor de dados obtiver os dados apenas uma vez, deverá certificar-se de que os dados estão armazenados em cache e, quando a função de provedor for invocada, servir os dados do cache para a segunda invocação.

Política de segurança de conteúdo

O at.js 2.3.0+ oferece suporte à configuração de nonces da Política de segurança de conteúdo nas tags SCRIPT e STYLE, que são inseridas no DOM da página ao aplicar ofertas Target entregues.

Os nonces de SCRIPT e STYLE devem ser definidos em targetGlobalSettings.cspScriptNonce e targetGlobalSettings.cspStyleNonce correspondentemente, antes do carregamento da at.js 2.3.0+. Veja um exemplo abaixo:

...
<head>
 <script nonce="<script_nonce_value>">
window.targetGlobalSettings = {
  cspScriptNonce: "<csp_script_nonce_value>",
  cspStyleNonce: "<csp_style_nonce_value>"
};
 </script>
 <script nonce="<script_nonce_value>" src="at.js"></script>
...
</head>
...

Depois que as configurações cspScriptNonce e cspStyleNonce são especificadas, a at.js 2.3.0+ as define como atributos nonce em todas as marcas SCRIPT e STYLE inseridas no DOM ao aplicar ofertas Target.

Personalização híbrida

O serverState é uma configuração disponível na at.js v2.2+ que pode ser usada para otimizar o desempenho da página quando uma integração híbrida do Target é implementada. A integração híbrida significa que você está usando a at.js v2.2+ no lado do cliente e a API de entrega ou um SDK do Target no lado do servidor para fornecer experiências. O serverState fornece ao at.js v2.2+ a capacidade de aplicar experiências diretamente de conteúdo buscado no lado do servidor e retornado ao cliente como parte da página que está sendo veiculada.

Pré-requisitos

Você deve ter uma integração híbrida do Target.

Amostras de código

Para entender melhor como isso funciona, veja abaixo os exemplos de código que você teria no servidor. O código presume que você está usando o SDK Node.js do Target.

// First, we fetch the offers via Target Node.js SDK API, as usual
const targetResponse = await targetClient.getOffers(options);
// A successfull response will contain Target Delivery API request and response objects, which we need to set as serverState
const serverState = {
  request: targetResponse.request,
  response: targetResponse.response
};
// Finally, we should set window.targetGlobalSettings.serverState in the returned page, by replacing it in a page template, for example
const PAGE_TEMPLATE = `
<!doctype html>
<html>
<head>
  ...
  <script>
    window.targetGlobalSettings = {
      overrideMboxEdgeServer: true,
      serverState: ${JSON.stringify(serverState, null, " ")}
    };
  </script>
  <script src="at.js"></script>
</head>
...
</html>
`;
// Return PAGE_TEMPLATE to the client ...

Uma amostra de serverState do objeto JSON para pré-busca de visualização é exibida da seguinte maneira:

{
 "request": {
  "requestId": "076ace1cd3624048bae1ced1f9e0c536",
  "id": {
   "tntId": "08210e2d751a44779b8313e2d2692b96.21_27"
  },
  "context": {
   "channel": "web",
   "timeOffsetInMinutes": 0
  },
  "experienceCloud": {
   "analytics": {
    "logging": "server_side",
    "supplementalDataId": "7D3AA246CC99FD7F-1B3DD2E75595498E"
   }
  },
  "prefetch": {
   "views": [
    {
     "address": {
      "url": "my.testsite.com/"
     }
    }
   ]
  }
 },
 "response": {
  "status": 200,
  "requestId": "076ace1cd3624048bae1ced1f9e0c536",
  "id": {
   "tntId": "08210e2d751a44779b8313e2d2692b96.21_27"
  },
  "client": "testclient",
  "edgeHost": "mboxedge21.tt.omtrdc.net",
  "prefetch": {
   "views": [
    {
     "name": "home",
     "key": "home",
     "options": [
      {
       "type": "actions",
       "content": [
        {
         "type": "setHtml",
         "selector": "#app > DIV.app-container:eq(0) > DIV.page-container:eq(0) > DIV:nth-of-type(2) > SECTION.section:eq(0) > DIV.container:eq(1) > DIV.heading:eq(0) > H1.title:eq(0)",
         "cssSelector": "#app > DIV:nth-of-type(1) > DIV:nth-of-type(1) > DIV:nth-of-type(2) > SECTION:nth-of-type(1) > DIV:nth-of-type(2) > DIV:nth-of-type(1) > H1:nth-of-type(1)",
         "content": "<span style=\"color:#FF0000;\">Latest</span> Products for 2020"
        }
       ],
       "eventToken": "t0FRvoWosOqHmYL5G18QCZNWHtnQtQrJfmRrQugEa2qCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q==",
       "responseTokens": {
        "profile.memberlevel": "0",
        "geo.city": "dublin",
        "activity.id": "302740",
        "experience.name": "Experience B",
        "geo.country": "ireland"
       }
      }
     ],
     "state": "J+W1Fq18hxliDDJonTPfV0S+mzxapAO3d14M43EsM9f12A6QaqL+E3XKkRFlmq9U"
    }
   ]
  }
 }
}

Depois que a página é carregada no navegador, a at.js aplica todas as ofertas do Target de serverState imediatamente, sem disparar chamadas de rede para a borda do Target. Além disso, a at.js pré-oculta apenas os elementos DOM para os quais as ofertas do Target estão disponíveis no conteúdo no lado do servidor, afetando positivamente o desempenho de carregamento da página e a experiência do usuário final.

Observações importantes

Considere o seguinte ao usar serverState:

  • No momento, a at.js v2.2 oferece suporte somente para experiências entregues via serverState para:

    • Atividades criadas pelo VEC que são executadas no carregamento da página.

    • Exibições pré-buscadas.

      No caso de SPA usar Target Exibições e triggerView() na API da at.js, a at.js v2.2 armazena em cache o conteúdo de todas as Exibições pré-buscadas no lado do servidor e as aplica assim que cada Exibição é acionada por meio de triggerView(), novamente sem disparar chamadas adicionais de busca de conteúdo para Target.

    • Observação: Atualmente, as mboxes recuperadas no lado do servidor não são compatíveis com o serverState.

  • Ao aplicar as ofertas do serverState, a at.js considera as configurações pageLoadEnabled e viewsEnabled. Por exemplo, as ofertas de Carregamento de página não serão aplicadas se a configuração pageLoadEnabled for definida como falso.

    Para ativar essas configurações, habilite a alternância em Administração > Implementação > Edição > Carregamento de Página Habilitado.

    Configurações do carregamento de página ativado

  • Se estiver usando serverState e tags de <script> no conteúdo retornado, certifique-se que o conteúdo HTML usa <\/script> em vez de </script>. Se usar </script>, o navegador interpretará </script> como o final de um SCRIPT inline e poderá quebrar a página HTML.

Recursos adicionais

Para saber mais sobre como o serverState funciona, confira os seguintes recursos:

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3