Ads API Request URL Example:
Ads API Request URL Example (with substituted macros):
| Parameter | Required / Optional | Description |
| sspname | Required | Issued by DSP |
| pubid | Required | Integer value representing publisher id number (substituted from the publisher’s side) |
| feedid | Optional | Integer value representing site id number (substituted from the publisher’s side) |
| ip | Required | 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 |
| lang | Optional | User language in alpha-2 |
| useragent | Required | Useragent from HTTP header of the USER. Obtain from USER-AGENT |
| iab_category | Optional | Integer value representing IAB category of your traffic if applicable. |
| domain | Required | 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. |
| q | Optional | keyword |
| impression-number | Optional | Serial number of the impression which should be sent to the certain unique user during 24 hour. Format: Integer value from 0 to infinity. |
| format | Optional | If you need need to CHANGE the default response from XML to JSON you should add the parameter &format={json} |
| max-banners | Optional, Technical | If you are able to accept multi responses to 1 request you should add the parameter &max-banners to indicate the number of ads you want to get. For example, max-banners={5} means we will send 5 responses to 1 your request. |
We can send a bid response in default or non-default format:
Default bid response (XML):
<?xml version="1.0" encoding="UTF-8"?>
<result>
<record>
<strid>993852</strid>
<title>2086690</title>
<url>erdecisesgeorg.info</url>
<description>2086690</description>
<bid>0.00001375</bid>
<click>
<![CDATA[<a href="">
Non-default bid response (JSON):
">[
{
"id": "2113726_1705510228",
"title": "2098308",
"description": "2098308",
"link": "<a href="">
Multi Bid response (XML):
"><?xml version="1.0" encoding="UTF-8"?>
<result>
<record>
<strid>0</strid>
<title>Title</title>
<url>myland.com</url>
<description>Message</description>
<bid>0.003</bid>
<click><![CDATA[<a href="">
Multi Bid response (JSON):
">[
{
"id": "32390_1211",
"title": "Title",
"description": "Message",
"icon": "<a href="https://our.domain.com/postback/click?key=v2-1623386188973-7-1683-387295-aec81058-b863-4c59-8531-43e8c3fb1e40">
Jan 11, 2024