There was a problem loading the comments.

How to Create a Push Endpoint (XML feed)

Knowledge Base  »  Publishers  »  Viewing Article

  Print

Ads API Request URL Example:

US Data Center
http://sspname.xml.adx1.com/?pubid={publisher-id}&feedid={feed-id}&ip={ip}&lang={language}&useragent={useragent}&user_id={userid}&iab_category={iab_category}&domain={domain}&subscription_timestamp={subscription_timestamp}

Europe Data Center
http://sspname.xml.4armn.com/?pubid={publisher-id}&feedid={feed-id}&ip={ip}&lang={language}&useragent={useragent}&user_id={userid}&iab_category={iab_category}&domain={domain}&subscription_timestamp={subscription_timestamp}

Ads API Request URL Example (with substituted macros):

http://1111.xml.adx1.com/?pubid=1234&feedid=1234&ip=178.219.186.122&lang=ru&useragent=Mozilla/5.0%20(Windows%20NT%2010.0;%20Win64;%20x64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/67.0.3396.99%20Safari/537.36&user_id=123456789&iab_category=IAB3-1&domain=google.com&subscription_date=2018-12-12

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
user_id Optional User ID (ID of a subscriber) in string format
iab_category Optional Integer value representing IAB category of your traffic if applicable
domain Required A website where the subscribers’ base was collected from
subscription_timestamp Required Unix timestamp (seconds since Jan 01 1970. (UTC))
format Optional, Technical If you need need to CHANGE the default response from JSON to XML you should add the parameter &format={xml}
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):

[
{
    "description": "Offer description",
    "title": "Offer title",
    "cpc": 0.03,
    "link": "<a href="
Parameter Required/ Optional Description
description Required Description of the promoted offer
title Required Title of the promoted offer
cpc Required Cost per click in $
link Required URL that is called to notify about a click
image Required Main image of the promoted offer
icon Required Logo image of the promoted offer
id Required ID of the creative (promoted offer)


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">

Share via
Did you find this article useful?  

Related Articles