GET /admedia

API Overview
Updated on
 
Affiliate link search method. Returns a list of admediumItems.  See admediumItem element definition in WSDL/XSD. 
This resource does not require a signed request, only a connect ID. See Authentication documentation for REST and SOAP. Passing connectid as query parameter in REST is supported.

Resource URL

XML: https://api.zanox.com/xml/2011-03-01/admedia
JSON: https://api.zanox.com/json/2011-03-01/admedia

Parameters

program
optional

Limits results to a particular program ID.

Value Type: Integer program ID.
Example Value: 12345

region
optional

Limits results to programs from a particular region.

Value Type: String
Example Values:  "DE", "FR", "IT".

format
optional

Limits results to an ad media format.  

Value Type: String
Example Values:  Possible values are listed here.

admediumtype
optional

Limits results to an ad media type.

Value Type: String
Example Values:  "html", "script", "image", "imagetext", "text".

purpose
optional

Limits results to a type of link to the advertiser shop.

Value Type: String
Example Values:   "startpage", "productdeeplink", "categorydeeplink".

partnership
optional

Limits results to either programs to whom the publisher has successfully applied ("direct"), or to those who belong to zanox's publicly available ad pool ("indirect").

Value Type: String
Example Values:  "direct", "indirect".

category
optional

Limits results to one of the program's ad media categories. Ad media categories are defined by each advertiser for their program, and can be retrieved using GetAdmediumCategories.

Value Type: String
Example Values:  

adspace
optional

Limits results to tracking links associated with this ad space.

Value Type: Integer

items
optional

See Paging.

Value Type: Integer

page
optional

See Paging.

Value Type: Integer

Example Request

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetAdmediaResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>1</items>
    <total>37</total>
    <admediumItems>
        <admediumItem id="802">
            <name>4 Textlink A</name>
            <adrank>0.0</adrank>
            <admediumType>text</admediumType>
            <program id="209">JeansWelt.de</program>
            <title>Levi's, Mustang, Only Jeans, G-Star, Replay, Wrangler ... Mode & Jeans portofrei online kaufen
                bei www.jeanswelt.de.
            </title>
            <description>Textlink beinhaltet die stärksten Marken und
                führt direkt zur Startseite
            </description>
            <category id="6046">Textlinks</category>
            <trackingLinks>
                <trackingLink adspaceId="1187906">
                    <ppv>http://www.zanox-affiliate.de/ppv/?15825981C61725438&zpar9=[[580599047DF8F5311043]]</ppv>
                    <ppc>http://www.zanox-affiliate.de/ppc/?15825981C61725438&zpar9=[[580599047DF8F5311043]]</ppc>
                </trackingLink>
            </trackingLinks>
        </admediumItem>
    </admediumItems>
</GetAdmediaResponse>

 

 

 

 

Admedia Formats

ID Width Height Description
1 120 600 120 x 600 IMU Skyscraper
2 160 600 160 x 600 IMU Wide Skyscraper
3 180 150 180 x 150 IMU Rectangle
4 300 250 300 x 250 IMU Medium Rectangle
5 336 280 336 x 280 IMU Large Rectangle
6 240 400 240 x 400 IMU Vertical Rectangle
7 250 250 250 x 250 IMU Square Pop-up
8 468 60 468 x 60 IMU Full Banner
9 234 60 234 x 60 IMU Half Banner
10 120 240 120 x 240 IMU Vertical Banner
11 120 90 120 x 90 IMU Button #1
12 120 60 120 x 60 IMU Button #2
13 125 125 125 x 125 IMU Square Button
14 88 31 88 x 31 IMU Micro Button
15 728 90 728 x 90 IMU Leaderboard
16 300 600 300 x 600 IMU Half Page Ad
17 200 200 200 x 200 Square Banner
18 250 600 250 x 600 Junior Page
19 120 468 120 x 468 Skyscraper II
20 468 400 468 x 400 Flap Banner
21 300 400 300 x 400 PopUp
22 600 400 600 x 400 Interstitial Layer
23 140 350 140 x 350
24 250 240 250 x 240 - Rectangle
25 250 120 250 x 120 - Rectangle
26 400 468 400 x 468 Flap Skyscraper
27 430 600 430 x 600 - Rectangle
28 300 260 300 x 260 - Rectangle
29 400 265 400 x 265 - Skyscraper
30 750 100 750 x 100 Billboard
31 200 600 200 x 600 - Skyscraper
32 425 350 425 x 350 TV - Rectangle
33 120 120 120 x 120 - Square Button
34 980 120 980 x 120 - Banner
35 150 50 150 x 50 - Banner
36 160 160 160 x 160 - Square Button
37 610 250 610 x 250 - Double Medium Rectangle
38 300 50 300 x 50 MOBILE - X-Large Banner 6:1
39 216 36 216 x 36 MOBILE - Large Banner 6:1
40 168 28 168 x 28 MOBILE - Medium Banner 6:1
41 120 20 120 x 20 MOBILE - Small Banner 6:1
42 300 75 300 x 75 MOBILE - X-Large Banner 4:1
43 216 54 216 x 54 MOBILE - Large Banner 4:1
44 168 42 168 x 42 MOBILE - Medium Banner 4:1
45 120 30 120 x 30 MOBILE - Small Banner 4:1
46 80 60 80 x 60 - Button
47 178 90 178 x 90 - Button
55 500 500 500 x 500 - Square Banner

 

Resource Information

Rate Limited? No
Authentication Requires connect ID. See
REST Authentication
SOAP Authentication
Response Formats json, xml
HTTP Methods GET
Resource family AdMedia
Response Object admediumItem
API Version 2011-03-01