DIL-metoder på instansnivå instance-level-dil-methods
Med API:erna på förekomstnivå DIL kan du skapa och arbeta med Audience Manager-objekt programmatiskt. Metoderna på förekomstnivå förbättrar API-funktionaliteten som fastställs av klassnivåmetoderna.
Komma igång med DIL-metoder på instansnivå get-started-dil-methods
När du arbetar med DIL-API:er på förekomstnivå:
- Åtkomst kräver ett partnernamn och ett behållar-ID (NSID). Kontakta din kontoansvarige på Audience Manager för att få denna information.
- Ersätt eventuell kursiv-exempeltext i API-dokumentationen med värde, ID eller annan variabel enligt vad som krävs för den metod du arbetar med.
signaler signals
Lägger till mappningar på kund- och plattformsnivå i frågesträngen för en väntande begäran.
Funktionssignatur: signals: function ({key1:value1, key2:value2},prefix){}
- Du kan kedja andra API-anrop till den här metoden.
- Om Adobe Experience Cloud JavaScript-biblioteket finns på sidan väntar
submit()på att en cookie ska anges i molnet innan en begäran skickas.
Reserverade begärannycklar
Följande begärandenycklar är reserverade och kan inte skrivas över av den här metoden:
sidspdatalogdatacallbackpostCallbackFnuseImageRequest
Parametrar
objprefixreturnSvar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
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
Lägger till SID:er i frågesträngen för en väntande begäran.
Funktionssignatur: traits:function (sids){}
Parametrar
sidsSvar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
var partnerObject = DIL.create({
partner: 'partner name',
containerNSID: NSID
});
partnerObject.api.traits([123, 456, 789]);
loggar logs
Lägg till data i loggfiler i den väntande begäran.
Funktionssignatur: logs: function {key1:value1, key2:value2}
Svar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
var partnerObject = DIL.create({
partner: 'partner',
containerNSID: NSID
});
partnerObject.api.logs({
file: 'dil.js',
message: 'This is the first request'
});
skicka submit
Skickar alla väntande data till Audience Manager för instansen DIL.
Funktionssignatur: submit: function () {}
%20 och semikolon som %3B.Svar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
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
En funktion som körs efter standardåteranropet för målpublicering.
Funktionssignatur: afterResult: function (fn) {}
Parametrar
fnSvar
Returnerar ett API-objekt för den aktuella DIL-instansen.
Exempelkod
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
Tar bort alla data i en väntande begäran.
Funktionssignatur: clearData: function () {}
Svar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
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
Lägger till anpassade frågeparametrar som inte uttryckligen definieras av datainsamlingsservern i en väntande begäran.
Funktionssignatur: customQueryParams: function (obj) {}
Reserverade begärannycklar
Följande begärandenycklar är reserverade och kan inte skrivas över av den här metoden:
sidspdatalogdatacallbackpostCallbackFnuseImageRequest
Svar
Returnerar API-objektet för den aktuella DIL-instansen.
Exempelkod
var partnerObject = DIL.create({
partner: 'partner',
containerNSID: NSID
});
partnerObject.api.customQueryParams({
nid: 54231,
ntype: 'default'
});
getContainerNSID getcontainernsid
Returnerar värdet för behållar-NSID för instansen DIL. Användbar för felsökning och felsökning.
Funktionssignatur: dil.api.getContainerNSID: function () {}
Exempelkod
var dataLib = DIL.create({
partner: 'partnerName',
containerNSID: containerNSID
});
//Verify the container NSID
var nsid = dataLib.api.getContainerNSID();
getEventLog geteventlog
Returnerar kronologiskt sorterade händelseloggdata som en array med strängar. Användbar för felsökning och felsökning.
Funktionssignatur: dil.api.getEventLog: function () {}
Exempelkod
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
Returnerar partnernamnet för en DIL-instans. Användbar för felsökning och felsökning.
Funktionssignatur: dil.api.getPartner: function () {}
Exempelkod
var dataLib = DIL.create({
partner: 'partnerName'
containerNSID: containerNSID
});
//Verify the partner name
var partner = dataLib.api.getPartner();
getState getstate
Returnerar läget för den aktuella DIL-instansen. Användbar för felsökning och felsökning.
Funktionssignatur: dil.api.getState: function () {}
Exempelkod
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
Består av två funktioner som gör att datapartners kan utbyta och synkronisera användar-ID:n mellan sig och Audience Manager.
Funktionssignatur:
Fungerar med DIL version 2.10 och 3.1 eller senare.
dil.Instance.api.idSync(initConfig)Mellan olika datapartners och Audience Manager. Partner x använder till exempel detta för att synkronisera ett användar-ID med partner y och sedan skicka det till Audience Manager.
Viktigt! Den här metoden är föråldrad. Använd metoden idSyncByURL för instansen av Adobe Experience Platform Identity Service.
dil.Instance.api.aamIdSync(initConfig)När du redan känner till användar-ID:t och vill skicka det till Audience Manager.
Viktigt! Den här metoden är föråldrad. Använd metoden idSyncByDataSource för instansen av Adobe Experience Platform Identity Service.
idSync Elements
idSync kan bestå av följande:
dpiddpuuidminutesToLiveurlMakron
idSync accepterar följande makron:
%TIMESTAMP%: Skapar en tidsstämpel (i millisekunder). Används för cachebusting.%DID%: Infogar användarens Audience Manager-ID.%HTTP_PROTO%: Anger sidprotokollet (httpellerhttps).
Svar
Båda funktionerna returnerar Successfully queued om de lyckas. De returnerar en felmeddelandesträng om de inte gör det.
Exempelkod
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)
});
resultat result
Lägger till ett återanrop (som tar emot JSON) i den väntande begäran.
Funktionssignatur: result: function (callback) {}
Det här återanropet ersätter standardåteranropet som hanterar målpublicering.
Parametrar
callbackSvar
Returnerar API-objektet för aktuell DIL-instans.
Exempelkod
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 är en boolesk parameter som styr hur DIL anropar Data Collection Servers (DCS) och Akamai.
-
När
secureDataCollection= true(standard) används alltid säkra HTTPS-anrop av DIL. -
När
secureDataCollection= falsegör DIL antingen HTTP- eller HTTPS-anrop genom att följa säkerhetsprotokollet som angetts av sidan.
secureDataCollection= false om du använder visitorAPI.js och DIL på samma sida. Se kodexemplet nedan.
var dilInstance = DIL.create({
...
secureDataCollection: false
});
useCORSOnly usecorsonly
useCORSOnly är en boolesk true/false-parameter som styr hur webbläsaren begär resurser från andra domäner.
Översikt
useCORSOnly är false som standard. Falskt innebär att webbläsaren kan utföra resurskontroller med CORS eller JSONP. DIL försöker dock alltid begära resurser med CORS först. Den återgår till JSONP i äldre webbläsare som inte stöder CORS. Om du behöver tvinga webbläsaren att endast använda CORS, till exempel webbplatser som har höga säkerhetskrav, anger du useCORSOnly:true.
Kodexempel
var dilInstance = DIL.create({
...
useCORSOnly: true
});
- Vi rekommenderar att du bara anger
useCORSOnly: truenär du är säker på att webbplatsens besökare har webbläsare som stöder den här funktionen. - När
useCORSOnly: true, kommer DIL inte att göra ID-anrop från Internet Explorer version 9 eller tidigare.
useImageRequest useimagerequest
Ändrar begärandetypen till bilden <img> från skriptet <src>.
Funktionssignatur: useImageRequest: function () {}
Svar
Returnerar ett API-objekt för den aktuella DIL-instansen.
Exempelkod
var dataLib = DIL.create({
partner:'partnerName',
containerNSID: containerNSID
});
dataLib.api.traits([123, 456, 789]).useImageRequest().submit();