Implement BidVertiser XML Feed, Add Ads In Search Results

BidVertiser XML Feed can be used for displaying ads in search results. For implementing BidVertiser ads in an XML format you need to submit a valid HTTP request with a set of required parameters, parse the XML-formatted response and display it in your search results pages.

To Implement the BidVertiser XML Feed, simply follow the below given steps:

1) Login to your Bidvertiser account.

2) Click on Publishers center. Make sure you have a site already added for displaying ads.

3) Go to Manage XML –> Add new XML feed.

4) Select a website for which you want to add ads from “Choose the website to link the XML Feed to:” drop down menu.

5) Enter the XML title.

6) Click on “Update and Continue”.

7) Go to: XML Feeds Center.

8) Click on “Implement XML feed”.

BidVertiser XML Feed Implementation Instruction:

To receive the BidVertiser Sponsored Ads in an XML format, you will need to submit a valid HTTP request in the following format:

<span class="mceItemHidden" data-mce-bogus="1">http://bdv.bidvertiser.com/BidVertiser.dbm?pid=549702&bid=1378356&Kterm=[]&<span class="hiddenSpellError" pre="" data-mce-bogus="1">cip</span>=[]&<span class="hiddenSpellError" pre="" data-mce-bogus="1">maxcount</span>=[]&<span class="hiddenSpellError" pre="" data-mce-bogus="1">ownid</span>=<span class="hiddenSpellError" pre="" data-mce-bogus="1">xml1</span>&<span class="hiddenSpellError" pre="" data-mce-bogus="1">bvref</span>=[]&<span class="hiddenSpellError" pre="" data-mce-bogus="1">xml</span>=1&u_agnt=[]
</span>

Parameter	Description	Required	Comments
pid	Unique id to identify your account with BidVertiser	Required
bid	Unique id to identify specific XML Feed	Required
Kterm	Search Term, the “search phrase” or “keyword” that the user is searching for.	Required
cip	IP address of the user that the ads will be served to, usually the REMOTE_ADDR HTTP Header	Required	Must be identical to the IP of the click!
maxcount	The maximum number of ads to display.	Required	Default is 5, Maximum is 10
bvref	The actual page URL of the website the ads are served from (real referrer).	Required	Must be URL-Encoded.<brMust be identical to the referrer of the click!
u_agnt	The User-Agent of the customer triggering the request		Must be URL-Encoded. Must be identical to the User-Agent of the click!
showimgs	Show CPC image ads along with the traditional text ads		Set as “1” to enable image ads
ownid	Unique identifier that allows you to segment different traffic sources (SubID). Reports are provided	Required	If not set by you, must be set as “xml1”

XML Feed Example:

For example here’s what a sample XML Feed request with your unique feed might look like:

http://bdv.bidvertiser.com/BidVertiser.dbm?pid=549702&bid=1378356&&Kterm=make+money&cip=122.172.251.242&bvref=http%3A%2F%2Fwww.referrer.com&u_agnt=Mozilla%2F4.0+%28compatible%3B+MSIE+6.0%3B+Windows+NT+5.1%29&ownid=xml1&xml=1

As you can see, for this example we used your own IP address as the “cip” parameter. This must be replaced, of course, dynamically, with the IP of the user that initiates the request on real-time, as well as the “bvref”, “u_agnt” and “Kterm” parameters.

XML Reply:

<span class="mceItemHidden" data-mce-bogus="1"><!--?xml version="1.0" encoding="ISO-8859-1" ?-->
<bidvertiserxml>
<requestinfo>
<pid>549702</pid>
<bid>1378356</bid>
<cip>122.172.251.242</cip>
<kterm>travel</kterm>
<category>7</category>
<maxcount>5</maxcount>
<ownid>111</ownid>
<lang>4</lang>
<u_agnt><!--[<span class="hiddenSpellError" pre="" data-mce-bogus="1"-->CDATA[]]></u_agnt>
<bvref><!--[CDATA[http:%2f%2fwww.test.com]]--></bvref>
</requestinfo>
<resultsinfo>
<resultscount>2</resultscount>
</resultsinfo>
<results>
<adcontent>
<titlet>Fast Cash From Home 
<descriptiont>$500 to $3500 Per Day This Flat Out Works
<displayurlt>HomeBizOffers4u.com 
<redirectt>redirect url 
<cpc>0.050000 </cpc>
</redirectt></displayurlt></descriptiont></titlet></adcontent>
<adcontent>
<adtype>image</adtype>
<adwidth>468</adwidth>
<adheight>60</adheight>
<adsource>IMAGE_SOURCE_ON_BIDVERTISER_SERVERS</adsource>
<redirect>redirect url </redirect>
<cpc>0.050000</cpc>
</adcontent>
</results>
</bidvertiserxml>
</span>

Element	Description
General Elements:
Bidvertiserxml	identifying a BidVertiser XML response
Requestinfo	to ease QA and debugging, the request data is sent back as part of the XML response
Resultscount	Number of ads that are being sent as part of the XML response. Equal or less than the maxcount
Text Ad Elements:
Title	Title of the ad. Equal or less than 25 chars
displayURL	Display URL that can be shown as part of the ad. Equal or less than 25 chars
Redirect	The target URL to redirect to when clicking the ad
cpc	Net CPC (US$)
Image Ad Elements (valid if the request contains “showimgs=1”)
adtype	Will be set as “image” for image ad
adwidth	The width, in pixels, of the image
adheight	The height, in pixels, of the image
adsource	The URL to grab the image from (from BidVertiser servers
Redirect	The target URL to redirect to when clicking the image ad
cpc	Net CPC (US$)

9) For a bespoke PHP implementation, click on “PHP Feed Implementation”.

