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

Admedia Methods

From Wiki.zanox.com

Jump to: navigation, search

Advertising media (admedia) contains different types of images and html, text and javascript code snippets. The SOAP admedia methods enable the retrieval of these advertising media items. Advertising media items are a standard part of an advertiser program.

Admedia can only be retrieved via this API.


Contents

GetAdmedia

Example Request

 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAdmedia>
         <ns:programId>418</ns:programId>
         <ns:type>805</ns:type>
         <ns:categoryId>170</ns:categoryId>
         <ns:page>1</ns:page>
         <ns:items>10</ns:items>
         <ns:applicationId>1234567890987654321</ns:applicationId>
      </ns:GetAdmedia>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetAdmediaResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <page>1</page>
            <items>10</items>
            <total>28</total>
            <admediaResult>
               <admediumItem id="140380">... </admediumItem>
               .
               .
               .
               <admediumItem id="138506">...</admediumItem>
            </admediaResult>
         </return>
      </GetAdmediaResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for GetAdmedia


GetAdmediaByIp

==>The format parameter is equivalent to the linkFormatIds (Id), described under the following link: Possible link formats (All possible link formats)

==>All parameters have to be set, otherwise you will get an error!

Example Request

 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAdmediaByIp>
         <ns:ipAddress>85.178.93.177</ns:ipAddress>
         <ns:programId>2808</ns:programId>
         <ns:categoryId>11337</ns:categoryId>
         <ns:format>4</ns:format>
         <ns:applicationId>1234567890987654321</ns:applicationId>
      </ns:GetAdmediaByIp>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetAdmediaByIpResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <admediaResult>...</admediaResult>
         </return>
      </GetAdmediaByIpResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for GetAdmediaByIp


GetAdmedium

Example Request

 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAdmedium>
         <ns:admediaId>124593</ns:admediaId>
         <ns:applicationId>9483E574075AA858AA2E</ns:applicationId>
      </ns:GetAdmedium>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetAdmediumResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <admediaResult>
               <admediumItem id="124593">
                  <name>056 Specials Scarface Banner</name>
                  <adrank>0.0</adrank>
                  <height>250</height>
                  <width>300</width>
                  <image>ad.jamster.com/landingpages/campaigns/int_o_flow/scarface2</image>
                  <code><![CDATA[<script language="javascript" src="http://ad.jamba.net/js/affiliate_flash_loader.js"></script>
<script language="javascript" src="http://ad.jamster.com/creatives/default/specials/scarface/ringtones_300x250_zanox_01.js"></script>
<script type="text/javascript">
ringtones_300x250("http://##tracking_host_name##/?##tracking_partner_id##C##tracking_partner_check_num##&ULP=");
</script>
<noscript><a href="http://##tracking_host_name##/?##tracking_partner_id##C##tracking_partner_check_num##&ULP=" target="_blank"><img src="http://ad.jamster.com/creatives/default/specials/scarface/ringtones_300x250_alt.gif" border="0"></a></noscript>]]></code>
                  <type id="805">JAVA</type>
                  <program id="2808">Jamster USA</program>
                  <category id="11337">05 Specials</category>
                  <url>
                     <adspace id="784330">http://ad.zanox.com/ppc/?9754511C11344835S784330</adspace>
                     <adspace id="784334">http://ad.zanox.com/ppc/?9754511C11344835S784334</adspace>
                  </url>
               </admediumItem>
            </admediaResult>
         </return>
      </GetAdmediumResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for GetAdmedium


GetAdmediumCategories

Example Request

 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAdmediumCategories>
         <ns:programId>418</ns:programId>
         <ns:applicationId>9483E574075AA858AA2E</ns:applicationId>
      </ns:GetAdmediumCategories>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetAdmediumCategoriesResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <admediaResult>
               <categories>
                  <category id="168">009_Logos</category>
                  <category id="12979">003_TextAd</category>
                  <category id="13001">005_Pagepeel</category>
                  <category id="13914">Highlights</category>
                  <category id="13915">Specials</category>
                  <category id="14694">011_ Interactive_Microsites</category>
                  <category id="14030">010_VideoAds</category>
                  <category id="15113">012_Context Ad Generator</category>
               </categories>
            </admediaResult>
         </return>
      </GetAdmediumCategoriesResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for GetAdmediumCategories



Retrieved from "http://wiki.zanox.com/en/Admedia_Methods"
Personal tools