Difference between revisions of "FindAll"

From Ad4Game Developers
Jump to: navigation, search
(Created page with "Description Returns details for all offers or a result set with optional filters. Results can display a set of fields for all matching offers: - Id : the offer id - Name : ...")
 
 
(11 intermediate revisions by one user not shown)
Line 1: Line 1:
Description
+
==Description==
  
 
Returns details for all offers or a result set with optional filters.
 
Returns details for all offers or a result set with optional filters.
 
Results can display a set of fields for all matching offers:  
 
Results can display a set of fields for all matching offers:  
 +
<ul>
 +
<li>- Id : the offer id
 +
<li>- Name : the offer name
 +
<li>- Platform : supported
 +
<li>- DailyCap : max lead per day.
 +
<li>- PreviewUrl : offer landing page.
 +
<li>- TrackingUrl : Ad4Game tracking url
 +
<li>- Description : Description of the offer
 +
<li>- RestrictedTraffic : list of restricted traffic sources
 +
<li>- Country : Targeted country
 +
<li>- OptIn : offer opt-in can be either DOI or SOI
 +
<li>- Rate : Net Rate paid to affiliate in $ USD
 +
<li>- EndDate : The expire time of the offer
 +
</ul>
  
- Id : the offer id
+
==URL==
- Name : the offer name
+
- Platform
+
- DailyCap
+
- PreviewUrl
+
- TrackingUrl
+
- Description
+
- AllowedTraffic
+
- Country
+
- OptIn
+
- Rate : Net Rate paid to affiliate in $ USD
+
- EndDate
+
 
+
URL
+
 
https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&zoneId=[YOUR ZONE ID]&affiliateId=[YOUR AFFILIATE ID]&method=findAll&format=[xml OR json]
 
https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&zoneId=[YOUR ZONE ID]&affiliateId=[YOUR AFFILIATE ID]&method=findAll&format=[xml OR json]
  
HTTP Method(s)
+
==HTTP Method(s)==
 
GET, POST
 
GET, POST
  
Filters :
+
==Filters :==
 
+
<ul>
countries : list of countries (ISO code) sperated by a comma (CA,US,FR,JP).
+
<li>countries : list of countries (ISO code) sperated by a comma (CA,US,FR,JP).</li>
 
+
<li>optIn :  can be either DOI or SOI.</li>
optIn :  can be either DOI or SOI.
+
<li>platform : can be either Display, Android, IOS or Android & IOS.</li>
 
+
<li>restrictedTraffic restricted traffic sources can be either S, SEM, B, D, E, P or T</li>
platform : can be either Display, Android, IOS or Android & IOS.
+
S: Social traffic (facebook, etc)
 
+
SEM: Search Engine Marketing e.g. Google AdWords
allowedTraffic allowed traffic sources can be either S, SEM, B, D, E, P or T
+
B: Brand Bidding
S: Social traffic (facebook, etc)
+
D: Display / Banners
SEM: Search Engine Marketing e.g. Google AdWords
+
E: Email Marketing
B: Brand Bidding
+
P: Pop Unders
D: Display / Banners
+
T: Text Links / Editorial content
E: Email Marketing
+
</ul>
P: Pop Unders
+
T: Text Links / Editorial content  
+
 
+
 
+
  
Reponses types
+
==Reponses types==
xml, json
+
===JSON===
 +
