If you have any question left, please drop a note with the discussion link of this page.
REST V2009-07-01 Admedia
From Wiki.zanox.com
Products
GET: Retrieving single product item
GET: Retrieving product items by a specified program
GET: Contextual product search
GET: Retrieving product categories
Admedia
GET: Retrieving a single admedium item
GET: Retrieving a list of admedia items
GET: Retrieving admedia categories
Programs
GET: Retrieving a single program item
GET: Programsearch
GET: Returns all programs for a specified user adspace
GET: Returns all zanox program categories
POST: Creating a new program application
DELETE: Deleting an existing program application
Reports
GET: Retrieving a single sale item
GET: Retrieving a single lead item
GET: Retrieving all sale items
GET: Retrieving all lead items
GET: Retrieving aggregated Report
Payments
GET: Retrieving all payment items
GET: Retrieving a single payment item
GET: Retrieving all balance items
GET: Retrieving a single balance item
GET: Retrieving all account items
GET: Retrieving a single account item
Adspaces
GET: Retrieving a single adspace item
GET: Retrieving all adspace items related to the user
POST: Creating a new advertising space
PUT: Updating properties of an advertising space
DELETE: Removing an advertising space
Profiles
GET: Retrieve the user profile
PUT: Update the user profile
The admedia RESTFul API resource enables the retrieval of advertising media.
Contents |
GET: Retrieving a single admedium item
A GET request using an admedia URI returns the properties of an admedia.
Parameters
| Name | Necessity | Parameter type | Description |
|---|---|---|---|
| connectid | mandatory | header parameter or query parameter | connectid is required for authorization. It is responsible for getting your tracking links in the result. |
| admedium | mandatory | path parameter | ID of admedium item. |
| adspace | optional | query parameter | constrain the returned tracking links to a specified adspace. This parameter has also influence on the value inside the code field of the response item. |
| callback | optional | query parameter | Supported if format is JSON. Name of the JS function the result is wrapped in. |
Example Request
// REST XML http://api.zanox.com/xml/2009-07-01/admedia/admedium/10421?connectid=580599047DF8F5311043 // REST JSON http://api.zanox.com/json/2009-07-01/admedia/admedium/10421?connectid=580599047DF8F5311043 // REST JSONP http://api.zanox.com/json/2009-07-01/admedia/admedium/10421?connectid=580599047DF8F5311043&callback=handler // REST XML using Header Authorization GET /xml/2009-07-01/admedia/admedium/1 HTTP/1.1 Host: api.zanox.com Date: Mon, 09 Sep 2008 08:17:35 GMT Authorization: ZXWS 580599047DF8F5311043
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response xmlns="http://api.zanox.com/namespace/2009-07-01/"> <admediumItem id="255850"> <name>baby_big Flash 016 234x60</name> <adrank>6.8</adrank> <height>60</height> <width>234</width> <format id="9">234 x 60 IMU Half Banner</format> <code><![CDATA[<script language="javascript" src="http://www.zanox-affiliate.de/ppv/images/programs/flash_load/flash_loader.js">.......]]></code> <admediumType>java</admediumType> <program id="4903">mobilefun4u MY</program> <category id="23567">Baby- Big</category> <trackingLinks> <trackingLink adspaceId="123123"> <ppv>http://ad.zanox.com/ppv/?9519541C1407536706S123123&zpar9=[[11163954E59A0B5DFDFF36]]</ppv> <ppc>http://ad.zanox.com/ppc/?9519541C1407536706S123123&zpar9=[[11163954E59A0B5DFDFF36]]</ppc> </trackingLink> </trackingLinks> </admediumItem> </response>
GET: Retrieving a list of admedia items
Returns a filtered list of admedia out of the zanox Affiliate Network. By default, the sort order is descending based on the admediums AdRank.
| Please note that you have to specify either a program or the partnership parameter to indirect, otherwise the paging does not work correctly |
Parameters
| Name | Necessity | Parameter type | Description |
|---|---|---|---|
| connectid | mandatory | header parameter or query parameter | connectID is required for authorization. It is responsible for getting your tracking links in the result. |
| program | optional | query parameter | Limits the search to a distinct program. |
| ip | optional | query parameter | Currently geotargeting is supported only by a small number of advertisers for showcases. |
| region | optional | query parameter | Limits the search to a specified region. Not implemented yet! |
| format | optional | query parameter | Limits the search to a distinct format, e.g. 200px x 200px. Values for linkFormat filter: Possible link formats |
| admediumtype | optional | query parameter | Limits the search to a distinct type of admedia, e.g. text, image, script. Values for type filter: List of AdMedia Types |
| purpose | optional | query parameter | Limits the search to a distinct purpose type of admedia, e.g. startpage, productdeeplink, categorydeeplink.Not implemented yet! |
| partnership | optional | query parameter | Limits the search to a specified partnership ==> direct or indirect. Not implemented yet! |
| category | optional | query parameter | Limits the search to a distinct admedia-category. admedia-categories are program-specific. Values for the category filter can be retrieved using the following example: Retrieving admedia categories |
| adspace | optional | query parameter | constrain the returned tracking links to a specified adspace. This parameter has also influence on the value inside the code field of the response item. |
| items | optional | query parameter | Number of requested items per page. Valid values are between "1" and "50". Default value is "10". Use this for paging. |
| page | optional | query parameter | Index of selected page starting by "0". items * (page + 1) has to be less or equal than total number of items. Default value is "0". Use this for paging. |
| callback | optional | query parameter | Supported if format is JSON. Name of the JS function the result is wrapped in. |
Example Request
// REST XML http://api.zanox.com/xml/2009-07-01/admedia?connectid=580599047DF8F5311043 // REST JSON http://api.zanox.com/json/2009-07-01/admedia?connectid=580599047DF8F5311043 // REST JSONP http://api.zanox.com/json/2009-07-01/admedia?connectid=580599047DF8F5311043&callback=handler // REST XML using Header Authorization GET /xml/2009-07-01/admedia?program=324&ip=192.11.22.33&category=106&format=8 HTTP/1.1 Host: api.zanox.com Date: Mon, 09 Jun 2008 08:17:35 GMT Authorization: ZXWS 580599047DF8F5311043
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response xmlns="http://api.zanox.com/namespace/2009-07-01/"> <page>0</page> <items>3</items> <total>2376</total> <admediumItems> <admediumItem id="399181">...</admediumItem> <admediumItem id="399182">...</admediumItem> <admediumItem id="399183">...</admediumItem> </admediumItems> </response>
GET: Retrieving admedia categories
Admedia categories represent the way the program organizes its admedia inventory.
Parameters
| Name | Necessity | Parameter type | Description |
|---|---|---|---|
| connectid | mandatory | header parameter or query parameter | connectid is required for authorization. It is responsible for getting your tracking links in the result. |
| program | mandatory | path parameter | Retrieves all admedia categories for the specified program. |
| callback | optional | query parameter | Supported if format is JSON. Name of the JS function the result is wrapped in. |
Example Request
// REST XML http://api.zanox.com/xml/2009-07-01/admedia/categories/program/3277?connectid=580599047DF8F5311043 // REST JSON http://api.zanox.com/json/2009-07-01/admedia/categories/program/3277?&connectid=580599047DF8F5311043 // REST JSONP http://api.zanox.com/json/2009-07-01/admedia/categories/program/3277?connectid=580599047DF8F5311043&callback=handler // REST XML using Header Authorization GET /xml/2009-07-01/admedia/categories/program/3277 HTTP/1.1 Host: api.zanox.com Date: Mon, 09 Jun 2008 08:17:35 GMT Authorization: ZXWS 580599047DF8F5311043
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response xmlns="http://api.zanox.com/namespace/2009-07-01/"> <categories> <category id="1175">Eigentracking</category> <category id="1192">Textlinks</category> <category id="1211">Banner 468 x 60</category> <category id="1212">Banner 234 x 60</category> <category id="1213">Skript Werbemittel</category> <category id="1214">Produktsuche</category> <category id="1215">Kategorie-Deeplinks</category> <category id="4897">Flash_Banner</category> <category id="4901">LOGO</category> <category id="4902">BILD > Kategorie-Deeplinks</category> <category id="4903">120x600_Skyscraper</category> <category id="4904">Andere Formate</category> </categories> </response>