OpenXJS

Usage

Initialization

Initialize OpenXJS object by passing object containing deliveryUrl and default parameters which will be attached to all openx queries.

var openXJS = new OpenXJS({deliveryUrl: "http://your.openx.server/openx/www/delivery/",parameters: {}});

Display ads

Fill elments with ids banner1 and banner2 with content from OpenX zone 1 and 2. targetingParameters will overwrite default parameters passed on initialization in case of conflict.

openXJS.displayAds({banner1: 1, banner2: 2}, targetingParameters, callback);

Receive ad codes

Receive ad codes from OpenX zone 1 and 2. targetingParameters will overwrite default parameters passed on initialization in case of conflict.

openXJS.receiveAdCodes({banner1: 1, banner2: 2}, targetingParameters, callback);

// Response
{
  banner1: "code to display ad from zone 1",
  banner2: "code to display ad from zone 2"
}

Test

make test

Browser tests

1. Setup Sauce Connect
2. Enter your sauce credentials into test/auth/sauce.json using the following json:

{"username": "my-user", "key": "my-key"}

3. Run node support/mocha-cloud.js

Contributing

openxjs is maintained by Softgames

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request