인스턴스 수준 DIL 메서드

인스턴스 수준 DIL API를 사용하면 프로그래밍 방식으로 Audience Manager 개체를 만들고 사용할 수 있습니다. 인스턴스 수준 메서드는 클래스 수준 메서드에서 설정한 API 기능을 향상시킵니다.

인스턴스 수준 DIL 메서드 시작

인스턴스 수준 DIL API를 사용하여 작업하는 경우:

• 액세스하려면 파트너 이름 및 컨테이너 네임스페이스 ID(NSID)가 필요합니다. 이 정보를 얻으려면 Audience Manager 계정 관리자에게 문의하십시오.
• API 설명서의 모든 샘플 기울임화된 텍스트를 작업 중인 메서드에서 필요한 값, ID 또는 기타 변수로 바꿉니다.

신호

대기 중인 요청의 쿼리 문자열에 고객 및 플랫폼 수준 매핑을 추가합니다.

함수 서명: signals: function ({key1:value1, key2:value2},prefix){}

예약된 요청 키

다음 요청 키는 예약되어 있으므로 이 방법으로 덮어쓸 수 없습니다.

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

매개 변수

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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

보류 중인 요청의 쿼리 문자열에 SID를 추가합니다.

함수 서명: traits:function (sids){}

매개 변수

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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

로그

보류 중인 요청의 로그 파일에 데이터를 추가합니다.

함수 서명: logs: function {key1:value1, key2:value2}

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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

제출

보류 중인 모든 데이터를 DIL 인스턴스에 대한 Audience Manager에 제출합니다.

함수 서명: submit: function () {}

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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: function (fn) {}

매개 변수

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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: function () {}

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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: function (obj) {}

예약된 요청 키

다음 요청 키는 예약되어 있으므로 이 방법으로 덮어쓸 수 없습니다.

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

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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

getContainerNSID

DIL 인스턴스에 대한 컨테이너 NSID 값을 반환합니다. 디버깅 및 문제 해결에 유용합니다.

함수 서명: dil.api.getContainerNSID: function () {}

샘플 코드

var dataLib = DIL.create({ 
     partner: 'partnerName', 
     containerNSID: containerNSID 
}); 
 
//Verify the container NSID 
var nsid = dataLib.api.getContainerNSID();

getEventLog

시간순으로 정렬된 이벤트 로그 데이터를 문자열 배열로 반환합니다. 디버깅 및 문제 해결에 유용합니다.

함수 서명: dil.api.getEventLog: function () {}

샘플 코드

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

DIL 인스턴스에 대한 파트너 이름을 반환합니다. 디버깅 및 문제 해결에 유용합니다.

함수 서명: dil.api.getPartner: function () {}

샘플 코드

var dataLib = DIL.create({ 
     partner: 'partnerName' 
     containerNSID: containerNSID 
}); 
 
//Verify the partner name 
var partner = dataLib.api.getPartner();

getState

현재 DIL 인스턴스의 상태를 반환합니다. 디버깅 및 문제 해결에 유용합니다.

함수 서명: dil.api.getState: function () {}

샘플 코드

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

데이터 파트너가 자체 및 Audience Manager 간에 사용자 ID를 교환하고 동기화할 수 있는 두 가지 기능으로 구성됩니다.

함수 서명:

DIL 버전 2.10 및 3.1 이상에서 작동합니다.

idSync 요소

idSync 다음과 같이 구성될 수 있습니다.

매크로

idSync 는 다음 매크로를 허용합니다.

• %TIMESTAMP%: 타임스탬프를 생성합니다(밀리초 단위). 캐시 무효화에 사용됩니다.
• %DID%: 사용자의 Audience Manager ID를 삽입합니다.
• %HTTP_PROTO%: 페이지 프로토콜( http 또는 https)을 설정합니다.

응답

성공하면 두 함수 모두 Successfully queued을 반환합니다. 실패한 경우 오류 메시지 문자열을 반환합니다.

샘플 코드

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

결과

보류 중인 요청에 콜백(JSON을 수신하는)을 추가합니다.

함수 서명: result: function (callback) {}

이 콜백은 대상 게시를 처리하는 기본 콜백을 대체합니다.

매개 변수

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

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 는 및 Akamai를 호출하 DIL 는 방법을 제어하는 부울 매개 Data Collection Servers (DCS) 변수입니다.

• secureDataCollection= true(기본값)에서는 DIL이 항상 보안을 설정하고 HTTPS를 호출합니다.

• secureDataCollection= false에서는 DIL이 페이지에서 설정한 보안 프로토콜을 기준으로 HTTP 또는 HTTPS를 호출합니다.

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

useCORSOnly

useCORSOnly 브라우저가 다른 도메인에서 리소스를 요청하는 방법을 제어하는 부울 true/false 매개 변수입니다.

개요

useCORSOnly 기본적으로 false입니다. False는 브라우저가 CORS 또는 JSONP로 리소스 확인을 수행할 수 있음을 의미합니다. 그러나 [!UICONTROL DIL]은 항상 CORS가 먼저 있는 리소스를 요청하려고 합니다. ID 서비스는 CORS를 지원하지 않는 오래된 브라우저에서는 JSONP로 되돌립니다. 높은 보안 요구 사항이 있는 사이트와 같이 브라우저가 CORS만 사용하도록 해야 하는 경우에는 useCORSOnly:true 을 설정하십시오.

코드 샘플

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

useImageRequest

요청 유형을 스크립트 <src>에서 이미지 <img>으로 변경합니다.

함수 서명: useImageRequest: function () {}

응답

현재 DIL 인스턴스의 API 개체를 반환합니다.

샘플 코드

var dataLib = DIL.create({ 
     partner:'partnerName', 
     containerNSID: containerNSID 
}); 
 
dataLib.api.traits([123, 456, 789]).useImageRequest().submit();