Métodos DIL de nivel de instancia

Las API DIL de nivel de instancia permiten crear y trabajar programáticamente con objetos de Audience Manager. Los métodos de nivel de instancia mejoran la funcionalidad de la API establecida por los métodos de nivel de clase.

Introducción a los métodos de DIL de nivel de instancia

Al trabajar con las API DIL de nivel de instancia:

• Access requiere un nombre de socio y un ID de área de nombres de contenedor (NSID). Póngase en contacto con el administrador de cuentas del Audience Manager para obtener esta información.
• Reemplace cualquier texto cursiva de muestra de la documentación de API por valor, ID u otra variable según lo requiera el método con el que esté trabajando.

señales

Agrega asignaciones de nivel de cliente y plataforma a la cadena de consulta de una solicitud pendiente.

Firma de función: signals: function ({key1:value1, key2:value2},prefix){}

Claves de solicitud reservadas

Las siguientes claves de solicitud están reservadas y no se pueden sobrescribir con este método:

• sids
• pdata
• logdata
• callback
• postCallbackFn
• useImageRequest

Parámetros

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName'
     containerNSID: containerNSID
});

// Method 1
var obj = { key1 : 1, key2 : 2 };
dataLib.api.signals(obj, 'c_').submit();

// Method 2
dataLib.api.signals({c_zdid: 54321}).submit();

// Method 3
// Will send 'c_key=a&c_key=2&c_key=3' to Audience Manager
var obj = { key : ['a', 'b', 'c'] };
dataLib.api.signals(obj, 'c_').submit();

traits

Agrega SID a la cadena de consulta de una solicitud pendiente.

Firma de función: traits:function (sids){}

Parámetros

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var partnerObject = DIL.create({
     partner: 'partner name',
     containerNSID: NSID
});
partnerObject.api.traits([123, 456, 789]);

logs

Agregue datos a los archivos de registro en la solicitud pendiente.

Firma de función: logs: function {key1:value1, key2:value2}

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var partnerObject = DIL.create({
     partner: 'partner',
     containerNSID: NSID
});
partnerObject.api.logs({
     file: 'dil.js',
     message: 'This is the first request'
});

submit

Envía todos los datos pendientes al Audience Manager para la instancia DIL.

Firma de función: submit: function () {}

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([
123,456, 789]).logs({
     file: 'dil.js',
     message: 'This is the first request'
}).signals({
     c_zdid: 1111
     d_dma: 'default'
}).submit();

afterResult

Una función que se ejecuta después de la llamada de retorno de publicación de destino predeterminada.

Firma de función: afterResult: function (fn) {}

Parámetros

Respuesta

Devuelve un objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.signals({
     c_zdid: 54321
     d_dma: 'default'
}).afterResult(function(json){
     //Do something with the JSON data returned from the server.
}).submit();

clearData

Borra todos los datos de una solicitud pendiente.

Firma de función: clearData: function () {}

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([123,456, 789]).logs({
     file: 'dil.js'
     message: 'This is the first request'
}).signals({
     c_zdid: 1111
     d_dma: 'default'
});

//Reset the pending data
dataLib.clearData();

customQueryParams

Agrega parámetros de consulta personalizados que no están definidos explícitamente por el servidor de recopilación de datos a una solicitud pendiente.

Firma de función: customQueryParams: function (obj) {}

Claves de solicitud reservadas

Las siguientes claves de solicitud están reservadas y no se pueden sobrescribir con este método:

• sids
• pdata
• logdata
• callback
• postCallbackFn
• useImageRequest

Respuesta

Devuelve el objeto API de la instancia de DIL actual.

Código de ejemplo

var partnerObject = DIL.create({
     partner: 'partner',
     containerNSID: NSID
});
partnerObject.api.customQueryParams({
     nid: 54231,
     ntype: 'default'
});

getContainerNSID

Devuelve el valor del NSID de contenedor para la instancia DIL. Útil para la depuración y la solución de problemas.

Firma de función: dil.api.getContainerNSID: function () {}

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

//Verify the container NSID
var nsid = dataLib.api.getContainerNSID();

getEventLog

Devuelve datos de registro de eventos ordenados cronológicamente como una matriz de cadenas. Útil para la depuración y la solución de problemas.

Firma de función: dil.api.getEventLog: function () {}

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([123, 456, 789]).logs({
     file: 'dil.js',
     message: 'This is the first request'
});.signals({
     c_zdid: 1111
     d_dma: 'default'
});.submit();

//Check log for messages
var log = dataLib.api.getEventLog();
if (log && log.length) {
     alert(log.join('\n'));
}else{
     alert('No log messages');
}

getPartner

Devuelve el nombre del socio para una instancia DIL. Útil para la depuración y la solución de problemas.

Firma de función: dil.api.getPartner: function () {}

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName'
     containerNSID: containerNSID
});

//Verify the partner name
var partner = dataLib.api.getPartner();

getState

Devuelve el estado de la instancia DIL actual. Útil para la depuración y la solución de problemas.

