Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@financial-times/o-ads
Advanced tools
@financial-times/o-ads - npm Package Compare versions
Comparing version 16.0.0 to 16.0.1
| "use strict"; | ||
| // generated by genversion | ||
| module.exports = '15.0.0'; | ||
| module.exports = '16.0.1'; |
@@ -28,3 +28,3 @@ { | ||
| "name": "@financial-times/o-ads", | ||
| "version": "16.0.0", | ||
| "version": "16.0.1", | ||
| "dependencies": { | ||
@@ -31,0 +31,0 @@ "ftdomdelegate": "^4.0.0", |
| # oAds [](https://circleci.com/gh/Financial-Times/o-ads/tree/master) | ||
| This is an Origami module that enables advertising from [Google's DFP Ad Server (part of Ad Manager)](https://support.google.com/admanager/answer/6022000?hl=en), and provides customised demographic, behavioural (via [Krux](http://www.krux.com/)), and contextual (via [Admantx](http://admantx.com/)) targeting. | ||
| This is an Origami module that enables advertising from [Google's DFP Ad Server (part of Ad Manager)](https://support.google.com/admanager/answer/6022000?hl=en), and provides customised demographic and contextual (via [Admantx](http://admantx.com/)) targeting. | ||
@@ -49,71 +49,2 @@ ## Requirements | ||
| ### Upgrading to v14 | ||
| This release does not change any o-ads behaviour however it now uses the latest major versions of all Origami sub-dependencies. | ||
| The following origami dependencies were updated: o-colors,o-visual-effects, o-viewport, o-grid, ftdomdelegate | ||
| Some CSS properties needed to be updated in order to work with the updated down-stream dependancies. | ||
| We have also added document.visibilityState to the Origami Required [BrowserFeatures](https://origami.ft.com/spec/v1/manifest/#browserfeatures) list as the polyfill for this feature was removed from the latest version of o-viewport. | ||
| ### Upgrading to v13 | ||
| This release removes integration with Krux for behavioural targeting. | ||
| The origami component [o-permutive](https://registry.origami.ft.com/components/o-permutive) can be used for behavioural tracking instead. | ||
| ### Upgrading to v12 | ||
| This release introduces the following changes: | ||
| 1. **`o-ads` is now recording a performance mark for every event that it dispatches.** The performance mark will have the same name as the event that originated it plus, in some cases, a suffix that helps determine the circumstances that triggered the event. This is all being used internally by `o-ads` to provide new metrics functionality. | ||
| 2. **`o-ads` exposes a new `setupMetrics` method that simplifies obtaining performance metrics.** `setupMetrics` accepts two parameters: | ||
| - An array of objects containing the configuration of the different metrics that need to be tracked. | ||
| - A callback function to be called whenever any of the trigger events of any of those configuration objects is dispatched. | ||
| 3. **Several custom events fired by o-ads have been renamed for different reasons.** This is the list of events whose name has changed: | ||
| Old event name | New event name | ||
| :--:|:--: | ||
| startInitialisation | initialising | ||
| moatIVTcomplete | IVTComplete | ||
| apiRequestsComplete | adsAPIComplete | ||
| adServerLoadSuccess | serverScriptLoaded | ||
| ready | slotReady | ||
| render |slotCanRender | ||
| gptDisplay |slotGoRender | ||
| rendered | slotRenderStart | ||
| complete | slotExpand | ||
| adIframeLoaded | slotRenderEnded | ||
| A guide can to the new names can also be found in this two diagrams: | ||
| #### Event renaming pt. 1 | ||
|  | ||
| #### Event renaming pt. 2 | ||
|  | ||
| ### Upgrading to v11 | ||
| As of version 11, o-ads has been updated to use ES modules. Unfortunately, this means it is not backwards compatible with CJS modules and clients cannot `require('o-ads')` anymore. | ||
| - Breaking change: if importing o-ads in your build, you must now do it as follows: `import oAds from 'o-ads'` | ||
| ### Upgrading to v10 | ||
| - Breaking change: o-ads now defaults to never collapsing empty ads slots following google gpt behavior. | ||
| - Breaking change: collapsing config oAds takes 3 possible options for the `collapseEmpty` attribute: `'before'`, `'after`', `'never'` and defaults to `'never'` | ||
| - Breaking change: collapsing ads for a specific slot on the markup now uses `'before'`, `'after`', `'never'` instead of `true` and `false` previously | ||
| - Breaking change: Global collapse empty behavior is set in `config.collapseEmpty` instead of `config.gpt.collapseEmpty` previously | ||
| ### Upgrading to v9 | ||
| - Breaking change: o-ads now requires consent before loading Krux or adding custom targeting to the ad calls. Consent can be provided in two ways: | ||
| 1. Provide a cookie with the name `FTConsent` and specify which consent the user has given as part of the value like this: `behaviouraladsOnsite:on,programmaticadsOnsite:on` | ||
| 2. Initialise o-ads with the `disableConsentCookie` option. | ||
| ### Upgrading to v8 | ||
| - Breaking change: If you use the destroy method on a slots instance, this will now properly destroy the given slots rather than just clear them | ||
| - New feature: util event 'off' - remove an event listener | ||
| [Available here](https://github.com/financial-times/o-ads/blob/master/MIGRATION.md) |
| // generated by genversion | ||
| module.exports = '15.0.0'; | ||
| module.exports = '16.0.1'; |
No alert changes
Worsened metrics
- Total package byte prevSize
- decreased by-1.87%
206345
- Number of lines in readme file
- decreased by-58.82%
49
No dependency changes