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

Programs Methods

From Wiki.zanox.com

Jump to: navigation, search

The programs SOAP methods enable the retrieval of advertiser programs and the automatic management of advertiser program applications. Prerequisite for a program application is the existence of an advertising space.


Contents

GetProgram

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:GetProgram>
         <ns:programId>418</ns:programId>
         <ns:applicationId>12345678890987654321</ns:applicationId>
      </ns:GetProgram>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetProgramResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <programsResult>
               <programItem id="418" lang="en">
                  <name>OTTO</name>
                  <adrank>7.5</adrank>
                  <description>a lot of descriptive text</description>
                  <products>83929</products>
                  <regions>
                     <region>DE</region>
                  </regions>
                  <categories>
                     <category id="34">Shopping &amp; Mail Order Shops</category>
                     <category id="17">Family, Sports &amp; Games</category>
                     <category id="33">Clothing &amp; Accessories</category>
                     <category id="20">House &amp; Garden</category>
                     <category id="39">Household Appliances</category>
                  </categories>
                  <url>www.otto.de</url>
                  <image>programs/418/logo120.gif</image>
                  <currency>EUR</currency>
                  <conditions>
                     <leads>
                        <minfixed>0.5</minfixed>
                        <maxfixed>5.0</maxfixed>
                     </leads>
                     <sales>
                        <minpercent>6.0</minpercent>
                        <maxpercent>15.0</maxpercent>
                     </sales>
                  </conditions>
               </programItem>
            </programsResult>
         </return>
      </GetProgramResponse>
   </env:Body>
</env:Envelope>
 

GetPrograms

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:GetPrograms>
         <ns:adspaceId>676767</ns:adspaceId>
         <ns:categoryId>333</ns:categoryId>
         <ns:page>1</ns:page>
         <ns:items>3</ns:items>
         <ns:applicationId>1234567890987654321</ns:applicationId>
      </ns:GetPrograms>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetProgramsResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <page>1</page>
            <items>3</items>
            <total>0</total>
            <programsResult>...</programsResult>
         </return>
      </GetProgramsResponse>
   </env:Body>
</env:Envelope>
 

SearchPrograms

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:SearchPrograms>
         <ns:query>fashion</ns:query>
         <ns:categoryId>1</ns:categoryId>
         <ns:page>1</ns:page>
         <ns:items>10</ns:items>
         <ns:applicationId>12345678890987654321</ns:applicationId>
      </ns:SearchPrograms>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <SearchProgramsResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <page>1</page>
            <items>10</items>
            <total>44</total>
            <query>fashion</query>
            <programsResult>
               <programItem id="2500" lang="en">
                  <name>more-and-more</name>
                  <adrank>0.5</adrank>
                  <description>THE NEW FASHION SEASON HAS BEGUN!  </description>
                  <products>1022</products>
                  <regions>
                     <region>DE</region>
                  </regions>
                  <categories>
                     <category id="33">Clothing &amp; Accessories</category>
                  </categories>
                  <url>shop.more-and-more.com</url>
                  <image>programs/2500/2500_lgo_moreandmore_de.jpg</image>
                  <currency>EUR</currency>
                  <conditions>
                     <sales>
                        <minpercent>6.0</minpercent>
                        <maxpercent>6.0</maxpercent>
                     </sales>
                  </conditions>
               </programItem>
            </programsResult>
         </return>
      </SearchProgramsResponse>
   </env:Body>
</env:Envelope>
 

GetProgramCategories

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:GetProgramCategories>
         <ns:applicationId>1234567890987654321</ns:applicationId>
      </ns:GetProgramCategories>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetProgramCategoriesResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <programsResult>
               <categories>
                  <category id="10">Cars &amp; Motorbikes</category>
                  <category id="11">Internet services</category>
                  <category id="15">Office &amp; School</category>
                  <category id="17">Family, Sports &amp; Games</category>
                  <category id="18">Computer &amp; Game Consoles</category>
                  <category id="19">News &amp; Information</category>
                  <category id="20">House &amp; Garden</category>
                  <category id="21">Art &amp; Culture</category>
                  <category id="23">Travel &amp; Flight</category>
                  <category id="26">Cities, Counrties &amp; Regions</category>
                  <category id="27">Books, Music &amp; Movies</category>
                  <category id="28">Versicherungen &amp; Finanzen</category>
                  <category id="30">Health &amp; Care</category>
                  <category id="31">Food &amp; Beverages</category>
                  <category id="32">Gifts &amp; Flowers</category>
                  <category id="33">Clothing &amp; Accessories</category>
                  <category id="34">Shopping &amp; Mail Order Shops</category>
                  <category id="35">Cameras &amp; Camcorders</category>
                  <category id="36">Personal Homepage</category>
                  <category id="37">HiFi, TV &amp; Video</category>
                  <category id="38">Tickets</category>
                  <category id="39">Household Appliances</category>
                  <category id="40">Cell, Phone &amp; Fax</category>
                  <category id="43">Other</category>
               </categories>
            </programsResult>
         </return>
      </GetProgramCategoriesResponse>
   </env:Body>
</env:Envelope>
 

GetProgramPromotions

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:GetProgramPromotions>
         <ns:applicationId>1234567890987654321</ns:applicationId>
      </ns:GetProgramPromotions>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetProgramPromotionsResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <programsResult>
               <programItem id="580" lang="en">
                  <title>BR 5 euros sans minimum</title>
                  <name>PriceMinister FR</name>
                  <adrank>4.0</adrank>
                  <description>BR 5 euros sans minimum d'achat, hors auto et hors frais de port.</description>
                  <products>0</products>
                  <startdate>2008-08-04T00:00:00+02:00</startdate>
                  <enddate>2008-09-03T00:00:00+02:00</enddate>
                  <url>ui.zanox-affiliate.de/?1001100110030&amp;amp;0C0&amp;amp;122329_113_201</url>
               </programItem>
            </programsResult>
         </return>
      </GetProgramPromotionsResponse>
   </env:Body>
</env:Envelope>
 

CreateProgramApplication

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:CreateProgramApplication>
         <ns:programId>49</ns:programId>
         <ns:adspaceId>784334</ns:adspaceId>
		 <ns:applicationId>9483E574075AA858AA2E</ns:applicationId>
		 <ns:timestamp>2008-08-25T14:15:46.000Z</ns:timestamp>
		 <ns:signature>lOIdLIy45YCRFaKl+IOcuG4ZEVQ=</ns:signature>
      </ns:CreateProgramApplication>
   </soapenv:Body>
</soapenv:Envelope>
 
 

Example Response 

 
 
 

DeleteProgramApplication

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:DeleteProgramApplication>
         <ns:programId>49</ns:programId>
         <ns:adspaceId>1040671</ns:adspaceId>
		 <ns:applicationId>9483E574075AA858AA2E</ns:applicationId>
		 <ns:timestamp>2008-08-25T14:17:52.000Z</ns:timestamp>
		 <ns:signature>8RugavWkAhimkYzy+ESq1lnOLXM=</ns:signature>
      </ns:DeleteProgramApplication>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response 

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