<dd>
 +
  {"error":"Success",
 +
    "Offers":
 +
    {"3":{
 +
      "OfferId":"3",
 +
      "OfferName":"The West",
 +
      "Platform":"Display",
 +
      "DailyCap":"None",
 +
      "PreviewUrl":"http:\/\/www.the-west.net",
 +
      "TrackingUrl":"http:\/\/ads.ad4game.com\/www\/delivery\/dck.php?offerid=3&zoneid=7711",
 +
      "Description":"Discover new land and experience exciting adventures and duels! The West is waiting for you!",
 +
      "RestrictedTraffic":" Display \/ Banners, Email Marketing, Pop Unders, Text Links \/ Editorial content","Restrictions":"",
 +
      "countries":[
 +
        {"CountryName":"AT","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"1.92"},
 +
        {"CountryName":"AU","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"0.40"}
 +
        ]
 +
      }
 +
    }
 +
  }
 +
===XML===
 +
<dd>
 +
  <Offers>
 +
    <Offer Id="656">
 +
      <Name>The Hobbit Android</Name>
 +
      <Platform>Android Smartphone & Tablet</Platform>
 +
      <DailyCap>63</DailyCap>
 +
      <PreviewUrl>https://play.google.com/store/apps/details?id=com.kabam.fortress</PreviewUrl>
 +
      <TrackingUrl>http://ads.ad4game.com/www/delivery/dck.php?offerid=656&zoneid=7711</TrackingUrl>
 +
      <Description>The battle for Middle-earth has just begun! PLAY FOR FREE and join thousands worldwide to drive ..</Description>
 +
      <RestrictedTraffic> Social traffic (facebook, etc), Social traffic (facebook, etc) Email MarketingM, Brand Bidding</RestrictedTraffic>
 +
      <Countries>
 +
        <Country name="US">
 +
          <OptIn>SOI</OptIn><Rate>$3.75</Rate>
 +
          <EndDate>2013-09-15 16:47:12</EndDate>
 +
        </Country>
 +
      </Countries>
 +
    </Offer>
 +
  </Offers>

Latest revision as of 06:41, 21 November 2014

Contents

[edit] Description

Returns details for all offers or a result set with optional filters. Results can display a set of fields for all matching offers:

  • - Id : the offer id
  • - Name : the offer name
  • - Platform : supported
  • - DailyCap : max lead per day.
  • - PreviewUrl : offer landing page.
  • - TrackingUrl : Ad4Game tracking url
  • - Description : Description of the offer
  • - RestrictedTraffic : list of restricted traffic sources
  • - Country : Targeted country
  • - OptIn : offer opt-in can be either DOI or SOI
  • - Rate : Net Rate paid to affiliate in $ USD
  • - EndDate : The expire time of the offer

[edit] URL

https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&zoneId=[YOUR ZONE ID]&affiliateId=[YOUR AFFILIATE ID]&method=findAll&format=[xml OR json]

[edit] HTTP Method(s)

GET, POST

[edit] Filters :

  • countries : list of countries (ISO code) sperated by a comma (CA,US,FR,JP).
  • optIn : can be either DOI or SOI.
  • platform : can be either Display, Android, IOS or Android & IOS.
  • restrictedTraffic : restricted traffic sources can be either S, SEM, B, D, E, P or T
  • S: Social traffic (facebook, etc) SEM: Search Engine Marketing e.g. Google AdWords B: Brand Bidding D: Display / Banners E: Email Marketing P: Pop Unders T: Text Links / Editorial content

[edit] Reponses types

[edit] JSON

 {"error":"Success",
   "Offers":
   {"3":{
     "OfferId":"3",
     "OfferName":"The West",
     "Platform":"Display",
     "DailyCap":"None",
     "PreviewUrl":"http:\/\/www.the-west.net",
     "TrackingUrl":"http:\/\/ads.ad4game.com\/www\/delivery\/dck.php?offerid=3&zoneid=7711",
     "Description":"Discover new land and experience exciting adventures and duels! The West is waiting for you!",
     "RestrictedTraffic":" Display \/ Banners, Email Marketing, Pop Unders, Text Links \/ Editorial content","Restrictions":"",
     "countries":[
       {"CountryName":"AT","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"1.92"},
       {"CountryName":"AU","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"0.40"}
       ]
     }
   }
 }

[edit] XML

 <Offers>
   <Offer Id="656">
     <Name>The Hobbit Android</Name>
     <Platform>Android Smartphone & Tablet</Platform>
     <DailyCap>63</DailyCap>
     <PreviewUrl>https://play.google.com/store/apps/details?id=com.kabam.fortress</PreviewUrl>
     <TrackingUrl>http://ads.ad4game.com/www/delivery/dck.php?offerid=656&zoneid=7711</TrackingUrl>
     <Description>The battle for Middle-earth has just begun! PLAY FOR FREE and join thousands worldwide to drive ..</Description>
     <RestrictedTraffic> Social traffic (facebook, etc), Social traffic (facebook, etc) Email MarketingM, Brand Bidding</RestrictedTraffic>
     <Countries>
       <Country name="US">
         <OptIn>SOI</OptIn><Rate>$3.75</Rate>
         <EndDate>2013-09-15 16:47:12</EndDate>
       </Country>
     </Countries>
   </Offer>
 </Offers>
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox