Help Center Manage Your Account AdSpeed API

Ad

Documentation for API methods to manage one or multiple ads.

API Version

1.2.5 (build 280809). Documentation was last modified on Mon, 16 Nov 2009 08:51:48 EST. Since the API methods and response format can change from one version to another, you should check this page frequently for updates.

API Methods - Ad

• AS.Ads.getCounts
• AS.Ads.getList
• AS.Ads.createStandard
• AS.Ads.createHTML
• AS.Ads.createText
  
  
• AS.Ad.linkToZone
• AS.Ad.unlinkFromZone
• AS.Ad.getServingCode
• AS.Ad.getLinkedZones
• AS.Ad.getServingCodeForLinkedZones
• AS.Ad.getStats

AS.Ads.getCounts

Returns the number of active, pending, deleted and total ads for the publisher

Parameters

• None

Sample Request

Sample Response

<Ads total="32" active="11" pending="18" deleted="3"/>

AS.Ads.getList

Returns the list of ads for this publisher

Parameters

• perpage (Optional, default value is 10)
  The number of items per page
• page (Optional, default value is 1)
  The page number

Sample Request

Sample Response

<Ads total="32" page="1" numpage="8" perpage="4"> <Ad id="32218" name="lekkel.nl" status="pending"/> <Ad id="32484" name="leaderboard" status="pending"/> <Ad id="33628" name="OracleSeminar" status="pending"/> <Ad id="34702" name="Directa" status="pending"/> </Ads>

AS.Ads.createStandard

Create a new standard/external ad (SWF, JPG, GIF, PNG, BMP) for this account. Limit 50 calls/day and use POST

Parameters

• name (Required)
  The name of this ad
• clickurl (Required)
  The destination URL to redirect when someone clicks on this ad (start with http://, must be URL-encoded properly)
• imageurl (Required)
  The URL of an external JPG/GIF/BMP/SWF file (start with http://, must be URL-encoded properly)

Sample Request

Sample Response

<Ad id="123" name="SampleSWFAd" status="active"></Ad>

AS.Ads.createHTML

Create a new RichMedia/HTML ad for this account. Limit 50 calls/day and use POST

Parameters

• name (Required)
  The name of this ad
• html (Required)
  The HTML ad code
• width (Required)
  The ad width in pixels
• height (Required)
  The ad height in pixels

Sample Request

Sample Response

<Ad id="456" name="SampleHTMLAd" status="active"></Ad>

AS.Ads.createText

Create a new text link ad for this account. Limit 50 calls/day and use POST

Parameters

• name (Required)
  The name of this ad
• first (Required)
  The first text line
• next (Required)
  The next text line(s)
• clickurl (Required)
  The destination URL to redirect when someone clicks on this ad (start with http://, must be URL-encoded properly)

Sample Request

Sample Response

<Ad id="456" name="SampleTextLinkAd" status="active"></Ad>

AS.Ad.linkToZone

Links this ad to the specified zone

Parameters

• ad (Required)
  The ad identification
• zone (Required)
  The zone identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name][Zone ID][Zone Name]

Sample Request

Sample Response

<Confirmation ad="36943" zone="7607">LINKED</Confirmation>

AS.Ad.unlinkFromZone

Unlinks this ad from the specified zone

Parameters

• ad (Required)
  The ad identification
• zone (Required)
  The zone identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name][Zone ID][Zone Name]

Sample Request

Sample Response

<Confirmation ad="36943" zone="7607">UNLINKED</Confirmation>

AS.Ad.getServingCode

Returns the serving code for this ad

Parameters

• ad (Required)
  The ad identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name]
• width (Required)
  The ad width in pixels
• height (Required)
  The ad height in pixels

Sample Request

Sample Response

<Ad id="36943" name="Sample Image Ad" status="active"> <ServingCode type="regular"> <!-- AdSpeed.com Serving Code 7.9.4 for [Ad] Sample Image Ad 468x60 --> <script type="text/javascript"><![CDATA[ var a=new Date();var q='&amp;tz='+a.getTimezoneOffset()/60 +'&amp;ck='+(navigator.cookieEnabled?'Y':'N') +'&amp;jv='+(navigator.javaEnabled()?'Y':'N') +'&amp;scr='+screen.width+'x'+screen.height+'x'+screen.colorDepth +'&amp;z='+Math.random() +'&amp;ref='+escape(document.referrer.substr(0,255)) +'&amp;uri='+escape(document.URL.substr(0,255));document.write('<ifr'+'ame width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;aid=36943&amp;wd=468&amp;ht=60&amp;target=_top'+q+'" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"></ifr'+'ame>'); ]]></script> <noscript> <iframe width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;aid=36943&amp;wd=468&amp;ht=60&amp;target=_top" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"> <a href="http://g.adspeed.net/ad.php?do=clk&amp;aid=36943&amp;wd=468&amp;ht=60&amp;pair=as" target="_top"> <img style="border:0px;" src="http://g.adspeed.net/ad.php?do=img&amp;aid=36943&amp;wd=468&amp;ht=60&amp;pair=as" alt="i" width="468" height="60"/> </a> </iframe> </noscript> <!-- AdSpeed.com End --> </ServingCode> </Ad>

AS.Ad.getLinkedZones

Returns the list of zones linked to this ad

Parameters

• ad (Required)
  The ad identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name]
• perpage (Optional, default value is 10)
  The number of items per page
• page (Optional, default value is 1)
  The page number

Sample Request

Sample Response

<Ad id="36943" name="Sample Image Ad" status="active"> <Zones total="3" page="1" numpage="1" perpage="4"> <Zone id="7549" name="Section Travel" status="active"/> <Zone id="7681" name="Section Music" status="active"/> <Zone id="20852" name="Newsletter 468x60 Ad" status="active"/> </Zones> </Ad>

AS.Ad.getServingCodeForLinkedZones

Returns the list of zones linked to this ad and their serving codes

Parameters

• ad (Required)
  The ad identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name]
• perpage (Optional, default value is 10)
  The number of items per page
• page (Optional, default value is 1)
  The page number

Sample Request

Sample Response

<Ad id="36943" name="Sample Image Ad" status="active"> <Zones total="3" page="1" numpage="2" perpage="2"> <Zone id="7549" name="Section Travel" status="active"> <ServingCode type="regular"> <!-- AdSpeed.com Serving Code 7.9.4 for [Zone] Section Travel 468x60 --> <script type="text/javascript"><![CDATA[ var a=new Date();var q='&amp;tz='+a.getTimezoneOffset()/60 +'&amp;ck='+(navigator.cookieEnabled?'Y':'N') +'&amp;jv='+(navigator.javaEnabled()?'Y':'N') +'&amp;scr='+screen.width+'x'+screen.height+'x'+screen.colorDepth +'&amp;z='+Math.random() +'&amp;ref='+escape(document.referrer.substr(0,255)) +'&amp;uri='+escape(document.URL.substr(0,255));document.write('<ifr'+'ame width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;zid=7549&amp;wd=468&amp;ht=60&amp;target=_top'+q+'" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"></ifr'+'ame>'); ]]></script> <noscript> <iframe width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;zid=7549&amp;wd=468&amp;ht=60&amp;target=_top" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"> <a href="http://g.adspeed.net/ad.php?do=clk&amp;zid=7549&amp;wd=468&amp;ht=60&amp;pair=as" target="_top"> <img style="border:0px;" src="http://g.adspeed.net/ad.php?do=img&amp;zid=7549&amp;wd=468&amp;ht=60&amp;pair=as" alt="i" width="468" height="60"/> </a> </iframe> </noscript> <!-- AdSpeed.com End --> </ServingCode> </Zone> <Zone id="7681" name="Section Music" status="active"> <ServingCode type="regular"> <!-- AdSpeed.com Serving Code 7.9.4 for [Zone] Section Music 468x60 --> <script type="text/javascript"><![CDATA[ var a=new Date();var q='&amp;tz='+a.getTimezoneOffset()/60 +'&amp;ck='+(navigator.cookieEnabled?'Y':'N') +'&amp;jv='+(navigator.javaEnabled()?'Y':'N') +'&amp;scr='+screen.width+'x'+screen.height+'x'+screen.colorDepth +'&amp;z='+Math.random() +'&amp;ref='+escape(document.referrer.substr(0,255)) +'&amp;uri='+escape(document.URL.substr(0,255));document.write('<ifr'+'ame width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;zid=7681&amp;wd=468&amp;ht=60&amp;target=_top'+q+'" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"></ifr'+'ame>'); ]]></script> <noscript> <iframe width="468" height="60" src="http://g.adspeed.net/ad.php?do=html&amp;zid=7681&amp;wd=468&amp;ht=60&amp;target=_top" frameborder="0" scrolling="no" allowtransparency="true" hspace="0" vspace="0"> <a href="http://g.adspeed.net/ad.php?do=clk&amp;zid=7681&amp;wd=468&amp;ht=60&amp;pair=as" target="_top"> <img style="border:0px;" src="http://g.adspeed.net/ad.php?do=img&amp;zid=7681&amp;wd=468&amp;ht=60&amp;pair=as" alt="i" width="468" height="60"/> </a> </iframe> </noscript> <!-- AdSpeed.com End --> </ServingCode> </Zone> </Zones> </Ad>

AS.Ad.getStats

Returns the stats for this ad

Parameters

• ad (Required)
  The ad identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Ad ID][Ad Name]
• metric (Required)
  The type of metric can be "impressions", "clicks" or "revenue"
• period (Required)
  The breakdown period can be "hourly", "daily", or "monthly"

Sample Request

Sample Response

<StatRows generated="Mon, 16 Nov 2009 08:51:49 EST" title="Report: Monthly for [Ad] Sample Image Ad"> <StatRow> <Monthly_Impressions>November 2009</Monthly_Impressions> <Unique>409</Unique> <Raw>820</Raw> <Unique_over_Raw>49.88%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>October 2009</Monthly_Impressions> <Unique>788</Unique> <Raw>1,682</Raw> <Unique_over_Raw>46.85%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>September 2009</Monthly_Impressions> <Unique>851</Unique> <Raw>1,805</Raw> <Unique_over_Raw>47.15%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>August 2009</Monthly_Impressions> <Unique>969</Unique> <Raw>1,827</Raw> <Unique_over_Raw>53.04%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>July 2009</Monthly_Impressions> <Unique>883</Unique> <Raw>1,824</Raw> <Unique_over_Raw>48.41%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>June 2009</Monthly_Impressions> <Unique>810</Unique> <Raw>1,657</Raw> <Unique_over_Raw>48.88%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>May 2009</Monthly_Impressions> <Unique>881</Unique> <Raw>1,651</Raw> <Unique_over_Raw>53.36%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>April 2009</Monthly_Impressions> <Unique>759</Unique> <Raw>1,550</Raw> <Unique_over_Raw>48.97%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>March 2009</Monthly_Impressions> <Unique>857</Unique> <Raw>1,692</Raw> <Unique_over_Raw>50.65%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>February 2009</Monthly_Impressions> <Unique>831</Unique> <Raw>1,639</Raw> <Unique_over_Raw>50.70%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>January 2009</Monthly_Impressions> <Unique>850</Unique> <Raw>1,715</Raw> <Unique_over_Raw>49.56%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>December 2008</Monthly_Impressions> <Unique>873</Unique> <Raw>1,722</Raw> <Unique_over_Raw>50.70%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>Total</Monthly_Impressions> <Unique>9,761</Unique> <Raw>19,584</Raw> <Unique_over_Raw>49.84%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>Average</Monthly_Impressions> <Unique>813</Unique> <Raw>1,632</Raw> <Unique_over_Raw>49.84%</Unique_over_Raw> </StatRow> </StatRows>

Other Articles in AdSpeed API

• AdSpeed API Overview
• Advertiser
• Campaign
• Group
• Publisher
• Sample Code
• Website
• Zone

Cannot find an answer for your question? Ask our Customer Care team

Related Articles

• Website

  "Documentation for API methods to manage one or multiple websites. API Version1.2.5 (build 280809). Documentation was last modified on Sun,..."

  100% relevant in Manage Your Account AdSpeed API
• Group

  "Documentation for API methods to manage one or multiple groups. API Version1.2.5 (build 280809). Documentation was last modified on Sun,..."

  93% relevant in Manage Your Account AdSpeed API
• Zone

  "Documentation for API methods to manage one or multiple zones. API Version1.2.5 (build 280809). Documentation was last modified on Mon,..."

  92% relevant in Manage Your Account AdSpeed API
• Campaign

  "Documentation for API methods to manage one or multiple campaigns. API Version1.2.5 (build 280809). Documentation was last modified on Sun,..."

  91% relevant in Manage Your Account AdSpeed API