AdSpeed API

Documentation for API methods to manage one or multiple ads. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 20:25:56 -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 - AdAS.Ads.getCountsAS.Ads.getListAS.Ads.createStandardAS.Ads.createHTMLAS.Ads.createTextAS.Ad.linkToZoneAS.Ad.unlinkFromZoneAS.Ad.getServingCodeAS.Ad.getLinkedZonesAS.Ad.getServingCodeForLinkedZonesAS.Ad.getStatsAS.Ads.getCountsReturns the number of active, pending, deleted and total ads for the publisherParametersNoneSample RequestSample ResponseAS.Ads.getListReturns the list of ads for this publisherParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response AS.Ads.createStandardCreate a new standard/external ad (SWF, JPG, GIF, PNG, BMP) for this account. ...

AdSpeed API Overview

AdSpeed API (Application Programming Interface) is an add-on service we provide to our clients. Publishers and advertisers can write software to automatically collect information about their zones, ads, campaigns, and reports directly from AdSpeed. Web developers are also encouraged to use the API to build applications on our platform. We reserve the right to change the API details and decline or terminate access prior or without notice. ...

Advertiser

Documentation for API methods to manage one or multiple advertisers. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 19:49:03 -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 - AdvertiserAS.Advertisers.getCountsAS.Advertisers.getListAS.Advertisers.createAS.Advertisers.getCountsReturns the number of active, deleted and total advertisers linked to this publisherParametersNoneSample RequestSample ResponseAS.Advertisers.getListReturns the list of advertisers linked to this publisherParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response AS.Advertisers.createCreate a new advertiser account and link it to my publisher account. ...

Campaign

Documentation for API methods to manage one or multiple campaigns. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 19:49:04 -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 - CampaignAS.Campaigns.getCountsAS.Campaigns.getListAS.Campaigns.getCountsReturns the number of active, deleted and total campaigns linked to this advertiserParametersNoneSample RequestSample ResponseAS.Campaigns.getListReturns the list of campaigns linked to this advertiserParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response

Channels

Documentation for API methods to manage one or multiple channels. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 19:49:04 -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 - ChannelAS.Channels.getCountsAS.Channels.getListAS.Channels.getCountsReturns the number of active, deleted and total channels for the publisherParametersNoneSample RequestSample ResponseAS.Channels.getListReturns the list of channels for this publisherParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response

Group

Documentation for API methods to manage one or multiple groups. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 19:49:04 -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 - GroupAS.Groups.getCountsAS.Groups.getListAS.Groups.getCountsReturns the number of active, deleted and total groups for the publisherParametersNoneSample RequestSample ResponseAS.Groups.getListReturns the list of groups for this publisherParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response

Publisher

Documentation for API methods to manage a publisher account. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 20:25:55 -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 - PublisherAS.Publisher.getStatsAS.Publisher.getVisitorStatsAS.Publisher.getStatsReturns stats for the whole publisher account. ...

Sample Code

Please see the example below to access AdSpeed API. PHP $this->mKey,'method'=>$pMethod); $vParams = array_merge($pParams,$vParams); ksort($vParams); // sort the params alphabetically $vParams['md5'] = md5($this->mSecret.http_build_query($vParams,'','&')); $vURL = $this->mEndPoint.'?'.http_build_query($vParams,'','&'); $vCURL = curl_init($vURL); curl_setopt($vCURL,CURLOPT_RETURNTRANSFER,1); // get XML result as string $vResult = curl_exec($vCURL); curl_close($vCURL); return $vResult; } /** * Request API method via POST * @param string method * @param array params * @return string */ public function postAPI($pMethod,$pParams=array()) { $vParams = array('key'=>$this->mKey,'method'=>$pMethod); $vParams = array_merge($pParams,$vParams); ksort($vParams); // sort the params alphabetically $vParams['md5'] = md5($this->mSecret.http_build_query($vParams,'','&')); $vCURL = curl_init($this->mEndPoint); curl_setopt($vCURL,CURLOPT_POST,1); // use POST instead of GET curl_setopt($vCURL,CURLOPT_POSTFIELDS,$vParams); curl_setopt($vCURL,CURLOPT_RETURNTRANSFER,1); // get XML result as string $vResult = curl_exec($vCURL); curl_close($vCURL); return $vResult; } /** * Sample usage * @return void */ public function example() { // GET $vResult = $this->getAPI('AS.Ads.getCounts'); var_dump($vResult); // POST $vParams = array( 'name'=>'TextAdViaAPI', 'first'=>'First Text Line', 'next'=>'Second Line', 'clickurl'=>'http://example.com', ); $vResult = $this->postAPI('AS.Ads.createText',$vParams); var_dump($vResult); } } $vTest = new MyApp(); $vTest->example(); ?> Token Hash Generation In certain methods that deal directly with one or more entities, a "token" parameter is required to verify ownership. The hash is generated by concatenating all the required fields into a single string and generating the MD5 hash for that string. Here is an example to generate token with format [Ad ID][Ad Name][Zone ID][Zone Name]: Ad ID = '1234' Ad Name = 'MyTestAd' Zone ID = '789' Zone Name = 'MyTestZone' token = md5('1234MyTestAd789MyTestZone') token = '971b6ebe7580f203905a0bf3fde9fd7b'

Website

Documentation for API methods to manage one or multiple websites. API Version1.2.7 (build 20110606). Documentation was last modified on Sun, 29 Jan 12 19:50:25 -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 - WebsiteAS.Websites.getCountsAS.Websites.getListAS.Website.getInfoAS.Website.getStatsAS.Websites.getCountsReturns the number of active, deleted and total websites for the publisherParametersNoneSample RequestSample ResponseAS.Websites.getListReturns the list of websites for this publisherParametersperpage (Optional, default value is 10)The number of items per pagepage (Optional, default value is 1)The page numberSample RequestSample Response AS.Website.getInfoReturns the list of linked zones, ads and users for this websiteParameterssite (Required)The website IDtoken (Required)The authentication MD5 hash generated from concatenating [Site ID][Site Name]Sample RequestSample Response One member of the ad network http://siteA.example.com/ AS.Website.getStatsReturns the stats for this website. ...

Zone

Documentation for API methods to manage one or multiple zones. API Version1.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 - ZoneAS.Zones.getCountsAS.Zones.getListAS.Zones.createAS.Zone.getInfoAS.Zone.getServingCodeAS.Zone.serveAS.Zone.getStatsAS.Zone.getVisitorStatsAS.Zones.getCountsReturns the number of active, deleted and total zones for the publisherParametersNoneSample RequestSample ResponseAS.Zones.getListReturns the list of zones for this publisherParametersperpage (Optional, default value is 10)The number of items per page. ...