enableLazyLoad(lazyLoadConf)
Global Function
Enables GPT's Lazy Loading for serving ads only when it's necessary.
The lazy load config ooptions are:
- fetchMarginPercent, minimum distance from the current viewport a slot
must be before we fetch the ad as a percentage of viewport size.
0 means "when the slot enters the viewport",
100 means "when the ad is 1 viewport away"
- renderMarginPercent, minimum distance from the current viewport a slot
must be before we render an ad.
This allows for prefetching the ad, but waiting to render and
download other subresources. The value works just like
fetchMarginPercent as a percentage of viewport.
- mobileScaling, a multiplier applied to margins on mobile devices.
This allows varying margins on mobile vs. desktop. For example,
a mobileScaling of 2.0 will multiply all margins by 2 on mobile
devices, increasing the minimum distance a slot can be before
fetching and rendering.
Returns
-
boolean
- true if the object is of type Array, otherwise false
Links
clearPageTargetingForKey
Global Function
Removes page targeting for a specified key from GPT ad calls
Links
setPageCollapseEmpty
Global Function
Sets behaviour of empty slots can be 'after', 'before' or 'never'
- 'after' collapse slots that return an empty ad
- 'before' collapses all slots and only displays them when an ad is found
- 'never' does not collapse any empty slot, the collapseEmptyDivs method is not called in that case
Links
enableCompanions
Global Function
When companions are enabled we delay the rendering of ad slots until
either a master is returned or all slots are returned without a master
Links
updateCorrelator
Global Function
The correlator is a random number added to ad calls.
It is used by the ad server to determine which impressions where served to the same page
Updating is used to tell the ad server to treat subsequent ad calls as being on a new page
Links
filterNestedParams(nestedParams, keysToStrip)
Global Function
Remove unwanted params from nested query strings
Returns
-
string
- [return description]
Links
stripUrlParams(...)
Global Function
Purge a URL of sensitive data in query strings
Given the URL
https://www.ft.com/search?q=goog&cust_params=a%3D1%26b%3D2%26c%3D3%26d%3D4
Supplying an object in the form
{
root: ['q', 'kw'],
cust_params: ['a', 'c']
}
will remove q from the main query string and a, c from the nested params
under cust_params:
https://www.ft.com/search?cust_params=b=2%26d%3D4
Returns
-
string
- A URL that has been stripped of the supplied params
Links
defaults
Global Property
Default configuration set in the constructor.
Links
new Config
Defines a store for configuration information and returns a getter/setter method for access.
Links
new Slot
The Slot class.
Methods
-
parseAttributeConfig
- (instance) parse slot attribute config
-
initLazyLoad
- (instance) Load a slot when it appears in the viewport
-
initResponsive
- (instance) Listen to responsive breakpoints and collapse slots
where the configured size is set to false
-
maximise
- (instance) Maximise the slot when size is 100x100
-
setName
- (instance) If the slot doesn't have a name give it one
-
collapse
- (instance) add the empty class to the slot
-
addClass
- (instance) add the additional class to the slot
-
setFormatLoaded
- (instance) sets a classname of the format
-
uncollapse
- (instance) remove the empty class from the slot
-
clear
- (instance) call the ad server clear method on the slot if one exists
-
destroy
- (instance) call the ad server destroySlot method on the slot if one exists
-
submitImpression
- (instance) call the ad server impression URL for an out of page slot if it has been configured correctly for delayed impressions
-
fire
- (instance) fire an event on the slot
-
addContainer
- (instance) add a div tag into the current slot container
-
centerContainer
- (instance) Add a center class to the main container
-
labelContainer
- (instance) Add a label class to the main container
Links
new Slots
The Slots instance tracks all ad slots on the page
configures global page events used by a slot and
provides utlity methods that act on all slots
Methods
-
collapse
- (instance) Given a slot name or an array of slot names will collapse the slots using the collapse method on the slot
-
uncollapse
- (instance) Given a slot name or an array of slot names will uncollapse the slots using the uncollapse method on the slot
-
refresh
- (instance) Given a slot name or an array of slot names of slotnames will refresh the slots using the refresh method on the slot
-
clear
- (instance) Given a slot name or an array of slot names will clear the slots using the clear method on the slot
-
destroy
- (instance) Given a slot name or an array of slot names will destroy the slots using the destroySlot method on the slot and remove the reference to the slot
-
submitImpression
- (instance) Given a slot name will submit a delayed impression for the slot
-
initSlot
- (instance) Confirms a container in the page exists and creates a Slot object
Links
module:utils/events
Utility methods for o-ads events. Methods defined here are added to the utils object not the utils.event object.
Methods
-
broadcast(...)
- (static) Broadscasts an o-ads event
-
on(...)
- (static) Sets an event listener for an oAds event
-
off(...)
- (static) Removes an event listener for an oAds event
-
once(...)
- (static) Sets a one time event listener for an oAds event
Links
module:utils
Utility methods for the advertising library.
Properties
-
isArray
-
Test if an object is an Array
-
isString
-
Test if an object is a String
-
isFunction
-
Test if an object is a Function
-
isStorage
-
Test if an object is a Storage object
-
isObject
-
Test if an object is an Object
-
isWindow
-
Test if an object is the global window object
-
isPlainObject
-
Test if an object inherits from any other objects, used in extend
to protect against deep copies running out of memory and constructors
losing there prototypes when cloned
-
isNonEmptyString
-
Test if an object is a string with a length
-
hash
-
Create an object hash from a delimited string
Beware all properties on the resulting object will have string values.
-
attach
-
Takes a script URL as a string value, creates a new script element, sets the src and attaches to the page
The async value of the script can be set by the seccond parameter, which is a boolean
Note, we should use protocol-relative URL paths to ensure we don't run into http/https issues
-
dehyphenise
-
Remove hyphens from a string and upper case the following letter
-
parseAttributeName
-
remove prefixes from o-ads data attributes and dehyphenise the name
-
getQueryString
-
return the current documents search or an empty string if non exists
also strips the initial ? from the search string for easier parsing
This method enables us to mock the search string in our tests reliably and doesn't really serve any other purpose
-
getQueryParamByName
-
Get a query string parameter by name from a url
-
getTimestamp
-
returns a timestamp of the current date/time in the format YYYYMMDDHHMMSS
-
iframeToSlotName
-
Given the window object of an iframe this method returns the o-ads slot name
that rendered the iframe, if the iframe was not rendered by o-ads this will
return false
Links
module:utils/log
Utility methods for logging.
Properties
-
isOn
-
Determine if debug logging is on and if the type if supported
-
warn
-
Log a warning message
-
error
-
Log an error message
-
info
-
Log an info message
-
start
-
Start a collapsed group
-
end
-
End a collapsed group
Links
module:utils/log(type, args)
Safe logger for the browser
Properties
-
isOn
-
Determine if debug logging is on and if the type if supported
-
warn
-
Log a warning message
-
error
-
Log an error message
-
info
-
Log an info message
-
start
-
Start a collapsed group
-
end
-
End a collapsed group
Links
module:utils
Utility methods for postMessage api.
Properties
-
isArray
-
Test if an object is an Array
-
isString
-
Test if an object is a String
-
isFunction
-
Test if an object is a Function
-
isStorage
-
Test if an object is a Storage object
-
isObject
-
Test if an object is an Object
-
isWindow
-
Test if an object is the global window object
-
isPlainObject
-
Test if an object inherits from any other objects, used in extend
to protect against deep copies running out of memory and constructors
losing there prototypes when cloned
-
isNonEmptyString
-
Test if an object is a string with a length
-
hash
-
Create an object hash from a delimited string
Beware all properties on the resulting object will have string values.
-
attach
-
Takes a script URL as a string value, creates a new script element, sets the src and attaches to the page
The async value of the script can be set by the seccond parameter, which is a boolean
Note, we should use protocol-relative URL paths to ensure we don't run into http/https issues
-
dehyphenise
-
Remove hyphens from a string and upper case the following letter
-
parseAttributeName
-
remove prefixes from o-ads data attributes and dehyphenise the name
-
getQueryString
-
return the current documents search or an empty string if non exists
also strips the initial ? from the search string for easier parsing
This method enables us to mock the search string in our tests reliably and doesn't really serve any other purpose
-
getQueryParamByName
-
Get a query string parameter by name from a url
-
getTimestamp
-
returns a timestamp of the current date/time in the format YYYYMMDDHHMMSS
-
iframeToSlotName
-
Given the window object of an iframe this method returns the o-ads slot name
that rendered the iframe, if the iframe was not rendered by o-ads this will
return false
Links
Ads#init(options)
Instance Method
Initialises the ads library and all sub modules
Links
Ads#updateTargeting
Instance Method
Update page level targeting data in o-ads and GPT
Links
slotMethods.defineSlot
Static Method
define a GPT slot
Links
slotMethods.destroySlot
Static Method
Tell gpt to destroy the slot and its metadata
Links
slotMethods.setUnitName
Static Method
Set the DFP unit name for the slot.
Links
slotMethods.addServices
Static Method
Add the slot to the pub ads service and add a companion service if configured
Links
slotMethods.setCollapseEmpty
Static Method
Sets the GPT collapse empty mode for a given slot
values can be 'after', 'before', 'never'
Links
slotMethods.setURL
Static Method
Sets page url to be sent to google
prevents later url changes via javascript from breaking the ads
Links
slotMethods.setTargeting
Static Method
Adds key values from a given object to the slot targeting
Links
FT.ads.config
Static Method
The FT.ads.config object holds the confiuration properties for an FT.ads.gpt instance.
There are four tiers of configuration; cookie level config, default config (set within the constructor), metatag config and global (env) config.
Global config, (set in the page FT.env ojbect) takes priority over meta followed by default config with cookie config having the least priority.
The FT.ads.config() function acts as an accessor method for the config; allowing getting and setting of configuration values.
Calling config() with no parameters returns the entire configuration object.
Calling config passing a valid property key will envoke the 'getter' and return the value for that property key.
Calling config passing a valid property key and a value will envoke the setter and set the value of the key to the new value.
Calling config passing an object of keys and values will envoke a setter that extends the store with the object provided.
Links
Slot#parseAttributeConfig
Instance Method
parse slot attribute config
Links
Slot#initLazyLoad
Instance Method
Load a slot when it appears in the viewport
Links
Slot#initResponsive
Instance Method
Listen to responsive breakpoints and collapse slots
where the configured size is set to false
Links
Slot#maximise
Instance Method
Maximise the slot when size is 100x100
Links
Slot#setName
Instance Method
If the slot doesn't have a name give it one
Links
Slot#collapse
Instance Method
add the empty class to the slot
Links
Slot#addClass
Instance Method
add the additional class to the slot
Links
Slot#uncollapse
Instance Method
remove the empty class from the slot
Links
Slot#clear
Instance Method
call the ad server clear method on the slot if one exists
Links
Slot#destroy
Instance Method
call the ad server destroySlot method on the slot if one exists
Links
Slot#submitImpression
Instance Method
call the ad server impression URL for an out of page slot if it has been configured correctly for delayed impressions
Links
Slot#fire
Instance Method
fire an event on the slot
Links
Slot#addContainer
Instance Method
add a div tag into the current slot container
Links
Slot#centerContainer
Instance Method
Add a center class to the main container
Links
Slot#labelContainer
Instance Method
Add a label class to the main container
Links
Slots#collapse
Instance Method
Given a slot name or an array of slot names will collapse the slots using the collapse method on the slot
Links
Slots#uncollapse
Instance Method
Given a slot name or an array of slot names will uncollapse the slots using the uncollapse method on the slot
Links
Slots#refresh
Instance Method
Given a slot name or an array of slot names of slotnames will refresh the slots using the refresh method on the slot
Links
Slots#clear
Instance Method
Given a slot name or an array of slot names will clear the slots using the clear method on the slot
Links
Slots#destroy
Instance Method
Given a slot name or an array of slot names will destroy the slots using the destroySlot method on the slot and remove the reference to the slot
Links
Slots#submitImpression
Instance Method
Given a slot name will submit a delayed impression for the slot
Links
Slots#initSlot
Instance Method
Confirms a container in the page exists and creates a Slot object
Links
Targeting#socialFlow
Instance Method
If there is a query parameter called socialflow=xxx, we need to add it
as a tag
Links
module:utils/events.broadcast(...)
Static Method
Broadscasts an o-ads event
Links
module:utils/events.on(...)
Static Method
Sets an event listener for an oAds event
Links
module:utils/events.off(...)
Static Method
Removes an event listener for an oAds event
Links
module:utils/events.once(...)
Static Method
Sets a one time event listener for an oAds event
Links
module:utils.isArray
Static Property
Test if an object is an Array
Links
module:utils.isString
Static Property
Test if an object is a String
Links
module:utils.isFunction
Static Property
Test if an object is a Function
Links
module:utils.isStorage
Static Property
Test if an object is a Storage object
Links
module:utils.isObject
Static Property
Test if an object is an Object
Links
module:utils.isWindow
Static Property
Test if an object is the global window object
Links
module:utils.isPlainObject
Static Property
Test if an object inherits from any other objects, used in extend
to protect against deep copies running out of memory and constructors
losing there prototypes when cloned
Links
module:utils.isNonEmptyString
Static Property
Test if an object is a string with a length
Links
module:utils.hash
Static Property
Create an object hash from a delimited string
Beware all properties on the resulting object will have string values.
Links
module:utils.attach
Static Property
Takes a script URL as a string value, creates a new script element, sets the src and attaches to the page
The async value of the script can be set by the seccond parameter, which is a boolean
Note, we should use protocol-relative URL paths to ensure we don't run into http/https issues
Links
module:utils.dehyphenise
Static Property
Remove hyphens from a string and upper case the following letter
Links
module:utils.parseAttributeName
Static Property
remove prefixes from o-ads data attributes and dehyphenise the name
Links
module:utils.getQueryString
Static Property
return the current documents search or an empty string if non exists
also strips the initial ? from the search string for easier parsing
This method enables us to mock the search string in our tests reliably and doesn't really serve any other purpose
Links
module:utils.getQueryParamByName
Static Property
Get a query string parameter by name from a url
Links
module:utils.getTimestamp
Static Property
returns a timestamp of the current date/time in the format YYYYMMDDHHMMSS
Links
module:utils.iframeToSlotName
Static Property
Given the window object of an iframe this method returns the o-ads slot name
that rendered the iframe, if the iframe was not rendered by o-ads this will
return false
Links
module:utils/log.isOn
Static Property
Determine if debug logging is on and if the type if supported
Links
module:utils/log.warn
Static Property
Log a warning message
Links
module:utils/log.error
Static Property
Log an error message
Links
module:utils/log.info
Static Property
Log an info message
Links
module:utils/log.start
Static Property
Start a collapsed group
Links
module:utils/log.end
Static Property
End a collapsed group
Links