Firma de función: dil.api.getState: function () {}

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([123, 456, 789]).logs({
     file: 'dil.js',
     message:'This is the first request'
});.signals({
     c.zdid: 1111
     d_dma: 'default'
});.submit();

var state = dataLib.api.getState();

/*Object outline of state
state = {
     pendingRequest: {pending data for call to server},
     otherRequestInfo:{
          firingQueue: [],
          fired: [],
          firing: false,
          errored: [],
          reservedKeys: {
               sids: true,
               pdata: true,
               logdata: true,
               callback: true,
               postCallbackFn: true,
               useImageRequest: true,
          },
          firstRequestHasFired: false,
          num_of_jsonp_responses: 0,
          num_of_jsonp_errors: 0,
          num_of_img_responses: 0,
          num_of_img_errors: 0
     },
     destinationPublishingInfo: {
          THROTTLE_START: 3000,
          throttleTimerSet: false,
          id: ''destination_publishing_iframe_' + partner + '_' + containerNSID,
          url: (constants.isHTTPS ? 'https://' : 'https://fast.') + partner + '.demdex.net/dest3.html?d_nsid='
          ​+ containerNSID + '#' + encodeURIComponent(document.location.href),
               iframe: null,
               iframeHasLoaded: false,
               sendingMessages: false,
               messages: [],
               messageSendingInterval: constants.POST_MESSAGE_ENABLED ? 15: 100,
               //Recommend 100ms for IE 6 & 7, 15ms for other browsers
               jsonProcessed: []
     }
}
*/

idSync

Consiste en dos funciones que permiten a los socios de datos intercambiar y sincronizar ID de usuario entre ellos y el Audience Manager.

Firma de función:

Funciona con DIL versiones 2.10 y 3.1 o superiores.

Elementos de idSync

idSync puede constar de lo siguiente:

Macros

idSync acepta las siguientes macros:

• %TIMESTAMP%: genera una marca de hora (en milésimas de segundo). Se emplea para ignorar la caché.
• %DID%: inserta el ID de Audience Manager para el usuario.
• %HTTP_PROTO%: establece el protocolo de página ( http o https).

Respuesta

Ambas funciones devuelven Successfully queued si se realiza correctamente. Si no, devuelven una cadena con un mensaje de error.

Código de ejemplo

dilInstance.api.idSync(initConfig)

// Fires url with macros replaced
dilInstance.api.idSync({
 dpid: '23', // must be a string
 url: '//su.addthis.com/red/usync?pid=16&puid=%DID%&url=%HTTP_PROTO%%3A%2F%2Fdpm.demdex.net
%2Fibs%3Adpid%3D420%26dpuuid%3D%7B%7Buid%7D%7D',
 minutesToLive: 20160 // optional, defaults to 20160 minutes (14 days)
});

dilInstance.api.aamIdSync(initConfig)

// Fires 'https:/https:' + '//dpm.demdex.net/ibs:dpid=<dpid>&dpuuid=<dpuuid>'
dilInstance.api.aamIdSync({
 dpid: '23', // must be a string
 dpuuid: '98765', // must be a string
 minutesToLive: 20160 // optional, defaults to 20160 minutes (14 days)
});

result

Agrega una llamada de retorno (que recibe JSON) a la solicitud pendiente.

Firma de función: result: function (callback) {}

Esta rellamada reemplaza la rellamada predeterminada que gestiona la publicación de destino.

Parámetros

Respuesta

Devuelve el objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner: 'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([123, 456, 789]).result(function(json){
     //Do something, possibly with the JSON data returned from the server.
});.submit();

secureDataCollection

secureDataCollection es un parámetro booleano que controla cómo se DIL realizan las llamadas a Data Collection Servers (DCS) y Akamai.

• Cuando secureDataCollection= true (predeterminado), DIL siempre realiza llamadas HTTPS seguras.

• Cuando secureDataCollection= false, DIL realiza llamadas HTTP o HTTPS siguiendo el protocolo de seguridad establecido por la página.

var dilInstance = DIL.create({
     ...
     secureDataCollection: false
});

useCORSOnly

useCORSOnly es un parámetro booleano true/false que controla el modo en que el explorador solicita recursos de otros dominios.

Información general

useCORSOnly es false de forma predeterminada. False significa que el explorador puede realizar comprobaciones de recursos con CORS o JSONP. Sin embargo, DIL siempre intenta solicitar recursos con CORS primero. Vuelve a JSONP en navegadores anteriores que no son compatibles con CORS. Si necesita forzar al explorador para que use solo CORS, como con sitios que tienen requisitos de alta seguridad, establezca useCORSOnly:true.

Ejemplo de código

var dilInstance = DIL.create({
     ...
     useCORSOnly: true
});

useImageRequest

Cambia el tipo de solicitud a la imagen <img> desde el script <src>.

Firma de función: useImageRequest: function () {}

Respuesta

Devuelve un objeto API de la instancia DIL actual.

Código de ejemplo

var dataLib = DIL.create({
     partner:'partnerName',
     containerNSID: containerNSID
});

dataLib.api.traits([123, 456, 789]).useImageRequest().submit();