JavaScript OX Static Methods

This method allows you to set a custom key-value pair (KVP) for all instances of the OX object. This way, you can set up a single, global KVP within a given pageview.

You must pass this method before the requestAd method.

Parameters

Examples

OX.addVariable("gender","male");

Where gender is a custom key and male is a custom value.

A standalone JavaScript ad tag with the addVariable method might look like the following:

<script type="text/javascript"
src="http://delivery_server_domain/w/1.0/jstag">
</script>

<script type="text/javascript">
OX.addVariable("gender","male");
OX.addVariable("age","40");
OX.requestAd({"auid":"8"});
</script>

Where:

• src="http://delivery_server_domain/w/1.0/jstag: A request to fetch the OpenX JavaScript tag library.

• gender: A custom key.

• male: A custom value.

• age: Another custom key.

• 40: Another custom value.

• OX.requestAd({"auid":"auid"});: The requestAd method, which must be passed after addVariable.

This method determines the default framing behavior for ads loaded in the current page. You can override this behavior for specific instances or requests. The default value is false (disabled). These settings are overridden by features that add iframes automatically, such as auto-refresh.

Example

OX.frameCreatives(false);

The load method:

• Makes a single ad request and does not require setup and use of an OX object instance.
• Accepts a JSON object of parameters to pass to the ad gateway.
• Calls the gateway for an ad.
• Writes it to the DOM using document.write().

Parameters

Examples

OX.load({"auid":"1"});

load example with multiple parameters:

  OX.load({"auid":"12345",
    "tid":"4",
    "tg":"_top",
    "userid":"ABC",
    "r":"http://www.example.com",
    "imp_beacon":"<iframe src='myplace.com'></iframe>",
    "fallback":"<iframe src=/test/ads/468x60-unicef.gif></iframe>",
    "frameCreatives":"true"});

This method is reserved for use by JavaScript-based conversion tags. The recordAction method accepts a JSON array to pass to the gateway for tracking conversions.

Parameters

Example

OX.recordAction({"cvid":"123"});

Assign a user to an audience segment (using the add parameter), remove a user from an audience segment (using the del parameter), or both. This method accepts a JSON array, which can pass multiple segment IDs.

Parameters

Examples

To add the user to a segment:

OX.recordSegments({"add":"1","channel":"homepage"});

To remove the user from a segment:

OX.recordSegments({"del":"6"});

To simultaneously add users to and remove users from a segment:

OX.recordSegments({"add":"1,5,7", "del":"4,6,8"});

The requestAd method:

• Makes a single ad request and does not require setup and use of an OX object instance.
• Accepts a JSON object of parameters to pass to the ad gateway.
• Requires the auid parameter. Its other parameters are optional.
• Immediately calls the gateway for an ad.
• Writes it to the DOM using document.write().

Parameters

Examples

OX.requestAd({"auid":"1"});

requestAd example with multiple parameters:

OX.requestAd({"auid":"12345",
"tid":"4",
"tg":"_top",
"userid":"ABC",
"r":"http://www.example.com",
"ifa":"43043FE3-6BA9-4515-8209-6E0AC6AE1ADF",
"lmt":false,
"imp_beacon":"<iframe src='myplace.com'></iframe>",
"fallback":"<iframe src=/test/ads/468x60-unicef.gif></iframe>",
"vars":{"key1":"value1","key2":"value2"},
"frameCreatives":"true"});

This method sets the base URL of the ad gateway for all instances of the OX object in the current pageview.

Parameters

Example

setGateway setting the domain of the delivery server:

OX.setGateway("http://delivery_server_domain/w/1.0/");

Use this method to indicate the ‘referer’ URL of the page. In most cases, the OpenX JavaScript tag library detects the ‘referer’ URL of the page from the HTTP headers. In some cases, it is not possible to detect the ‘referer’ correctly, due of various browser security restrictions. You can call setRefererURL directly in these cases as necessary to override the value detected by the OpenX tag library.

Parameters

Example

OX.setRefererURL("http://www.example.com");