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:
|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:
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.
|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:
10) Click on “XML reporting API” for detailed activity statistics in XML format.
Your XML Reporting Request Format:
|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.|
|end_date||yyyy-mm-dd||max date interval 7 days|
|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|