XML Feed Implementation Reference

The XML API feed implementation reference has been designed to make ads integration with websites as simple as possible.

Request URL:

http://%ENDPOINT%.xml.adx1.com/?pubid=%PUBLISHER_ID%&subid=%SOURCE_ID%&feedid=%FEED_ID%&q=%KEYWORD%&useragent=%USERAGENT%&ip=%REMOTE_IP_ADDRESS%&ref=%HTTP_REFERRER%&num=%NUMBER_OF_ADS%&lang=%LANGUAGE%&max-response=%MAX_RESPONSE%&=iab_category=%IAB_CATEGORY%

Example request:

http://pop-under.xml.adx1.com/?pubid=28082&subid=1&feedid=497&q=test&useragent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31 &ip=161.55.44.133&ref=http://testsite.com&num=10&lang=en&max-response=0.5&iab_category=39

Making a Request:

Replace the above parameters with valid user request details and perform a GET request.

Request parameters:

The XML Request should contain the parameters listed below:

Parameter  Type  Description
endpoint String Corresponds to the type of traffic sent to the feed. NOTE: The endpoint is issued by the system automatically. No changes are needed.
pubid Numeric Integer value representing your account id number.
subid String Sub affiliate id to track traffic sub sources / sub affiliates.
feedid Numeric Integer value representing your feed id (site id) number.
ip String Actual IP address of the USER. NOTE: This is not the IP address of the server making the request. Format: XXX.XXX.XXX.XXX

Obtain from REMOTE_ADDR

q String (URL encoded) Query keyword requested by the USER.
num Numeric Number of ads returned by the feed. Default: 10
ref String (URL encoded) Full URL of the page where the ads are being displayed. NOTE: Should be exactly the same as the USER's click referer.

URL-encoded.

useragent String (URL encoded) Useragent from HTTP header of the USER. Obtain from USER-AGENT
lang String Accepted USER languages. Obtain from HTTP_ACCEPT_LANGUAGE
iab_category Numeric Integer value representing IAB category of your traffic if applicable. Non-obligatory parameter



Example response:

<result status="OK" response="0.7424771308899">

<record>

<pos>1</pos>

<title><![CDATA[ Test Ad Title ]]></title>

<url>domain.com</url>

<description><![CDATA[ Some description goes here ]]></description>

<bid>0.01</bid>

<click><![CDATA[ http://domain.com/?utm_source=platform ]]></click>

<image><![CDATA[ ]]></image>

<pixel><![CDATA[<img width="0" height="0" src="http://domain.com/>]]></pixel>

</record>

</result>

Still need help? Contact Us Contact Us