The XML-RPC Tag is similar to a local-mode tag but can be used for ads stored on a remote server. An XML-RPC Tags can be written in any language to read and print the data returned by OpenX. XML-RPC is simply a protocol which uses XML to encode the calls and HTTP as a transport mechanism (http://en.wikipedia.org/wiki/XML-RPC).

The XML-RPC tags generated by OpenX contains a comment above it with tips on placing the tag on your website. An example of PHP script for OpenX XML-RPC tag (with the comment block removed) is shown below:

 

  <?php
  //ini_set('include_path', '.:/usr/local/lib');
  require 'openads-xmlrpc.inc.php';
  if (!isset($OA_context)) $OA_context = array();
  $oaXmlRpc = new OA_XmlRpc('localhost', '/openads/www/delivery/axmlrpc.php', 0, false, 15);
  $adArray = $oaXmlRpc->view('zone:5', 0, '', '', 0, $OA_context);
  echo $adArray['html'];
  ?>

 

Note: The above code will not work for your OpenX. You will have to generate the invocation code from your OpenX because domain name and path settings will be different.

You must place the example file – openads-xmlrpc.inc.php – on the server of the publisher's website. You must then either change the 'ini_set' line to tell the script where this file is located, or you must change the 'require' line to use an absolute path:

 

  // remove the 2 slashes to uncomment the ini_set line
  ini_set('include_path', '.:/path/to/the/file');
  // or, edit the require line:
  require '/path/to/openads-xmlrpc.inc.php';

 

All lines except the 'echo' line at the end are intended to be placed before any output from your website. The 'echo' displays the banner on the website. In order to display multiple banners you will want to make multiple calls at the top of your document, and 'echo' the relevant banners where you wish.

To prevent displaying multiple banners we've added the option "Don't show the banner again on the same page" to the invocation tag, which uses the $OA_context array:

 

<?php
  //ini_set('include_path', '.:/usr/local/lib');
  require 'openads-xmlrpc.inc.php';
  if (!isset($OA_context)) $OA_context = array();
  $oaXmlRpc = new OA_XmlRpc('localhost', '/openads/www/delivery/axmlrpc.php', 0, false, 15);
  // this is for 3 banners
  // change $n<=3 to the # of banners you want
  for ($n=1; $n++; $n<=3) {
    $adArray[$n] = $oaXmlRpc->view('zone:5', 0, '', '', 0, $OA_context);
    $OA_context[] = array('!=' => 'bannerid:'.$adArray['bannerid']);
  }
?>

 

Note: XML-RPC tags are intended to use by advanced users who have a basic understanding of programming, whether in PHP or any other language