DIL-methoden op instantieniveau instance-level-dil-methods

Met de API's op instantieniveau DIL kunt u programmatisch Audience Manager-objecten maken en ermee werken. De instantie-vlakke methodes verbeteren API functionaliteit die door de klasse-vlakke methodes wordt gevestigd.

Aan de slag met DIL-methoden op instantieniveau get-started-dil-methods

Wanneer u werkt met de API's op instantieniveau DIL :

signalen signals

Voegt klant en platform-vlakke afbeeldingen aan het vraagkoord van een hangende verzoek toe.

de Handtekening van de Functie: signals: function ({key1:value1, key2:value2},prefix){}

Gereserveerde Sleutels van het Verzoek

De volgende aanvraagsleutels zijn gereserveerd en kunnen niet door deze methode worden beschreven:

Parameters

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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();

kenmerken traits

Voegt SIDs aan het vraagkoord van een hangend verzoek toe.

handtekening van de Functie: traits:function (sids){}

Parameters

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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

logs logs

Voeg gegevens toe aan logbestanden in de aanvraag die in behandeling is.

handtekening van de Functie: logs: function {key1:value1, key2:value2}

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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

indienen submit

Hiermee worden alle gegevens die in behandeling zijn naar Audience Manager verzonden voor de instantie DIL .

de Handtekening van de Functie: submit: function () {}

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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

Een functie die na de standaardbestemmings het publiceren callback uitvoert.

de Handtekening van de Functie: afterResult: function (fn) {}

Parameters

Reactie

Retourneert een API-object van de huidige DIL -instantie.

Code van de Steekproef

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

Wist alle gegevens in een aanvraag in behandeling.

de Handtekening van de Functie: clearData: function () {}

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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

Voegt aangepaste vraagparameters toe die niet uitdrukkelijk door de server van de gegevensinzameling aan een hangende verzoek worden bepaald.

de Handtekening van de Functie: customQueryParams: function (obj) {}

Gereserveerde Sleutels van het Verzoek

De volgende aanvraagsleutels zijn gereserveerd en kunnen niet door deze methode worden beschreven:

Reactie

Retourneert het API-object van de huidige DIL-instantie.

Code van de Steekproef

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

getContainerNSID getcontainernsid

Retourneert de waarde van de container NSID voor de instantie DIL . Nuttig voor foutopsporing en probleemoplossing.

de Handtekening van de Functie: dil.api.getContainerNSID: function () {}

Code van de Steekproef

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

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

getEventLog geteventlog

Retourneert chronologisch gesorteerde gebeurtenisloggegevens als een array van tekenreeksen. Nuttig voor foutopsporing en probleemoplossing.

de Handtekening van de Functie: dil.api.getEventLog: function () {}

Code van de Steekproef

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

Retourneert de partnernaam voor een instantie DIL . Nuttig voor foutopsporing en probleemoplossing.

de Handtekening van de Functie: dil.api.getPartner: function () {}

Code van de Steekproef

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

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

getState getstate

Retourneert de status van de huidige DIL -instantie. Nuttig voor foutopsporing en probleemoplossing.

de Handtekening van de Functie: dil.api.getState: function () {}

Code van de Steekproef

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

Bestaat uit twee functies waarmee gegevenspartners gebruikers-id's onderling en in Audience Manager kunnen uitwisselen en synchroniseren.

Handtekening van de Functie:

Werkt met DIL versies 2.10 en 3.1 of hoger.

idSync Elements

idSync kan uit het volgende bestaan:

Macro's

idSync accepteert de volgende macro's:

Reactie

Beide functies retourneren Successfully queued als dit gelukt is. Ze retourneren een foutbericht als dat niet het geval is.

Code van de Steekproef

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)
});

resultaat result

Voegt een callback (die JSON ontvangt) aan het hangende verzoek toe.

de Handtekening van de Functie: result: function (callback) {}

Deze callback vervangt standaardcallback die bestemmings het publiceren behandelt.

Parameters

Reactie

Retourneert het API-object van de huidige DIL -instantie.

Code van de Steekproef

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 is een Booleaanse parameter die bepaalt hoe DIL aanroepen naar de Data Collection Servers (DCS) en Akamai uitvoert.

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

useCORSOnly usecorsonly

useCORSOnly is een Booleaanse parameter true/false die bepaalt hoe de browser bronnen van andere domeinen opvraagt.

Overzicht

useCORSOnly is standaard false. Onwaar betekent browser middelcontroles met CORS of JSONP kan uitvoeren. DIL probeert echter altijd eerst bronnen aan te vragen bij CORS. Het keert aan JSONP op oudere browsers terug die geen CORS steunen. Stel useCORSOnly:true in als u de browser wilt dwingen alleen CORS te gebruiken, bijvoorbeeld met sites die hoge beveiligingsvereisten hebben.

Steekproef van de Code

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

useImageRequest useimagerequest

Wijzigt het aanvraagtype in afbeelding <img> vanuit script <src> .

de Handtekening van de Functie: useImageRequest: function () {}

Reactie

Retourneert een API-object van de huidige DIL -instantie.

Code van de Steekproef

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

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