If you have any question left, please drop a note with the discussion link of this page.

REST V2009-05-01 Admedia

From Wiki.zanox.com

Jump to: navigation, search

Products
  GET: Retrieving a single product item
  GET: Retrieving all product items by advertiser program
  GET: Contextual Product Search
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: Retrieving all program items
  GET: Programsearch
  GET: Retrieving programs for a given category
  GET: Returns the last 20 advertiser program news
  GET: Returns all available program categories
  GET: Returns all programs for a specified user adspace
  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

applicationId mandatory header parameter or query parameter applicationId 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 → /adspace/{adspaceid}
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/admedia/admedium/10421?applicationid=CE665464E0186EA44282
 
// REST JSON
http://api.zanox.com/json/admedia/admedium/10421?applicationid=CE665464E0186EA44282

// REST JSONP
http://api.zanox.com/json/admedia/admedium/10421?applicationid=CE665464E0186EA44282&callback=handler

// REST XML using Header Authorization
GET /xml/admedia/admedium/1 HTTP/1.1
Host: api.zanox.com
Date: Mon, 09 Sep 2008 08:17:35 GMT
Authorization: ZXWS CE665464E0186EA44282

Example Response 

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://api.zanox.com/namespace/2009-02-01/">
    <admediaResult>
        <admediumItem id="10421">
            <name>Name</name>
            <adrank>8.5</adrank>
            <height>100</height>
            <width>200</width>
            <type id="179">Image with text</type>
            <program id="475">Name of Program</program>
            <image>http://www.cyrillus.fr/productimage/71/BTP/4X_20425_3028.jpg</image>
            <code>language=javascript; ....</code>
            <category id="6">Logobanner</category>
            <url>
                <adspace id="22">http://www.zanox-affiliate.de/ppc/77122C834740481</adspace>
                <adspace id="34">http://www.zanox-affiliate.de/ppc/77172C834740488</adspace>
            </url>
        </admediumItem>
    </admediaResult>
</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.

Parameters

applicationId mandatory header parameter or query parameter applicationId 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.
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
format optional query parameter Limits the search to a distinct format, e.g. 200px x 200px.
Values for linkFormat filter: Possible link formats
linkType 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
ipaddress optional query parameter Currently geotargeting is supported only by a small number of advertisers for showcases.
adspace optional query parameter constrain the returned tracking links to a specified adspace → /adspace/{adspaceid}
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/admedia?applicationid=CE665464E0186EA44282
 
// REST JSON
http://api.zanox.com/json/admedia?applicationid=CE665464E0186EA44282

// REST JSONP
http://api.zanox.com/json/admedia?applicationid=CE665464E0186EA44282&callback=handler

// REST XML using Header Authorization
GET /xml/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 CE665464E0186EA44282


Example Response 

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://api.zanox.com/namespace/2008-05-21/">
	<page>0</page>
	<items>3</items>
	<total>2376</total>
	<admediaResult>
	    <admediumItem id="399181">...</admediumItem>
	    <admediumItem id="399182">...</admediumItem>
	    <admediumItem id="399183">...</admediumItem>
	</admediaResult>
</response>
 

GET: Retrieving admedia categories

Retrieves program-specific meta data about admedia.
Admedia categories represent the way the program organizes its admedia inventory.

Example Request 

// REST XML
http://api.zanox.com/xml/admedia/program/3277/categories?applicationid=CE665464E0186EA44282
 
// REST JSON
http://api.zanox.com/json/admedia/program/3277/categories?&applicationid=CE665464E0186EA44282

// REST JSONP
http://api.zanox.com/json/admedia/program/3277/categories?applicationid=CE665464E0186EA44282&callback=handler

// REST XML using Header Authorization
GET /xml/admedia/program/3277/categories HTTP/1.1
Host: api.zanox.com
Date: Mon, 09 Jun 2008 08:17:35 GMT
Authorization: ZXWS CE665464E0186EA44282

Example Response 

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://api.zanox.com/namespace/2008-05-21/">
	<admediumResult>
		<categories xml:lang="en">
			<category id="1">Example Category 1</category>
			<category id="2">Example Category 2</category>
			<category id="3">Example Category 3</category>
			<category id="4">Example Category 4</category>
		</categories>
	</admediumResult>
</response>
 
Retrieved from "http://wiki.zanox.com/en/REST_V2009-05-01_Admedia"
Personal tools