PHP Sample XML Feed Implementation:

Sample PHP code is provided for a quick implementation of our XML feed – you can use the following PHP code as an implementation sample to get you started:

Your XML Feed Request Format:

<span class="mceItemHidden" data-mce-bogus="1"><!--?<span class="hiddenSpellError" pre="" data-mce-bogus="1"-->php
ini_set('display_errors', 'On');
error_reporting(E_ALL | E_STRICT);
$pid = '549702';
$bid = '1378356';
$ownid = 'xml1'; // if sending traffic with sub affiliates. modify to fit your needs.
$maxcount = '5'; // max number of results to return. modify to fit your needs.
$u_agnt = <span class="hiddenSpellError" pre="terms " data-mce-bogus="1">urlencode</span>($_SERVER['HTTP_USER_AGENT']); // user agent. do not modify
$cip = $_SERVER['REMOTE_ADDR']; // IP address of user requesting search. do not modify
// acquire search terms
if(<span class="hiddenSpellError" pre="" data-mce-bogus="1">isset</span>($_REQUEST['terms']) && !empty($_REQUEST['terms'])){
$terms = urlencode($_REQUEST['terms']);
}else{
echo get_search_form();
exit;
}
$bvref = trim($_SERVER['HTTP_REFERER']);
$<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span> = "http://bdv.bidvertiser.com/BidVertiser.dbm?pid=$pid&bid=$bid&Kterm=$terms&cip=$cip&maxcount=$maxcount"
."&bvref=$bvref&u_agnt=$u_agnt&ownid=$ownid&xml=1";
$result = call_xml($<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span>, $u_agnt);
// check if results came back from the feed
if (<span class="hiddenSpellError" pre="" data-mce-bogus="1">strstr</span>($result, "title") === FALSE) { $msg = "No results found.";}else{$msg="";}
echo get_search_form($terms, $msg);
echo format_result($result);
/*
<span class="hiddenSpellError" pre="" data-mce-bogus="1">Parses</span> and display the result of the XML feed
@param $result - The result of the XML feed
@returns - the HTML version of the XML results
*/
function format_result($result){
$title = array();
$<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span> = array();
$redirect = array();
$description = array();
preg_match_all('#<title><!\[CDATA\[(.*?)\]\]></title>#', $result, $title);
preg_match_all('#<displayurl><!--\[CDATA\[(.*?)\]\]--></displayurl>#', $result, $<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span>);
preg_match_all('#<redirect><!--\[CDATA\[(.*?)\]\]--></redirect>#', $result, $redirect);
preg_match_all('#<description><!--\[CDATA\[(.*?)\]\]--></description>#', $result, $description);
$items = count($title[1]);
$rv = '';
for($<span class="hiddenGrammarError" pre="" data-mce-bogus="1">i</span>=0; $i<$items; $<span class="hiddenGrammarError" pre="" data-mce-bogus="1">i</span>++){
$rv .= '


<li>
<a href=".$redirect[1][$i].">'.$title[1][$i].'</a>
'.$description[1][$i].'
'.
$url[1][$i].
'

</li>
<p>
';
}// end for
return $rv;
}// end function
/*
Obtains the search <span class="hiddenSpellError" pre="" data-mce-bogus="1">form</span>
@param $terms - the default search term
@param $msg - alert message
@returns - The HTML <span class="hiddenSpellError" pre="return " data-mce-bogus="1">form</span>
*/
function get_search_form($terms="", $msg=""){
if (!empty($msg)) {
$msg = "<span color="red" data-mce-style="color: red;" style="color: red;"><b>$msg</b></span>

<br />
<hr>
<p>

";
}// end if
$form = "
$msg
Please enter your search term


<br />
<form method="post" action="".$_SERVER["PHP_SELF"]."">
Keyword: <input type="text" name="terms" value="$terms">


<input type="submit" value="Search">
</form>
<p>

<br />
<hr>
<p>


";
return $form;
}// end function
/*
Calls the XML feed
@param $<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span> - the URL of the feed to call
@param $ua - The user agent
@returns - the result of the query from the feed
*/
function call_xml($<span class="hiddenSpellError" pre="param " data-mce-bogus="1">url</span>, $ua="")
{
$hostname=trim($_SERVER['HTTP_HOST']);
$ch = curl_init($<span class="hiddenSpellError" pre="" data-mce-bogus="1">url</span>);
curl_setopt($ch, CURLOPT_USERAGENT, $ua);
curl_setopt($ch, CURLOPT_REFERER, $hostname);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
$result = curl_exec($ch);
curl_close($ch);
return $result;
}// end function
?>
</span>

10) Click on “XML reporting API” for detailed activity statistics in XML format.

Your XML Reporting Request Format:

https://secure.bidvertiser.com/bidvertiser/bdv_pub_report_XML_summary_api.dbm?pid=549702&bid=1378356&token=[]&start_date=[]&end_date=[]

Required Parameters:

Parameter	Description	Comments
pid	Unique id to identify your account with BidVertiser
bid	Unique id to identify specific XML Feed
token	API token issues by BidVertiser	Please contact your representative or open a support ticket to receive your token.
start_date	yyyy-mm-dd
end_date	yyyy-mm-dd	max date interval 7 days

Optional Parameters:

Element	Description	Comments
subid	Specific Subid Show statistics for specific subid only
groupby_date=1	Group records by date
groupby_publisher=1	Group records by publisher
records_per_page	Number of records per page. Default value: 500	Maximum allowed: 500
page	Access specific page if more than 1