Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some minor changes #1

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Some minor changes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8f290c4
Making UID global to avoid race conditions
coop182 May 25, 2016
3df7838
Whoops
coop182 May 25, 2016
2279fd0
Refresh ads if `disableInitialLoad` option is true
mkhazov Nov 10, 2016
61fe435
enableServices one time
mkhazov Nov 11, 2016
27f81da
Add 'slotRenderEnded' listener once
mkhazov Nov 11, 2016
df2a5d2
push pubads().refresh() in googletag.cmd
mkhazov Nov 29, 2016
98d37b9
always define window.googletag and window.googletag.cmd
mkhazov Dec 29, 2016
57f8acb
Add fluid dimension support
avdeev Mar 2, 2017
3a08bce
add setSafeFrameConfig support
mkhazov Mar 21, 2017
2fb3a4d
add setForceSafeFrame support
mkhazov Apr 26, 2017
4680704
Merge pull request #2 from neuron-digital/feature/safeFrame
mkhazov Apr 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions Readme.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,16 @@ Available Options
</tr>
<tr>
<td>setLocation</td>
<td>This object sets geolocalization. String values are not valid. </td>
<td>This object sets geolocalization. String values are not valid.</td>
</tr>
<tr>
<td>setSafeFrameConfig</td>
<td>This object sets the page-level preferences for SafeFrame configuration.</td>
</tr>
<tr>
<td>setForceSafeFrame</td>
<td>This boolean configures whether all ads on the page should be forced to be rendered using a SafeFrame container.</td>
</tr>

<tr>
<td>enableSingleRequest</td>
<td>This boolean sets whether the page ads are fetched with a single request or not, you will need to set this to false it you want to call $.dfp() more than once, typically you would do this if you are loading ad units into the page after the initial load.</td>
Expand Down Expand Up @@ -286,7 +293,7 @@ This script provides two callbacks which you can use to make working with DFP a
</ul>
</td>
<td>This is called after each AdUnit has been blocked.</td>
</tr>
</tr>
</table>

Please see the [example-bootstrap.js](https://github.com/coop182/jquery.dfp.js/blob/master/example-bootstrap.js) file for an example of how to use these.
Expand Down
110 changes: 74 additions & 36 deletions jquery.dfp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@
// Save Scope
dfpScript = this || {};

// Setup global adunit counter
window.dfpUID = 0;

var
// DFP account ID
dfpID = '',

// Init counters
count = 0,
uid = 0,
rendered = 0,

// Default DFP selector
Expand Down Expand Up @@ -99,6 +101,8 @@
setTargeting: {},
setCategoryExclusion: '',
setLocation: '',
setSafeFrameConfig: undefined,
setForceSafeFrame: false,
enableSingleRequest: true,
collapseEmptyDivs: 'original',
refreshExisting: true,
Expand Down Expand Up @@ -229,6 +233,10 @@
googleAdUnit.defineSizeMapping(map.build());
}

if ($adUnit.data('safeframe')) {
googleAdUnit.setForceSafeFrame(true);
}

// Store googleAdUnit reference
$adUnit.data(storeAs, googleAdUnit);

Expand Down Expand Up @@ -275,7 +283,15 @@
});
}

if (dfpOptions.collapseEmptyDivs) {
if (typeof dfpOptions.setSafeFrameConfig === 'object') {
pubadsService.setSafeFrameConfig(dfpOptions.setSafeFrameConfig);
}

if (dfpOptions.setForceSafeFrame) {
pubadsService.setForceSafeFrame(true);
}

if (!googletag.__servicesEnabled__ && dfpOptions.collapseEmptyDivs) {
pubadsService.collapseEmptyDivs();
}

Expand All @@ -291,7 +307,7 @@
}
}

if (dfpOptions.disableInitialLoad) {
if (!googletag.__servicesEnabled__ && dfpOptions.disableInitialLoad) {
pubadsService.disableInitialLoad();
}

Expand All @@ -303,37 +319,39 @@
pubadsService.setCentering(true);
}

