Métodos de API de Data Integration Library
- Temas:
- API
Métodos que le permiten trabajar mediante programación con Data Integration Library (DIL.
Devolver versiones para el DIL
Un método GET
que devuelve una lista de versiones ordenadas de la más antigua a la más reciente.
Solicitud
GET https://api.demdex.com/v1/dil/
Respuesta
Una solicitud correcta devuelve el código de respuesta ["4.0", "4.1"]
como se muestra a continuación.
["4.0", "4.1"]
Devolver el esquema JSON de la versión
Un método GET
que devuelve el esquema JSON para la versión DIL. Admite el uso del alias LATEST para la versión con el fin de obtener la última versión de DIL.
Solicitud
GET https://api.demdex.com/v1/dil/
<version>
Respuesta
Una solicitud correcta devuelve el código de respuesta ["4.0", "4.1"]
y los datos como se muestra a continuación.
{
"type": "object",
"$schema": "https://json-schema.org/draft-03/schema",
"required": true,
"additionalProperties": false,
"properties": {
"core": {
"id": "core",
"required": true,
"type": "object",
"properties": {
"code": {
"type": "boolean",
"required": true,
"id": "code"
},
"instanceVariable": {
"type": "string",
"id": "instanceVariable",
"required": false
},
"create": {
"type": "object",
"id": "create",
"required": false,
"properties": {
"initConfig": {
"additionalProperties": false,
"type": "object",
"id": "initConfig",
"required": true,
"properties": {
"declaredId": {
"id": "declaredId",
"required": false,
"type": "object",
"additionalProperties": false,
"properties": {
"dpid": {
"id": "dpid",
"required": true,
"type": "string"
},
"dpuuid": {
"id": "dpuuid",
"required": true,
"type": "string"
}
}
},
"containerNSID": {
"type": "number",
"id": "containerNSID",
"required": false
},
"disableDestinationPublishingIframe": {
"type": "boolean",
"id": "disableDestinationPublishingIframe",
"required": false
},
"enableErrorReporting": {
"type": "boolean",
"id": "enableErrorReporting",
"required": false
},
"iframeAkamaiHTTPS": {
"type": "boolean",
"id": "iframeAkamaiHTTPS",
"required": false
},
"iframeAttachmentDelay": {
"type": "number",
"id": "iframeAttachmentDelay",
"required": false
},
"mappings": {
"type": "object",
"id": "mappings",
"required": false,
"additionalProperties": {
"type": "string"
}
},
"removeFinishedScriptsAndCallbacks": {
"type": "boolean",
"id": "removeFinishedScriptsAndCallbacks",
"required": false
},
"uuidCookie": {
"type": "object",
"id": "uuidCookie",
"additionalProperties": false,
"required": false,
"properties": {
"days": {
"type": "number",
"id": "days",
"required": false
},
"domain": {
"type": "string",
"id": "domain",
"required": false
},
"name": {
"type": "string",
"id": "name",
"required": true
},
"path": {
"type": "string",
"id": "path",
"required": false
},
"secure": {
"type": "boolean",
"id": "secure",
"required": false
}
}
},
"visitorService": {
"type": "object",
"id": "visitorService",
"required": false,
"properties": {
"namespace": {
"type": "string",
"id": "namespace",
"required": true
}
}
}
}
}
}
}
}
},
"options": {
"id": "options",
"type": "object",
"required": false,
"properties": {
"minify": {
"id": "minify",
"required": false,
"type": "boolean"
}
}
},
"include": {
"type": "object",
"id": "include",
"required": false,
"properties": {
"modules": {
"type": "object",
"id": "modules",
"required": false,
"additionalProperties": false,
"properties": {
"GoogleAnalytics": {
"type": "object",
"id": "GoogleAnalytics",
"required": false,
"properties": {
"code": {
"id": "code",
"type": "boolean",
"required": true
}
}
},
"Peer39": {
"type": "object",
"id": "Peer39",
"required": false,
"properties": {
"code": {
"id": "code",
"type": "boolean",
"required": true
}
}
},
"SiteCatalyst": {
"type": "object",
"id": "SiteCatalyst",
"required": false,
"additionalProperties": false,
"properties": {
"code": {
"type": "boolean",
"id": "code",
"required": true
},
"init": {
"type": "object",
"id": "init",
"required": false,
"additionalProperties": false,
"properties": {
"siteCatalystInstance": {
"type": "string",
"id": "siteCatalystInstance",
"required": true
},
"dilInstance": {
"type": "string",
"id": "dilInstance",
"required": true
},
"trackedVariables": {
"id": "trackedVariables",
"required": false,
"type": "object",
"properties": {
"iteratedNames": {
"type": "array",
"id": "iteratedNames",
"required": false,
"items": {
"type": "object",
"id": "0",
"required": true,
"properties": {
"maxIndex": {
"type": "number",
"id": "maxIndex",
"required": true
},
"name": {
"type": "string",
"id": "name",
"required": true
}
}
}
},
"names": {
"type": "array",
"additionalItems": false,
"id": "names",
"required": false,
"items": [
{
"type": "string",
"required": true
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
},
{
"type": "string",
"required": false
}
]
}
}
}
}
}
}
}
}
},
"tools": {
"type": "object",
"id": "tools",
"required": false,
"additionalProperties": false,
"properties": {
"getMetaTags": {
"type": "boolean",
"id": "getMetaTags",
"required": false
},
"getSearchReferrer": {
"type": "boolean",
"id": "getSearchReferrer",
"required": false
},
"decomposeURI": {
"type": "boolean",
"id": "decomposeURI",
"required": false
}
}
}
}
}
}
}
Generar DIL
Un método GET
que genera DIL basado en el cuerpo de solicitud pasado usando la versión especificada de DIL. Si se usa el alias LATEST
para la versión en la dirección URL, se generará la última versión de DIL.
Solicitud
POST https://api.demdex.com/v1/dil/
<version>
/generate
Solicitud de ejemplo
{
core: {
code: true,
instanceVariable: 'dil_instance',
create: {
initConfig: {
declaredId: {
dpid: '159',
dpuuid: '456'
},
containerNSID: 81,
disableDestinationPublishingIframe: false,
enableErrorReporting: false,
iframeAkamaiHTTPS: false,
iframeAttachmentDelay: 575,
mappings: {
c_k1: 'd_k1',
c_k2: 'd_k2'
},
removeFinishedScriptsAndCallbacks: false,
uuidCookie: {
days: 12,
domain: 'adobe.com',
name: 'adobe_did',
path: '/',
secure: false
},
visitorService: {
namespace: 'demofirst'
}
}
}
},
options: {
minify: true
},
include: {
modules: {
GoogleAnalytics: {
code: true
},
Peer39: {
code: true
},
SiteCatalyst: {
code: true,
init: {
siteCatalystInstance: 'sc_instance',
dilInstance: 'dil_instance',
trackedVariables: {
iteratedNames: [{
name: 'prop',
maxIndex: 5
}, {
name: 'pev',
maxIndex: 3
}],
names: ['pageName', 'channel', 'campaign', 'products', 'events', 'spe', 'spev1', 'spev2', 'spev3']
}
}
}
},
tools: {
getMetaTags: true,
getSearchReferrer: true,
decomposeURI: true
}
}
}
Respuesta
Una actualización correcta devuelve el código de respuesta 201 created
junto con el código DIL JavaScript.