DIL-Methoden auf Instanzebene

Mit den APIs auf Instanzebene DIL können Sie Audience Manager-Objekte programmgesteuert erstellen und verwenden. Die Methoden auf Instanzebene erweitern die API-Funktionalität, die von den Methoden auf Klassenebene festgelegt wird.

Erste Schritte mit DIL-Methoden auf Instanzebene

Beim Arbeiten mit den APIs auf Instanzebene DIL:

• Für den Zugriff sind ein Partnername und eine Container-Namespace-ID (NSID) erforderlich. Wenden Sie sich an Ihren Kundenbetreuer, um diese Informationen zu erhalten.
• Ersetzen Sie jeden Beispieltext kursiv in der API-Dokumentation durch den Wert, die ID oder eine andere Variable, die von der Methode, mit der Sie arbeiten, benötigt wird.

Signale

Fügt der Abfragezeichenfolge einer ausstehenden Anforderung Zuordnungen auf Kunden- und Plattformebene hinzu.

Funktionssignatur: signals: function ({key1:value1, key2:value2},prefix){}

Reservierte Anforderungsschlüssel

Die folgenden Anforderungsschlüssel sind reserviert und können von dieser Methode nicht überschrieben werden:

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

Parameter

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

Fügt der Abfragezeichenfolge einer ausstehenden Anfrage SIDs hinzu.

Funktionsunterschrift: traits:function (sids){}

Parameter

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

logs

Fügen Sie Daten zu Protokolldateien in der ausstehenden Anfrage hinzu.

Funktionsunterschrift: logs: function {key1:value1, key2:value2}

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

submit

Sendet alle ausstehenden Daten an Audience Manager für die DIL-Instanz.

Funktionssignatur: submit: function () {}

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

Eine Funktion, die nach dem standardmäßigen Callback zur Zielveröffentlichung ausgeführt wird.

Funktionssignatur: afterResult: function (fn) {}

Parameter

Antwort

Gibt ein API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

Löscht alle Daten in einer ausstehenden Anfrage.

Funktionssignatur: clearData: function () {}

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

Fügt benutzerdefinierte Abfrageparameter, die nicht explizit vom Datenerfassungsserver definiert sind, zu einer ausstehenden Anfrage hinzu.

Funktionssignatur: customQueryParams: function (obj) {}

Reservierte Anforderungsschlüssel

Die folgenden Anforderungsschlüssel sind reserviert und können von dieser Methode nicht überschrieben werden:

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

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

getContainerNSID

Gibt den Wert der Container-NSID für die DIL-Instanz zurück. Nützlich für das Debugging und die Fehlerbehebung.

Funktionssignatur: dil.api.getContainerNSID: function () {}

Beispielcode

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

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

getEventLog

Gibt chronologisch sortierte Ereignisprotokolldaten als Zeichenfolgen-Array zurück. Nützlich für das Debugging und die Fehlerbehebung.

Funktionssignatur: dil.api.getEventLog: function () {}

Beispielcode

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

Gibt den Partnernamen für eine DIL-Instanz zurück. Nützlich für das Debugging und die Fehlerbehebung.

Funktionssignatur: dil.api.getPartner: function () {}

Beispielcode

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

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

getState

Gibt den Status der aktuellen DIL-Instanz zurück. Nützlich für das Debugging und die Fehlerbehebung.

Funktionssignatur: dil.api.getState: function () {}

Beispielcode

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

Besteht aus zwei Funktionen, mit denen Datenpartner Benutzer-IDs untereinander und mit Audience Manager austauschen und synchronisieren können.

Funktionssignatur:

Funktioniert mit den DIL Versionen 2.10 und 3.1 oder höher.

idSync-Elemente

idSync kann aus Folgendem bestehen:

Makros

idSync akzeptiert die folgenden Makros:

• %TIMESTAMP%: Generiert einen Zeitstempel (in Millisekunden). Wird für das Cache-Busting verwendet.
• %DID%: Fügt die Audience Manager-ID für den Benutzer ein.
• %HTTP_PROTO%: Legt das Seitenprotokoll fest ( http oder https).

Antwort

Beide Funktionen geben Successfully queued zurück, falls erfolgreich. Falls nicht, wird eine Fehlermeldungszeichenfolge zurückgegeben.

Beispielcode

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

Fügt der ausstehenden Anfrage einen Callback hinzu (der JSON erhält).

Funktionssignatur: result: function (callback) {}

Dieser Rückruf ersetzt den standardmäßigen Rückruf, der die Zielveröffentlichung verarbeitet.

Parameter

Antwort

Gibt das API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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 ist ein boolescher Parameter, der steuert, wie DIL Aufrufe an Data Collection Servers (DCS) und Akamai gesendet werden.

• Wenn secureDataCollection= true (Standard), führt DIL immer sichere HTTPS-Aufrufe durch.

• Wenn secureDataCollection= false DIL HTTP- oder HTTPS-Aufrufe durchführt, indem das von der Seite festgelegte Sicherheitsprotokoll befolgt wird.

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

useCORSOnly

useCORSOnly ist ein boolescher true/false -Parameter, der steuert, wie Browser Ressourcen von anderen Domänen anfordern.

Überblick

useCORSOnly ist standardmäßig "false". False bedeutet, dass der Browser Ressourcenprüfungen mit CORS oder JSONP durchführen kann. DIL versucht jedoch immer, zunächst Ressourcen mit CORS anzufordern. Bei älteren Browsern, die CORS nicht unterstützen, wird auf JSONP zurückgegriffen. Wenn Sie erzwingen müssen, dass der Browser nur CORS verwendet, z. B. bei Sites mit hohen Sicherheitsanforderungen, legen Sie useCORSOnly:true fest.

Code-Beispiel

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

useImageRequest

Ändert den Anfragetyp in image <img> vom Skript <src>.

Funktionssignatur: useImageRequest: function () {}

Antwort

Gibt ein API-Objekt der aktuellen DIL-Instanz zurück.

Beispielcode

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

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

Ressourcen für Business.Adobe.com

Audio Analytics Mobile App Analytics Flow Analysis Data Explorer Tag Management Data Management Platform