Show Menu
TEMAS×

targetGlobalSettings()

En lugar de definir la configuración en la interfaz de usuario Standard/Premium de Target, puede reemplazar la configuración de la biblioteca at.js mediante targetGlobalSettings() o mediante las API de REST.
Hay casos de uso, especialmente cuando at.js se entrega a través de la Dynamic Tag Management (DTM), en que se necesita anular algunas de estas configuraciones.

Configuración

Las configuraciones que se pueden anular son las siguientes:
Configuración
Tipo
Valor predeterminado
Descripción
serverState
Consulte "serverState" a continuación.
Consulte "serverState" a continuación.
Consulte "serverState" a continuación.
clientCode
Cadena
Valor definido en la interfaz de usuario
Representa el código de cliente
serverDomain
Cadena
Valor definido en la interfaz de usuario
Representa el servidor Edge de Target
cookieDomain
Cadena
Si es posible, definirlo en el dominio de primer nivel
Representa el dominio que se usa al guardar las cookies
crossDomain
Cadena
Valor definido en la interfaz de usuario
Indica si el seguimiento entre dominios está activado o no.
Los valores posibles son:
  • disabled
  • enabled
  • x-solamente
timeout
Número
Valor definido en la interfaz de usuario
Representa el tiempo de espera de la solicitud Edge de Target
globalMboxAutoCreate
Booleano
Valor definido en la interfaz de usuario
Indica si la solicitud de mbox global se debe activar o no
visitorApiTimeout
Número
2000 ms = 2 s
Representa el tiempo de espera de la solicitud de la API de visitante
enabled
Booleano
true
Indica si la biblioteca at.js está activada, es decir, si debe ejecutar algo o no. El caso de uso principal de esta configuración son las cookies de exclusión u otras decisiones personalizadas que podrían desactivar las funciones de at.js
defaultContentHiddenStyle
Cadena
visibility: hidden
Solo se usa para ajustar mboxes que utilizan DIV con el nombre de clase “mboxDefault” y que se ejecutan a través de mboxCreate() , mboxUpdate() o mboxDefine() para ocultar contenido predeterminado.
defaultContentVisibleStyle
Cadena
visibility: visible
Solo se usa para ajustar mboxes que utilizan DIV con el nombre de clase “mboxDefault” y que se ejecutan a través de mboxCreate() , mboxUpdate() o mboxDefine() para mostrar la oferta aplicada o el contenido predeterminado.
bodyHiddenStyle
Cadena
body { opacity: 0 }
Solo se usa cuando globalMboxAutocreate === true para minimizar los parpadeos.
Para obtener más información, consulte Cómo gestiona at.js el parpadeo .
bodyHidingEnabled
Booleano
true
Se usa para controlar los parpadeos cuando target-global-mbox se utiliza para publicar ofertas creadas en el Compositor de experiencias visuales, también denominadas ofertas visuales
imsOrgId
Cadena
IMS ORG ID
Representa el id. de organización de IMS
secureOnly
Booleano
false
Indica si at.js debería utilizar solo HTTPS o se le debería permitir alternar entre HTTP y HTTPS según el protocolo de la página.
overrideMboxEdgeServer
Booleano
true (verdadero desde la versión 1.6.2 de at.js)
Indica si se debe utilizar el dominio <clientCode>.tt.omtrdc.net o el mboxedge<clusterNumber>.tt.omtrdc.net .
Si este valor es “true”, el dominio mboxedge<clusterNumber>.tt.omtrdc.net se guarda en una cookie.
overrideMboxEdgeServerTimeout
Número
1860000 => 31 minutos
Indica la duración de la cookie que contiene el valor mboxedge<clusterNumber>.tt.omtrdc.net .
optoutEnabled
Booleano
false
Indica si Target debe llamar a la función isOptedOut() de la API del visitante. Esto forma parte de la habilitación de Device Graph.
selectorsPollingTimeout
Número
5000 ms = 5 s
En la versión 0.9.6 de at.js, Target introdujo este nuevo ajuste que se puede anular mediante targetGlobalSettings .
selectorsPollingTimeout representa cuánto está dispuesto a esperar el cliente para que todos los elementos identificados por selectores aparezcan en la página.
Las actividades creadas por medio del Compositor de experiencias visuales (VEC) tienen ofertas que contienen selectores.
dataProviders
Consulte “Proveedores de datos” a continuación.
Consulte “Proveedores de datos” a continuación.
Consulte “Proveedores de datos” a continuación.

Uso

Esta función puede definirse antes de que se cargue at.js o en Configuración > **Implementación** > **Editar la configuración de at.js** > Configuración del código > Encabezado de la biblioteca .
En el campo Encabezado de la biblioteca se puede introducir JavaScript de formato libre. El código de personalización debe parecerse al del ejemplo siguiente:
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  
};

Proveedores de datos

