For basic use, a DFP account with Google is required.
Each targeting/tracking supplier will require their own configuration and setup.
Demos for all ads currently served across ft.com are available in the Origami Registry.
Includes detailed installation and set-up instructions, along with details about the module.
To build the documentation locally, from the
docs directory, run:
bundle install jekyll build
It will generate a
_site directory where generated site will be compiled
You can then run the jekyll local server by executing
See the test documentation
You will need a
GITHUB_TOKEN environment variable with access to the repository in your .env file
Get a github token with "repo" access and make it accessible as an environment variable.
npm run release (patch|minor|major|x.y.z) in
master then follow the interactive steps.
This will bump version numbers in the source and commit them, push to github and create a new release.
The command uses release-it under the hood as well as genversion to automatically bump version numbers in the source.
This release removes integration with Krux for behavioural targeting.
The origami component o-permutive can be used for behavioural tracking instead.
This release introduces the following changes:
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.
o-adsexposes a new
setupMetricsmethod that simplifies obtaining performance metrics.
setupMetricsaccepts two parameters:
A guide can to the new names can also be found in this two diagrams:
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
import oAds from 'o-ads'
'never'and defaults to
FTConsentand specify which consent the user has given as part of the value like this: