Help Center Manage Your Account AdSpeed API

Zone

Documentation for API methods to manage one or multiple zones.

API Version

1.2.5 (build 280809). Documentation was last modified on Mon, 16 Nov 2009 00:07:21 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 - Zone

• AS.Zones.getCounts
• AS.Zones.getList
• AS.Zones.create
  
  
• AS.Zone.getInfo
• AS.Zone.getServingCode
• AS.Zone.serve
• AS.Zone.getStats
• AS.Zone.getVisitorStats

AS.Zones.getCounts

Returns the number of active, deleted and total zones for the publisher

Parameters

• None

Sample Request

Sample Response

<Zones total="4" active="4" deleted="0"/>

AS.Zones.getList

Returns the list of zones for this publisher

Parameters

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

Sample Request

Sample Response

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

AS.Zones.create

Create a new zone for this publisher. Limit 50 calls/day

Parameters

• name (Required)
  The name of this zone

Sample Request

Sample Response

<Zone id="888" name="SomeZone" status="active"></Zone>

AS.Zone.getInfo

Returns the list of linked ads for this zone

Parameters

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

Sample Request

Sample Response

<Zone id="7607" name="Homepage" status="active"> <Description>Home page of a demo website</Description> <Ads> <Ad id="35093" name="Sample Text Ad" status="active"/> <Ad id="36943" name="Sample Image Ad" status="active"/> <Ad id="40631" name="Sample Rich HTML Ad" status="active"/> <Ad id="54412" name="Sample Text Link Ad" status="active"/> <Ad id="54937" name="Sample Rich HTML Ad 2" status="active"/> </Ads> </Zone>

AS.Zone.getServingCode

Returns the serving code for this zone

Parameters

• zone (Required)
  The zone ID to get serving code
• token (Required)
  The authentication MD5 hash generated from concatenating [Zone ID][Zone Name]
• width (Required)
  The ad width in pixels
• height (Required)
  The ad height in pixels
• spot (Optional, default value is )
  The ad spot (for non-duplicate, competitive and companion positioning ads)
• num (Optional, default value is )
  The number of ads to be served per single serving code

Sample Request

Sample Response

<Zone id="7607" name="Homepage" status="active"> <ServingCode type="regular"> <!-- AdSpeed.com Serving Code 7.9.4 for [Zone] Homepage 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=7607&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=7607&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=7607&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=7607&amp;wd=468&amp;ht=60&amp;pair=as" alt="i" width="468" height="60"/> </a> </iframe> </noscript> <!-- AdSpeed.com End --> </ServingCode> </Zone>

AS.Zone.serve

Serves an ad from this zone

Parameters

• zone (Required)
  The zone identification
• token (Required)
  The authentication MD5 hash generated from concatenating [Zone ID][Zone Name]
• width (Required)
  The ad width in pixels
• height (Required)
  The ad height in pixels
• spot (Optional, default value is )
  The ad spot (for non-duplicate, competitive and companion positioning ads)
• num (Optional, default value is )
  The number of ads to be served per single serving code

Sample Request

Sample Response

<Serving> <AdCode> <a href="http://g.adspeed.net/ad.php?do=clk&amp;aid=36943&amp;zid=7607&amp;t=1258348042&amp;auth=5E7634DC53" target="_top"> <img style="border:0px;" src="http://www.adspeed.com/img/banners/as-468x60-p100.gif" alt="i"/> </a> </AdCode> <TrackerCode> <div style="position:absolute;left:0px;top:0px;visibility:hidden;"> <img src="http://g.adspeed.net/ad.php?do=imp&amp;zid=7607&amp;aid=36943&amp;auth=5E7634DC53" alt="i" width="1" height="1"/> </div> </TrackerCode> </Serving>

AS.Zone.getStats

Returns the stats for this zone

Parameters

• zone (Required)
  The zone ID
• token (Required)
  The authentication MD5 hash generated from concatenating [Zone ID][Zone 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 00:07:22 EST" title="Report: Monthly for [Zone] Homepage"> <StatRow> <Monthly_Impressions>November 2009</Monthly_Impressions> <Unique>6</Unique> <Raw>18</Raw> <Unique_over_Raw>33.33%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>October 2009</Monthly_Impressions> <Unique>0</Unique> <Raw>0</Raw> <Unique_over_Raw/> </StatRow> <StatRow> <Monthly_Impressions>September 2009</Monthly_Impressions> <Unique>1</Unique> <Raw>2</Raw> <Unique_over_Raw>50.00%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>August 2009</Monthly_Impressions> <Unique>0</Unique> <Raw>0</Raw> <Unique_over_Raw/> </StatRow> <StatRow> <Monthly_Impressions>July 2009</Monthly_Impressions> <Unique>4</Unique> <Raw>4</Raw> <Unique_over_Raw>100.00%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>June 2009</Monthly_Impressions> <Unique>2</Unique> <Raw>10</Raw> <Unique_over_Raw>20.00%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>May 2009</Monthly_Impressions> <Unique>0</Unique> <Raw>0</Raw> <Unique_over_Raw/> </StatRow> <StatRow> <Monthly_Impressions>April 2009</Monthly_Impressions> <Unique>0</Unique> <Raw>0</Raw> <Unique_over_Raw/> </StatRow> <StatRow> <Monthly_Impressions>March 2009</Monthly_Impressions> <Unique>9</Unique> <Raw>136</Raw> <Unique_over_Raw>6.62%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>February 2009</Monthly_Impressions> <Unique>2</Unique> <Raw>5</Raw> <Unique_over_Raw>40.00%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>January 2009</Monthly_Impressions> <Unique>3</Unique> <Raw>3</Raw> <Unique_over_Raw>100.00%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>December 2008</Monthly_Impressions> <Unique>3</Unique> <Raw>19</Raw> <Unique_over_Raw>15.79%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>Total</Monthly_Impressions> <Unique>30</Unique> <Raw>197</Raw> <Unique_over_Raw>15.23%</Unique_over_Raw> </StatRow> <StatRow> <Monthly_Impressions>Average</Monthly_Impressions> <Unique>3</Unique> <Raw>16</Raw> <Unique_over_Raw>15.23%</Unique_over_Raw> </StatRow> </StatRows>

AS.Zone.getVisitorStats

Returns the visitor profile stats for this zone

Parameters

• zone (Required)
  The zone ID
• token (Required)
  The authentication MD5 hash generated from concatenating [Zone ID][Zone Name]
• metric (Required)
  The type of metric can be "countries", "continents", "areas", "regions", "languages", "timezones"
• range (Required)
  The range can be "alltime"

Sample Request

Sample Response

<StatRows generated="Mon, 16 Nov 2009 00:07:22 EST" title="Geographical report for [Zone] Homepage" range="Alltime" metric="countries"> <StatRow> <Rank>1</Rank> <Country>United States</Country> <Flag/> <Visitors>1</Visitors> <Percentage>50.00%</Percentage> </StatRow> <StatRow> <Rank>1</Rank> <Country>Netherlands</Country> <Flag/> <Visitors>1</Visitors> <Percentage>50.00%</Percentage> </StatRow> </StatRows>

Other Articles in AdSpeed API

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

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
• Publisher

  "Documentation for API methods to manage a publisher account. API Version1.2.5 (build 280809). Documentation was last modified on Mon, 16..."

  86% relevant in Manage Your Account AdSpeed API
• Ad

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

  83% 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,..."

  82% relevant in Manage Your Account AdSpeed API