// Setup event listener to listen for renderEnded event and fire callbacks.
pubadsService.addEventListener('slotRenderEnded', function (event) {
if (!googletag.__servicesEnabled__) {
// Setup event listener to listen for renderEnded event and fire callbacks.
pubadsService.addEventListener('slotRenderEnded', function (event) {

rendered++;
rendered++;

var $adUnit = $('#' + event.slot.getSlotId().getDomId());
var $adUnit = $('#' + event.slot.getSlotId().getDomId());

var display = event.isEmpty ? 'none' : 'block';
var display = event.isEmpty ? 'none' : 'block';

// if the div has been collapsed but there was existing content expand the
// div and reinsert the existing content.
var $existingContent = $adUnit.data('existingContent');
if (display === 'none' && $.trim($existingContent).length > 0 &&
dfpOptions.collapseEmptyDivs === 'original') {
$adUnit.show().html($existingContent);
display = 'block display-original';
}
// if the div has been collapsed but there was existing content expand the
// div and reinsert the existing content.
var $existingContent = $adUnit.data('existingContent');
if (display === 'none' && $.trim($existingContent).length > 0 &&
dfpOptions.collapseEmptyDivs === 'original') {
$adUnit.show().html($existingContent);
display = 'block display-original';
}

$adUnit.removeClass('display-none').addClass('display-' + display);
$adUnit.removeClass('display-none').addClass('display-' + display);

// Excute afterEachAdLoaded callback if provided
if (typeof dfpOptions.afterEachAdLoaded === 'function') {
dfpOptions.afterEachAdLoaded.call(this, $adUnit, event);
}
// Excute afterEachAdLoaded callback if provided
if (typeof dfpOptions.afterEachAdLoaded === 'function') {
dfpOptions.afterEachAdLoaded.call(this, $adUnit, event);
}

// Excute afterAllAdsLoaded callback if provided
if (typeof dfpOptions.afterAllAdsLoaded === 'function' && rendered === count) {
dfpOptions.afterAllAdsLoaded.call(this, $adCollection);
}
// Excute afterAllAdsLoaded callback if provided
if (typeof dfpOptions.afterAllAdsLoaded === 'function' && rendered === count) {
dfpOptions.afterAllAdsLoaded.call(this, $adCollection);
}

});
});
}

// this will work with AdblockPlus
if(dfpScript.shouldCheckForAdBlockers() && !googletag._adBlocked_) {
Expand All @@ -352,7 +370,10 @@
}, 0);
}

googletag.enableServices();
if (!googletag.__servicesEnabled__) {
googletag.enableServices();
googletag.__servicesEnabled__ = true;
}

});

Expand Down Expand Up @@ -394,14 +415,28 @@
}
if (dfpOptions.refreshExisting && $adUnitData && $adUnit.hasClass('display-block')) {

googletag.cmd.push(function () { googletag.pubads().refresh([$adUnitData]); });
googletag.cmd.push(function () {
googletag.pubads().refresh([$adUnitData]);
});

} else {
googletag.cmd.push(function () { googletag.display($adUnit.attr('id')); });
googletag.cmd.push(function () {
googletag.display($adUnit.attr('id'));
});
}

});

if (dfpOptions.disableInitialLoad) {
var $ads = $adCollection.filter('.display-none').map(function () {
return $(this).data(storeAs);
}).get();

googletag.cmd.push(function () {
googletag.pubads().refresh($ads);
});
}

},

/**
Expand Down Expand Up @@ -435,8 +470,8 @@
*/
getID = function ($adUnit, adUnitName) {

uid++;
return $adUnit.attr('id') || $adUnit.attr('id', adUnitName.replace(/[^A-z0-9]/g, '_') + '-auto-gen-id-' + uid).attr('id');
window.dfpUID++;
return $adUnit.attr('id') || $adUnit.attr('id', adUnitName.replace(/[^A-z0-9]/g, '_') + '-auto-gen-id-' + window.dfpUID).attr('id');

},

Expand Down Expand Up @@ -475,8 +510,12 @@

$.each(dimensionGroups, function (k, v) {

var dimensionSet = v.split('x');
dimensions.push([parseInt(dimensionSet[0], 10), parseInt(dimensionSet[1], 10)]);
if (v === 'fluid') {
dimensions.push(v);
} else {
var dimensionSet = v.split('x');
dimensions.push([parseInt(dimensionSet[0], 10), parseInt(dimensionSet[1], 10)]);
}

});

Expand All @@ -499,6 +538,8 @@
* @param {Array} $adCollection
*/
dfpLoader = function (options, $adCollection) {
window.googletag = window.googletag || {};
window.googletag.cmd = window.googletag.cmd || [];

function execBlockEvents() {
if(dfpScript.shouldCheckForAdBlockers()) {
Expand All @@ -519,9 +560,6 @@

var loaded = $.Deferred();

window.googletag = window.googletag || {};
window.googletag.cmd = window.googletag.cmd || [];

var gads = document.createElement('script');
gads.async = true;
gads.type = 'text/javascript';
Expand Down
Loading