roshanoracle
4/13/2017 - 1:40 PM
Motivate : DFP Integration Code
Motivate : DFP Integration Code
// Currently deactivating DFP send data
/*
######################################################
### ORACLE BLUEKAI : DFP : JSON Return integration ###
######################################################
Author : roshan.gonsalkorale@oracle.com
Notes:
- This will query BlueKai for visitor profile data (campaign IDs and Category IDs) and send to DFP (via GPT syntax https://developers.google.com/doubleclick-gpt/reference#googletag.PubAdsService_setTargeting)
- The code aims to dispatch BlueKai profile data to DFP (via GPT syntax) by either finding it via the BlueKai API or using a local storage copy
- It aims to call DFP as quickly as possible
- All code is asynchronous
Debugger:
- add 'bk_dfp_logger=true' as a query-string parameter in the URL and check the console logs
Implementation Instructions:
- Required DFP to be implemented via Google Publisher Tag (https://developers.google.com/doubleclick-gpt/)
- Host this code in a file on your website and load synchronously in the <head>
- Implement it BEFORE any Google Publisher Tag code (GPT)
- Implement it BEFORE any the BlueKai Site Optimisation tag
Code Workflow:
- If visitor profile data hasn't already been returned:
- it will check for it in local storage and send it also call BlueKai again for the data
- If visitor profile data has been returned:
- it will parse that
- Whenever BlueKai profile data is found:
- it will store it for reference in localstorage
- it will call send the data to DFP (via GPT syntax)
- If the data has already been send to DFP, it won't do it again
- Use the debugging to check the workflow
*/
// CONFIG : EDIT THIS PART
// Create object to store functions
window.bk_dfp_integration = window.bk_dfp_integration || {};
window.bk_dfp_integration.functions = window.bk_dfp_integration.functions || {};
window.bk_dfp_integration.data = window.bk_dfp_integration.data || {};
window.bk_dfp_integration.bluekai_jsonreturn_id = "45593"; // Your JSON Return Container ID
window.bk_dfp_integration.wait_in_ms = 5000; // How long to wait before asking BlueKai for the latest categories and firing data to DFP (default 5000ms)
/*
##########################################################################################
DO NOT EDIT BELOW THIS LINE
##########################################################################################
*/
// FUNCTION : Local Storage Send
bk_dfp_integration.functions.localstorage_sender = function(data, name_of_var) {
if (typeof(Storage) !== "undefined") {
bk_dfp_integration.functions.logger("BLUEKAI DFP : LOCAL STORAGE : storing '" + JSON.stringify(data) + "' as '" + name_of_var + "' in local storage");
localStorage.setItem(name_of_var, JSON.stringify(data));
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : LOCAL STORAGE : SEND DATA : HTML 5 NOT SUPPORTED");
return "no storage"; // HTML 5 NOT SUPPORTED
}
}
// FUNCTION : Local Storage Retrieve
bk_dfp_integration.functions.localstorage_retriever = function(name_of_var) {
if (typeof(Storage) !== "undefined") {
return JSON.parse(localStorage.getItem(name_of_var));
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : LOCAL STORAGE : SEND DATA : HTML 5 NOT SUPPORTED");
return "no storage"; // HTML 5 NOT SUPPORTED
}
}
// FUNCTION : Local Storage fallback
bk_dfp_integration.functions.localstorage_fallback = function() {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Local Storage : attempting fallback");
// category IDs
if (bk_dfp_integration.functions.localstorage_retriever("bk_cat_ids") !== "no storage") {
window.bk_dfp_integration.data.bk_category_ids = bk_dfp_integration.functions.localstorage_retriever("bk_cat_ids");
window.bk_dfp_integration.data.bk_campaign_ids = bk_dfp_integration.functions.localstorage_retriever("bk_campaign_ids");
if (!window.bk_dfp_integration.data.bk_campaign_ids) {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Local Storage : no campaign IDs available in local storage");
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Local Storage : Retrieved following 'bk_campaign_ids' from local storage : " + window.bk_dfp_integration.data.bk_campaign_ids);
}
if (!window.bk_dfp_integration.data.bk_category_ids) {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Local Storage : no category IDs available in local storage");
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Local Storage : Retrieved following 'bk_category_ids' from local storage : " + window.bk_dfp_integration.data.bk_category_ids);
}
// Send data to DFP
// bk_dfp_integration.functions.sendDfp(); // disabled
}
}
bk_dfp_integration.functions.logger = function(message, attribute_object) {
if (document.location.href.indexOf('bk_dfp_logger=true') > -1) {
//session cookie
document.cookie = "bk_dfp_logger=" + "true" +
";path=/;domain=" + document.domain + ";expires=";
}
if (document.cookie.indexOf('bk_dfp_logger=true') > -1) {
if (typeof attribute_object === "undefined") {
console.log(message);
} else {
for (var varName in attribute_object) {
console.log(message + varName + "=" + attribute_object[varName]);
}
}
}
};
// FUNCTION : Parse BlueKai data and send to DFP
bk_dfp_integration.functions.parseBkResults = function() {
// Parse BlueKai Campaign Results
window.bk_dfp_integration.data.bk_category_ids = [];
window.bk_dfp_integration.data.bk_campaign_ids = [];
if (typeof(bk_results) != "undefined") {
if (typeof(bk_results.campaigns[0]) != "undefined") {
bk_dfp_integration.functions.logger("BLUEKAI DFP : 'bk_results' object found");
for (var i = 0; i < bk_results.campaigns.length; i++) {
window.bk_dfp_integration.data.bk_campaign_ids.push(bk_results.campaigns[i].campaign);
for (var j = 0; j < bk_results.campaigns[i].categories.length; j++) {
if (typeof(bk_results.campaigns[i].categories[j].categoryID) != "undefined") {
window.bk_dfp_integration.data.bk_category_ids.push(bk_results.campaigns[i].categories[j].categoryID);
}
}
}
// Send data to Local Storage
bk_dfp_integration.functions.localstorage_sender(window.bk_dfp_integration.data.bk_category_ids, "bk_cat_ids");
bk_dfp_integration.functions.localstorage_sender(window.bk_dfp_integration.data.bk_campaign_ids, "bk_campaign_ids");
// Send data to DFP
//bk_dfp_integration.functions.sendDfp(); // disabled
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : No campaigns object");
}
}
}
bk_dfp_integration.functions.sendDfp = function() {
if (!window.bk_dfp_integration.data.dfp_sent) {
// Create GPT object for DFP
window.googletag = window.googletag || {};
googletag.cmd = googletag.cmd || [];
// Fire Campaign IDs if available
if(window.bk_dfp_integration.data.bk_campaign_ids){
googletag.cmd.push(function() {
googletag.pubads().setTargeting('bkcampids', window.bk_dfp_integration.data.bk_campaign_ids);
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Declared Targeting Parameter 'bkcampids' with following array : " + window.bk_dfp_integration.data.bk_campaign_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Syntax 'googletag.pubads().setTargeting('bkcampids', window.bk_dfp_integration.data.bk_campaign_ids);'");
});
window.bk_dfp_integration.data.dfp_sent = true; // flag so data not send twice
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : QUEUED : Declared Targeting Parameter 'bkcampids' with following array : " + window.bk_dfp_integration.data.bk_campaign_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : QUEUED : Syntax 'googletag.pubads().setTargeting('bkcampids', window.bk_dfp_integration.data.bk_campaign_ids);'");
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : NOT-QUEUED : No Campaign IDs available so Campaign IDs not sent");
}
// Fire Category IDs if available
if(window.bk_dfp_integration.data.bk_category_ids){
// Surface attributes to DFP
googletag.cmd.push(function() {
googletag.pubads().setTargeting('bkcatids', window.bk_dfp_integration.data.bk_category_ids);
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Declared Targeting Parameter 'bkcatids' with following array : " + window.bk_dfp_integration.data.bk_category_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Syntax 'googletag.pubads().setTargeting('bkcatids', window.bk_dfp_integration.data.bk_category_ids);'");
});
window.bk_dfp_integration.data.dfp_sent = true; // flag so data not send twice
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : QUEUED : Declared Targeting Parameter 'bkcatids' with following array : " + window.bk_dfp_integration.data.bk_category_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : QUEUED : Syntax 'googletag.pubads().setTargeting('bkcatids', window.bk_dfp_integration.data.bk_category_ids);'");
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : NOT-QUEUED : No Category IDs available so category IDs not sent");
}
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : NOT SENT : data already declared");
}
}
// FUNCTION : Call BlueKai
bk_dfp_integration.functions.callBlueKai = function(bluekai_jsonreturn_id) {
// Check if JSON return tag and bk_results already there
if ((window.bk_results) && (document.head && document.head.innerHTML.indexOf(bluekai_jsonreturn_id + '?ret=js') > -1) || (document.body && document.body.innerHTML.indexOf(bluekai_jsonreturn_id + '?ret=js') > -1)) {
bk_dfp_integration.functions.logger("BLUEKAI DFP : JSON Return tag found");
bk_dfp_integration.functions.logger("BLUEKAI DFP : Parsing 'bk_results' directly");
bk_dfp_integration.functions.parseBkResults(); // Parse results (don't call JSON ret tag)
} else {
bk_dfp_integration.functions.logger("BLUEKAI DFP : JSON Return tag NOT found");
bk_dfp_integration.functions.localstorage_fallback(); // Grab from local storage
bk_dfp_integration.functions.logger("BLUEKAI DFP : Waiting " + window.bk_dfp_integration.wait_in_ms + "ms before calling JSON Return Tag");
setTimeout(function() {
bk_dfp_integration.functions.logger("BLUEKAI DFP : Calling JSON Return tag");
var bk_json_ret = document.createElement("script");
bk_json_ret.type = "text/javascript";
bk_json_ret.onload = function() {
bk_dfp_integration.functions.logger("BLUEKAI DFP : JSON Return tag loaded");
bk_dfp_integration.functions.logger("BLUEKAI DFP : Parsing 'bk_results'");
bk_dfp_integration.functions.parseBkResults(); // Parse results
};
bk_dfp_integration.functions.parseBkResults(); // Parse results
bk_json_ret.src = "//tags.bluekai.com/site/" + bluekai_jsonreturn_id + "?ret=js&limit=1&integration=dfp";
document.head.appendChild(bk_json_ret);
},
window.bk_dfp_integration.wait_in_ms);
}
};
// RUN CODE
bk_dfp_integration.functions.callBlueKai(window.bk_dfp_integration.bluekai_jsonreturn_id);// Insert just before googletag.enableServices();
if(window.bk_dfp_integration.data.bk_category_ids){
googletag.pubads().setTargeting('bkcatids', window.bk_dfp_integration.data.bk_category_ids);
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Declared Targeting Parameter 'bkcampids' with following array : " + window.bk_dfp_integration.data.bk_campaign_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Syntax 'googletag.pubads().setTargeting('bkcampids', window.bk_dfp_integration.data.bk_campaign_ids);'");
}
if(window.bk_dfp_integration.data.bk_campaign_ids){
googletag.pubads().setTargeting('bkcampids', window.bk_dfp_integration.data.bk_campaign_ids);
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Declared Targeting Parameter 'bkcatids' with following array : " + window.bk_dfp_integration.data.bk_category_ids + " (see syntax below)");
bk_dfp_integration.functions.logger("BLUEKAI DFP : DFP SEND : EXECUTED : Syntax 'googletag.pubads().setTargeting('bkcatids', window.bk_dfp_integration.data.bk_category_ids);'");
}<!-- Implement this code in the <head> -->
<!-- Async Solution -->
<!-- Begin BlueKai - JSON Site Optimisation Tag -->
<script type="text/javascript">
var script = document.createElement('script');
script.src = '//tags.bluekai.com/site/45593?ret=js&limit=1';script.async=true;
document.head.appendChild(script);
</script>
<!-- End BlueKai Tag - JSON Site Optimisation Tag -->