DIL-Methoden auf Instanzebene instance-level-dil-methods
Die Instanzebene DIL Mit APIs 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 get-started-dil-methods
Beim Arbeiten mit Instanzenebene DIL APIs:
- 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.
- Beispiel ersetzen kursiv Text in der API-Dokumentation mit -Wert, -ID oder einer anderen -Variablen, wie von der verwendeten -Methode benötigt.
Signale signals
Fügt der Abfragezeichenfolge einer ausstehenden Anforderung Zuordnungen auf Kunden- und Plattformebene hinzu.
Funktionssignatur: signals: function ({key1:value1, key2:value2},prefix){}
- Sie können andere API-Aufrufe an diese Methode ketten.
- Wenn sich die Adobe Experience Cloud-JavaScript-Bibliothek auf der Seite befindet,
submit()wartet, bis die Cloud ein Cookie setzt, bevor eine Anforderung gesendet wird.
Reservierte Anforderungsschlüssel
Die folgenden Anforderungsschlüssel sind reserviert und können von dieser Methode nicht überschrieben werden:
sidspdatalogdatacallbackpostCallbackFnuseImageRequest
Parameter
objprefixreturnAntwort
Gibt das API-Objekt der aktuellen DIL -Instanz.
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 traits
Fügt der Abfragezeichenfolge einer ausstehenden Anfrage SIDs hinzu.
Funktionsunterschrift: traits:function (sids){}
Parameter
sidsAntwort
Gibt das API-Objekt der aktuellen DIL -Instanz.
Beispielcode
var partnerObject = DIL.create({
partner: 'partner name',
containerNSID: NSID
});
partnerObject.api.traits([123, 456, 789]);
logs 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.
Beispielcode
var partnerObject = DIL.create({
partner: 'partner',
containerNSID: NSID
});
partnerObject.api.logs({
file: 'dil.js',
message: 'This is the first request'
});
submit submit
Sendet alle ausstehenden Daten an Audience Manager für DIL -Instanz.
Funktionssignatur: submit: function () {}
%20 und Semikolons als %3B.Antwort
Gibt das API-Objekt der aktuellen DIL -Instanz.
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 afterresult
Eine Funktion, die nach dem standardmäßigen Callback zur Zielveröffentlichung ausgeführt wird.
Funktionssignatur: afterResult: function (fn) {}
Parameter
fnAntwort
Gibt ein API-Objekt der aktuellen DIL -Instanz.
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 cleardata
Löscht alle Daten in einer ausstehenden Anfrage.
Funktionssignatur: clearData: function () {}
Antwort
Gibt das API-Objekt der aktuellen DIL -Instanz.
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 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:
sidspdatalogdatacallbackpostCallbackFnuseImageRequest
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 getcontainernsid
Gibt den Wert der Container-NSID für die DIL -Instanz. Nützlich für Debugging und 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 geteventlog
Gibt chronologisch sortierte Ereignisprotokolldaten als Zeichenfolgen-Array zurück. Nützlich für Debugging und 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 getpartner
Gibt den Partnernamen für eine DIL -Instanz. Nützlich für Debugging und 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 getstate
Gibt den aktuellen Status aus DIL -Instanz. Nützlich für Debugging und 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 idsync
Besteht aus zwei Funktionen, mit denen Datenpartner Benutzer-IDs untereinander und mit Audience Manager austauschen und synchronisieren können.
Funktionssignatur:
Funktioniert mit DIL Versionen 2.10 und 3.1 oder höher.
dil.Instance.api.idSync(initConfig)Zwischen verschiedenen Datenpartnern und Audience Managern. Beispielsweise würde Partner x dies verwenden, um eine Benutzer-ID mit Partner y zu synchronisieren und diese dann an Audience Manager zu senden.
Wichtig: Diese Methode wird nicht mehr unterstützt. Bitte verwenden Sie idSyncByURL -Methode der Adobe Experience Platform Identity Service-Instanz.
dil.Instance.api.aamIdSync(initConfig)Wenn Sie die Benutzer-ID bereits kennen und sie an Audience Manager senden möchten.
Wichtig: Diese Methode wird nicht mehr unterstützt. Bitte verwenden Sie idSyncByDataSource -Methode der Adobe Experience Platform Identity Service-Instanz.
idSync-Elemente
idSync kann aus Folgendem bestehen:
dpiddpuuidminutesToLiveurlMakros
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 (httpoderhttps).
Antwort
Beide Funktionen geben die Successfully queued wenn 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 result
Fügt der ausstehenden Anfrage einen Rückruf (der JSON erhält) hinzu.
Funktionssignatur: result: function (callback) {}
Dieser Rückruf ersetzt den standardmäßigen Rückruf, der die Zielveröffentlichung verarbeitet.
Parameter
callbackAntwort
Gibt das API-Objekt der aktuellen DIL -Instanz.
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
secureDataCollection ist ein boolescher Parameter, der steuert, wie DIL ruft die Data Collection Servers (DCS) und Akamai.
-
Wann
secureDataCollection= true(Standard), DIL führt immer sichere HTTPS-Aufrufe durch. -
Wann
secureDataCollection= false, DIL führt entweder HTTP- oder HTTPS-Aufrufe durch, indem das von der Seite festgelegte Sicherheitsprotokoll befolgt wird.
secureDataCollection= false wenn Sie visitorAPI.js verwenden und DIL auf derselben Seite. Siehe Code-Beispiel unten.
var dilInstance = DIL.create({
...
secureDataCollection: false
});
useCORSOnly 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. Allerdings DIL versucht immer zuerst, 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.
Code-Beispiel
var dilInstance = DIL.create({
...
useCORSOnly: true
});
- Es wird empfohlen,
useCORSOnly: truenur dann, wenn Sie sicher sind, dass Ihre Site-Besucher über Browser verfügen, die diese Funktion unterstützen. - Wann
useCORSOnly: true, DIL führt keine ID-Aufrufe von Internet Explorer Version 9 oder älter durch.
useImageRequest useimagerequest
Ändert den Anfragetyp in Bild <img> aus Skript <src>.
Funktionssignatur: useImageRequest: function () {}
Antwort
Gibt ein API-Objekt der aktuellen DIL -Instanz.
Beispielcode
var dataLib = DIL.create({
partner:'partnerName',
containerNSID: containerNSID
});
dataLib.api.traits([123, 456, 789]).useImageRequest().submit();