Métodos DIL de nivel de instancia instance-level-dil-methods
Las API de nivel DIL instancia permiten crear y trabajar con objetos Audience Manager mediante programación. Los métodos de nivel instancia mejoran los funcionalidad de API establecidos por los métodos de nivel de clase.
Introducción a los métodos DIL de nivel de instancia get-started-dil-methods
Al trabajar con las API de nivel DIL instancia:
- Access requiere un nombre socio y contenedor ID de espacio de nombres (NSID). Póngase en contacto con su Administrador de cuentas de Audience Manager para obtener esta información.
- Reemplazar cualquier texto en cursiva de muestra en la documentación de API con valor, ID u otras variable según lo requiera el método con el que esté trabajando.
señales signals
Agrega asignaciones de cliente y de nivel de plataforma al cadena de consulta de un solicitud pendiente.
Firma de función: signals: function ({key1:value1, key2:value2},prefix){}
- Puede encadenar otras llamadas de API a este método.
- Si el Adobe Experience Cloud JavaScript biblioteca está en el Página,
submit()
espera a que Cloud establezca un cookie antes de enviar un solicitud.
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
obj
prefix
return
Respuesta
Devuelve el objeto API del instancia actual DIL .
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 traits
Agrega SID al cadena de consulta de un solicitud pendiente.
Firma de función: traits:function (sids){}
Parámetros
sids
Respuesta
Devuelve el objeto API del instancia actual DIL .
Código de ejemplo
var partnerObject = DIL.create({
partner: 'partner name',
containerNSID: NSID
});
partnerObject.api.traits([123, 456, 789]);
trozas logs
añadir datos a los archivos de registro en el solicitud pendiente.
Firma de función: logs: function {key1:value1, key2:value2}
Respuesta
Devuelve el objeto API del instancia actual DIL .
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 submit
Envía todos los datos pendientes a Audience Manager para la DIL instancia.
Firma de función: submit: function () {}
%20
y los puntos y comas como %3B
.Respuesta
Devuelve el objeto API del instancia actual DIL .
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 afterresult
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
fn
Respuesta
Devuelve un objeto API del instancia actual DIL .
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 cleardata
Borra todos los datos de un solicitud pendiente.
Firma de función: clearData: function () {}
Respuesta
Devuelve el objeto API del instancia actual DIL .
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 customqueryparams
Agrega parámetros de consulta personalizados que el servidor recopilación de datos no define explícitamente a un 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 del instancia DIL actual.
Código de ejemplo
var partnerObject = DIL.create({
partner: 'partner',
containerNSID: NSID
});
partnerObject.api.customQueryParams({
nid: 54231,
ntype: 'default'
});
getContainerNSID getcontainernsid
Devuelve el valor del NSID de contenedor para el DIL instancia. Ú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 geteventlog
Devuelve datos de registro de evento 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 getpartner
Devuelve el nombre socio de un DIL instancia. Ú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 getstate
Devuelve el estado del instancia actual DIL . Ú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 idsync
Consta de dos funciones que permiten a los socios de datos intercambiar y sincronizar ID de usuario entre ellos y Audience Manager.
Firma de función:
Funciona con DIL las versiones 2.10 y 3.1 o superior.
dil.Instance.api.idSync(initConfig)
Entre diferentes socios de datos y Audience Manager. Por ejemplo: socio x usaría esto para sincronizar un ID de usuario con socio y luego lo enviaría a Audience Manager.
Importante: Este método está en desuso. Utilice el método del idSyncByURL
Servicio de identidad de Adobe Experience Platform instancia.
dil.Instance.api.aamIdSync(initConfig)
Cuando ya conoce el ID de usuario y desea enviárselo a Audience Manager.
Importante: Este método está en desuso. Utilice el método del idSyncByDataSource
Servicio de identidad de Adobe Experience Platform instancia.
Elementos de idSync
idSync
puede constar de lo siguiente:
dpid
dpuuid
minutesToLive
url
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%
: define el protocolo Página (http
ohttps
).
Respuesta
Ambas funciones se devuelven si se realiza Successfully queued
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)
});
resultado result
Agrega una devolución de llamada (que recibe JSON) al solicitud pendiente.
Firma de función: result: function (callback) {}
Esta devolución de llamada reemplaza a la devolución de llamada predeterminada que gestiona la publicación en destino.
Parámetros
callback
Respuesta
Devuelve el objeto API del instancia actual DIL .
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
secureDataCollection
es un parámetro booleano que controla cómo DIL realiza llamadas a Data Collection Servers (DCS) 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 el Página.
secureDataCollection= false
si utiliza visitorAPI.js y DIL en el mismo Página. Consulte el ejemplo de código que aparece a continuación.
var dilInstance = DIL.create({
...
secureDataCollection: false
});
useCORSOnly usecorsonly
useCORSOnly
es un parámetro booleano true/false que controla la forma 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 solicitud recursos con CORS primero. Vuelve a JSONP en navegadores anteriores que no son compatibles con CORS. Si necesita forzar la explorador a utilizar solo CORS, como en el caso de los sitios que tienen requisitos de alta seguridad, establezca useCORSOnly:true
.
Ejemplo de código
var dilInstance = DIL.create({
...
useCORSOnly: true
});
- Le recomendamos que
useCORSOnly: true
configure solo cuando esté seguro de que los visitantes de su sitio tienen navegadores compatibles con esta función. - Cuando
useCORSOnly: true
, DIL no realizará llamadas de ID desde Internet Explorer versión 9 o posterior.
useImageRequest useimagerequest
Cambia el tipo de solicitud a imagen <img>
desde la secuencia de comandos <src>
.
Firma de función: useImageRequest: function () {}
Respuesta
Devuelve un objeto API del instancia actual DIL .
Código de ejemplo
var dataLib = DIL.create({
partner:'partnerName',
containerNSID: containerNSID
});
dataLib.api.traits([123, 456, 789]).useImageRequest().submit();