Difference between revisions of "FindAll"
From Ad4Game Developers
(→Filters :) |
(→Description) |
||
Line 6: | Line 6: | ||
<li>- Id : the offer id | <li>- Id : the offer id | ||
<li>- Name : the offer name | <li>- Name : the offer name | ||
− | <li>- Platform | + | <li>- Platform : supported |
− | <li>- DailyCap | + | <li>- DailyCap : max lead per day. |
− | <li>- PreviewUrl | + | <li>- PreviewUrl : offer landing page. |
− | <li>- TrackingUrl | + | <li>- TrackingUrl : Ad4Game tracking url |
− | <li>- Description | + | <li>- Description : Description of the offer |
− | <li>- | + | <li>- RestricteddTraffic : |
− | <li>- Country | + | <li>- Country : targeted country |
− | <li>- OptIn | + | <li>- OptIn : offer opt-in can be either DOI or SOI |
<li>- Rate : Net Rate paid to affiliate in $ USD | <li>- Rate : Net Rate paid to affiliate in $ USD | ||
− | <li>- EndDate | + | <li>- EndDate : expire time of the offer |
</ul> | </ul> | ||
Revision as of 12:35, 15 August 2013
Contents |
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
- - RestricteddTraffic :
- - Country : targeted country
- - OptIn : offer opt-in can be either DOI or SOI
- - Rate : Net Rate paid to affiliate in $ USD
- - EndDate : expire time of the offer
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]
HTTP Method(s)
GET, POST
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
Reponses types
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"} ] } } }
XML
{"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"} ] } } }