Esta configuración permite a los clientes recopilar información de proveedores de datos de terceros, como Demandbase, BlueKai y servicios personalizados, y pasar los datos a Target como parámetros de mbox en la solicitud global de mbox. Admite la recopilación de datos de múltiples proveedores a través de solicitudes de desincronización y sincronización. El uso de este enfoque facilita la administración del parpadeo del contenido predeterminado de la página, al tiempo que incluye tiempos de espera independientes para cada proveedor para limitar el impacto en el rendimiento de la página.
Proveedores de datos requiere at.js 1.3 o posterior.
Los vídeos siguientes contienen más información:
Vídeo
Descripción
Proveedores de datos es una funcionalidad que permite pasar fácilmente datos de terceros a Target. Un tercero podría ser un servicio de pronóstico del clima, un DMP o incluso su propio servicio web. Puede usar estos datos para crear audiencias, dirigir contenido y enriquecer el perfil del visitante.
Detalles de implementación y ejemplos de cómo usar la función dataProviders de Adobe Target para recuperar datos de proveedores de datos de terceros y pasarlos en la solicitud de Target.
La configuración window.targetGlobalSettings.dataProviders es una matriz de proveedores de datos.
Cada proveedor de datos tiene la siguiente estructura:
Clave
Tipo
Descripción
name
Cadena
Nombre del proveedor
version
Cadena
Versión del proveedor. Esta clave se usará para la evolución del proveedor.
timeout
Número
Representa el tiempo de espera del proveedor si se trata de una solicitud de red. Esta clave es opcional.
provider
Función
La función que contiene la lógica de búsqueda de datos del proveedor.
La función tiene un solo parámetro requerido: callback . El parámetro de llamada de retorno es una función que debe invocarse solo cuando los datos se han recuperado correctamente o si hay un error.
La devolución de llamada espera dos parámetros:
  • error: indica si ocurrió un error. Si todo está bien, entonces este parámetro debe establecerse en nulo.
  • params: un objeto JSON, que representa los parámetros que se enviarán en una solicitud de Target.
El siguiente ejemplo muestra dónde está utilizando la ejecución de sincronización el proveedor de datos:
var syncDataProvider = { 
  name: "simpleDataProvider", 
  version: "1.0.0", 
  provider: function(callback) { 
    callback(null, {t1: 1}); 
  } 
}; 
  
window.targetGlobalSettings = { 
  dataProviders: [ 
    syncDataProvider 
  ] 
};

Después de que at.js procese window.targetGlobalSettings.dataProviders , la solicitud de Target contiene un nuevo parámetro: t1=1 .
El siguiente es un ejemplo de si los parámetros que desea agregar a la solicitud de Target se obtienen de un servicio de terceros, como BlueKai, Demandbase, y así sucesivamente:
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 
   ] 
};

Después de que at.js procese window.targetGlobalSettings.dataProviders , la solicitud de Target contiene parámetros adicionales: t1=1 , t2=2 y t3=3 .
El siguiente ejemplo utiliza proveedores de datos para recopilar datos de la API meteorológica y enviarlos como parámetros en una solicitud de Target. La solicitud de Target tendrá parámetros adicionales, como country y 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?lang=en"; 
        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] 
    };

Tenga en cuenta lo siguiente al trabajar con la configuración dataProviders :
  • Si los proveedores de datos agregados a window.targetGlobalSettings.dataProviders son asincrónicos, se ejecutarán en paralelo. La solicitud de API del visitante se ejecutará en paralelo con las funciones agregadas a window.targetGlobalSettings.dataProviders para permitir un tiempo de espera mínimo.
  • at.js no intentará almacenar en caché los datos. Si el proveedor de datos obtiene datos solo una vez, el proveedor de datos debe asegurarse de que los datos estén en caché y, cuando se invoque la función del proveedor, sirva los datos de caché para la segunda invocación.

serverState

serverState es una configuración disponible en at.js v2.2+ que se puede utilizar para optimizar el rendimiento de la página cuando se implementa una integración híbrida de Target. La integración híbrida significa que está utilizando at.js v2.2+ en el cliente y la API de entrega o un SDK de Target en el servidor para ofrecer experiencias. serverState proporciona a at.js v2.2+ la capacidad de aplicar experiencias directamente desde el contenido recuperado en el servidor y devuelto al cliente como parte de la página que se está ofreciendo.

Requisitos previos

Debe tener una integración híbrida de Target.

Ejemplos de código

Para comprender mejor cómo funciona esto, vea los ejemplos de código siguientes que tendría en su servidor. El código supone que está utilizando el SDK de Node.js de 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 ...

Un objeto JSON de muestra serverState para ver la recuperación previa tiene el siguiente aspecto:
{
 "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"
    }
   ]
  }
 }
}

Una vez que la página se haya cargado en el explorador, at.js aplica todas las Target ofertas de serverState inmediato, sin activar ninguna llamada de red contra el Target edge. Además, at.js solo oculta los elementos DOM para los que Target las ofertas están disponibles en el servidor de contenido recuperado, lo que tiene un impacto positivo en el rendimiento de carga de página y en la experiencia del usuario final.

Notas importantes

Consider the following when using serverState :
  • En este momento, at.js v2.2 solo admite la entrega de experiencias mediante serverState para:
    • Actividades creadas por VEC que se ejecutan al cargar la página.
    • Vistas previamente recuperadas.
      En el caso de SPA que utilice Target Views y triggerView() la API de at.js, at.js v2.2 almacena en caché el contenido de todas las vistas recuperadas previamente en el servidor y las aplica en cuanto se activa cada vista mediante triggerView() , de nuevo sin activar ninguna llamada de recuperación de contenido adicional en Target.
    • Nota : Actualmente, los mboxes recuperados en el servidor no son compatibles con serverState .
  • Al aplicar serverState ofertas, at.js tiene en cuenta pageLoadEnabled y viewsEnabled la configuración, por ejemplo las ofertas de carga de página, no se aplicará si la pageLoadEnabled configuración es falsa.
    Para activar esta configuración, habilite la opción de alternancia en Ajustes de #.

Recursos adicionales

Para obtener más información sobre cómo serverState funciona, consulte los siguientes recursos: