Help Center > Manage Your Account > AdSpeed API

Zone

Documentation for API methods to manage one or multiple zones.

API Version

1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 20:17:05 -0500. 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

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="pending"/>
    <Ad id="54412" name="Sample Text Link Ad" status="pending"/>
    <Ad id="54937" name="Sample Rich HTML Ad 2" status="active"/>
    <Ad id="56782" name="Sample Image Ad 2" status="pending"/>
  </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 (competitive or companion positioning)
  • num (Optional, default value is )
    The number of ads to display together
  • custom (Optional, default value is )
    Custom parameters (should be encoded properly, eg: & is %26)
Sample Request
Sample Response
<Zone id="7607" name="Homepage" status="active">
  <ServingCode type="regular">
<!-- AdSpeed.com  Serving Code 7.9.5 for [Zone] Homepage 468x60 -->
    <script type="text/javascript"><![CDATA[
	var a=new Date();d=document;n=navigator;s=screen;var q='&amp;tz='+a.getTimezoneOffset()/60 +'&amp;ck='+(n.cookieEnabled?'Y':'N') +'&amp;jv='+(n.javaEnabled()?'Y':'N') +'&amp;scr='+s.width+'x'+s.height+'x'+s.colorDepth +'&amp;z='+Math.random() +'&amp;ref='+escape(d.referrer.substr(0,255)) +'&amp;uri='+escape(d.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="https://www.adspeed.com/Knowledges/question.html?id=338" target="_blank">
      <img style="border:0px;" src="http://g.adspeed.net/ad.php?do=error&amp;type=-2&amp;wd=468&amp;ht=60" 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=-2&amp;auth=32DBD13B88" alt="i" width="1" height="1"/>
    </div>
  </TrackerCode>
</Serving>

AS.Zone.getStats

Returns the stats for this zone. Limit 50 calls/day
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="Sun, 29 Jan 12 20:17:06 -0500" title="Report: Monthly  for [Zone] Homepage">
  <StatRow>
    <Monthly>January 2012</Monthly>
    <Unique_Impression>1</Unique_Impression>
    <Gross_Impression>2</Gross_Impression>
    <Unique_over_Gross_Impression>50.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>December 2011</Monthly>
    <Unique_Impression>1</Unique_Impression>
    <Gross_Impression>1</Gross_Impression>
    <Unique_over_Gross_Impression>100.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>November 2011</Monthly>
    <Unique_Impression>2</Unique_Impression>
    <Gross_Impression>5</Gross_Impression>
    <Unique_over_Gross_Impression>40.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>October 2011</Monthly>
    <Unique_Impression>3</Unique_Impression>
    <Gross_Impression>6</Gross_Impression>
    <Unique_over_Gross_Impression>50.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>September 2011</Monthly>
    <Unique_Impression>3</Unique_Impression>
    <Gross_Impression>4</Gross_Impression>
    <Unique_over_Gross_Impression>75.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>August 2011</Monthly>
    <Unique_Impression>1</Unique_Impression>
    <Gross_Impression>6</Gross_Impression>
    <Unique_over_Gross_Impression>16.67%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>July 2011</Monthly>
    <Unique_Impression>5</Unique_Impression>
    <Gross_Impression>103</Gross_Impression>
    <Unique_over_Gross_Impression>4.85%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>June 2011</Monthly>
    <Unique_Impression>4</Unique_Impression>
    <Gross_Impression>13</Gross_Impression>
    <Unique_over_Gross_Impression>30.77%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>May 2011</Monthly>
    <Unique_Impression>0</Unique_Impression>
    <Gross_Impression>0</Gross_Impression>
    <Unique_over_Gross_Impression/>
  </StatRow>
  <StatRow>
    <Monthly>April 2011</Monthly>
    <Unique_Impression>4</Unique_Impression>
    <Gross_Impression>5</Gross_Impression>
    <Unique_over_Gross_Impression>80.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>March 2011</Monthly>
    <Unique_Impression>14</Unique_Impression>
    <Gross_Impression>15</Gross_Impression>
    <Unique_over_Gross_Impression>93.33%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>February 2011</Monthly>
    <Unique_Impression>1</Unique_Impression>
    <Gross_Impression>2</Gross_Impression>
    <Unique_over_Gross_Impression>50.00%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>Total</Monthly>
    <Unique_Impression>39</Unique_Impression>
    <Gross_Impression>162</Gross_Impression>
    <Unique_over_Gross_Impression>24.07%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>Average</Monthly>
    <Unique_Impression>3</Unique_Impression>
    <Gross_Impression>14</Gross_Impression>
    <Unique_over_Gross_Impression>24.07%</Unique_over_Gross_Impression>
  </StatRow>
</StatRows>

AS.Zone.getVisitorStats

Returns the visitor profile stats for this zone. Limit 50 calls/day
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="Sun, 29 Jan 12 20:17:06 -0500" title="Geographical report for [Zone] Homepage" range="Alltime" metric="countries"/>
Print

Other Articles in AdSpeed API

Documentation about building applications with AdSpeed API
Search Help Center
There was a problem with your submission. Please correct the following items:

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

    Related Articles

    • Website i
      "Documentation for API methods to manage one or multiple websites. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, ..."
      100% relevant in Manage Your Account > AdSpeed API
    • Publisher i
      "Documentation for API methods to manage a publisher account. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 ..."
      83% relevant in Manage Your Account > AdSpeed API
    • Ad i
      "Documentation for API methods to manage one or multiple ads. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, ..."
      83% relevant in Manage Your Account > AdSpeed API
    • Advertiser i
      "Documentation for API methods to manage one or multiple advertisers. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, ..."
      71% relevant in Manage Your Account > AdSpeed API

    Have questions? Contact Us

    Testimonials for our Ad Servers

    • I am extremely pleased with AdSpeed. Their technology has made our business shine with improved profits, mostly due to their unique ad server and amazing support. There is no other company I would even consider to compare to AdSpeed.

      Markus S.
      CEO, Dream Ware Enterprise

    • That was fast and works exactly right! Thanks again for your superb support!

      Dr Tom Bailey
      Aquarium Fish

    Help Center


    i

    Blog

    February 04, 2012

    How does video ad serving work? - Video advertising has proven itself as an effective advertising platform since the first television advertisement in 1941. As more and more viewers watch television programs, music videos, Internet shows, and viral clips on the Internet, advertisers gain interest in the market.

    read more
    December 22, 2011

    Happy Holidays! - Our 11th year in the ad serving business is winding down with more than 30 billions ads served to satisfaction. Online advertising continues to be the leading edge of technology and marketing.

    read more

    Ad Serving

    Ad Serving is the process of placing advertisements on web sites, mobile devices, and applications.

    Ad Servers

    Ad Servers are technology companies with software and infrastructure to enable publishers and advertisers to select and display the most suitable, most profitable, most targeted ads to their audience. Ad servers monitor and report ad views, ad clicks and performance of advertising campaigns.

    © 2012 AdSpeed® Ad Server. All rights reserved.
    Ad Serving | Ad Servers | Ad Tracking