Bulk API
(→Response) |
(→Response) |
||
Line 216: | Line 216: | ||
* '''[[The tracking link should be a combination of the response you get in the "TrackingLink" + Bannerid + "DeviceIds" for example:]]''' | * '''[[The tracking link should be a combination of the response you get in the "TrackingLink" + Bannerid + "DeviceIds" for example:]]''' | ||
− | http://tracking.taptica.com/aff_c?offer_id=4390&tt_appid=555150599&aff_id=2004& | + | http://tracking.taptica.com/aff_c?offer_id=4390&tt_appid=555150599&aff_id=2004&tt_sub_aff=YYYY&tt_bannerid=49552&tt_mac=&tt_mac_sha1=&tt_mac_md5=&tt_idfa=&tt_idfa_sha1=&tt_idfa_md5=&tt_aff_impid=1321sads35sa&tt_aff_clickid=qa143287w |
* '''[[Device Parameters: Keep in mind, the more parameters you provide us with, your conversion rate will be higher. In case "IsDeviceIdMandatory" is set to true, you must provide at least one parameter from the DeviceIds list]]''' | * '''[[Device Parameters: Keep in mind, the more parameters you provide us with, your conversion rate will be higher. In case "IsDeviceIdMandatory" is set to true, you must provide at least one parameter from the DeviceIds list]]''' |
Revision as of 06:25, 13 January 2014
Taptica Bulk API allows you to get offers Meta data from your account. The offers you receive in the results will come from the offers that were connected to your account by your account manager.
Contents |
Important!
Since there are frequent changes in the production offer lists The publisher is responsible to generate the request every hours. In case an offer was returned in a previous response and is no longer in the response, it means you have to Remove the offer from production.
Request
• The request is sent via an HTTP Getto the following URL: https://api.taptica.com/v2/bulk?
• The body of the POST contains URL encoded key/value pairs separated by "&".
Request parameters
Parameter | Name In Request | Description | Example | RMandatory |
Token | token | Your Taptica private token | Token=hSuz7l0OUjwVy4uGX2bfAw%3d%3d | Yes |
Platforms | platforms | Indicate the Platform of the requested offers. Can be either iPhone, iPad, iPod, Android. | platforms=iPhone | Yes |
Countries | countries | Enter the country codes of the requested offers. Can be multiple selection.Note sometimes you won't get a response if Taptica dosen't have an offer for the specified country. | countries=US,UK | No |
PayoutType | payout Type | Specifies the requested offer payout. Can be either CPA, CPC, CPM. Mostly, Taptica supports CPA offers. | payoutType=cpi | Yes |
MinPayout | min Payout | Specifies the minimum payout offer you would like to get in the response. | minPayout=1.2 | No |
Categories | categories | Specifies the offer categories you would like to get in the response. | minPayout=Games,Travel and Local, | No |
Version | Version | Add additional data to the response as offer ID | version=1 | No |
Format | format | Specifies the response type. Can be either JSON,XML,CSV. | XML, CSV, Json | Yes |
Response
Request parameters
Parameter | Description | Example |
ID | Taptica internal offer ID. | 4960 |
Offer Name | Taptica internal offer name. | Underworld Empire- US- iPhone |
Description | Offer description. | Play with MILLIONs of players NOW in the LARGEST, most INTENSE, SOCIAL CRIME MMO! |
Platform | Supported platform. | iPhone |
CampaignId | Taptica internal campaign ID. | 3 |
MinOsVersion | Minimum OS version. | 4.3 |
MarketAppId | Google / Appstore application id. | 555150599 |
PreviewLink | Link to the application on Google / Appstore. | https://itunes.apple.com/us/app/underworld-empire/id555150599 |
TrackingLink | Taptica basic tracking link *(please see explanation below) | http://tracking.taptica.com/aff_c?offer_id=4390&tt_sub_aff=&tt_appid=555150599&aff_id=2004&tt_bannerid= |
IsDeviceIdMandatory | when set to true, it means that the application must get at least one of the device parameters specified in the "DeviceIds". | false / true |
DeviceIds | Indicates the offer supporeted device id, in case the IsDeviceIdMandatory is true, Taptica must get at least one of the devie parameters. (returen as list). | tt_mac,tt_mac_sha1,tt_mac_md5,tt_idfa,tt_idfa_sha1,tt_idfa_md5 |
SupportedCountries | Indicates the offer's supported countries (returned as list). | US |
PayoutType | Indicates the offer Payout Type, can be either CPA, CPC, CPM. | CPA |
Payout | Indicates the offer Payout. | 1.2 |
DailyBudget | Returns the publisher budget in US Dollars for the specific offer or unlimited when there is no limit. | Unlimited / 1500 |
Category | Shows the offer categories as sets in Taptica system (returned as list). | Entertainment / Games |
Creative | provides the creative data as Banner ID, Banner Name, Creative Link, Creative Type, Creative Size. (returned as list) |
Id 49552 Name 20130327115527-DJ_Tira_static_Banner_320X320.gif CreativeLink http://media.go2speed.org/brand/files/taptica/3530/20130327115527-DJ_Tira_static_Banner_320X320.gif CreativeType banner CreativeSize 320x320 |
BlockedSubAffiliate | Unauthorized sub affiliate, Specifies the sub affiliate of the affiliate which are unauthorized to run the offer. | Unavailable / 1265 ... |
BannerText | Offer promotion text. | Get Free Application Now! |
AppIconURL | link to the application Icon on app store or Google play | https://lh6.ggpht.com/LmBa6jgU5zTnvb4G52ZYeCr2CAq8BEB9atNBTGkyZXIsEZTjxDA_F7YV6l1t9gpBEw=w300-rw |
AppProviderName | The Application Provider Name | Playtika LTD |
AppName | The application official name as it on app store or Google play | Candy Crush Sega |
- Taptica supports 4 parameters for publisher use.
Parameter | Description | Example |
Pipeline Data | Used for any information that the publisher may want to send us upon click and get back via S2S postback | pd=abcd1234 |
Sub affiliaet | Used for sending us your sub affiliate id upon click. The publisher can get it back via S2S postback | tt_sub_aff=13461d46 |
Affiliate impression ID | Used for impression id that the publisher may want to send and get back via S2S postback (alfa numeric) | tt_aff_impid=1321sads35sa |
Affiliate click ID | Used for click id that the publisher may want to send and get back via S2S postback (alfa numeric) | tt_aff_clickid=qa143287w |
In order to use them the publisher need to add them to the TrackingLink as in the above example.
Taptica Device Keys
Parameter | Name In Request | Description | Example | Daynamic? |
IMEI | tt_imei | Use for send Taptica Plain IMEI or when you don’t know what is the format of IMEI you have. | tt_imei=86453214567892 | Yes |
IMEI SHA1 | tt_imei_sha1 | Use for send Taptica IMEI in SHA1 format | tt_imei_sha1=35eb6d1fc48b502e239b6449e9df534e415cad95 | Yes |
IMEI MD5 | tt_imei_md5 | Use for send Taptica IMEI in MD5 format | tt_imei_md5=946cc1baf8bcaec827bb1828cc6d9a94 | Yes |
Android ID | tt_android_id | Use for send Taptica Plain Android ID or when you don’t know what is the format of Android ID you have. | tt_android_id=3ee0149b4ccef71b | Yes |
Android ID SHA1 | tt_android_id_sha1 | Use for send Taptica Android ID in SHA1 format | tt_android_id_sha1=4f2e52e8157fcb729d799d1ca69160df2edf0cd4 | Yes |
Android ID MD5 | tt_android_id_md5 | Use for send Taptica Android ID in MD5 format | tt_android_id_md5=155551c45efa667f9b470629ae9c0365 | Yes |
Mac Address | tt_mac | Use for send Taptica Plain Mac Address or when you don’t know what is the format of the Mac Address you have. (upper case with colon) | tt_mac=44:2A:60:G5:GE:G5 | Yes |
Mac Address SHA1 | tt_imei_sha1 | Use for send Taptica Mac Address in SHA1 format (upper case with colon) | tt_mac_sha1=fa6bb084ae52461328eb9f06039be222ef287246 | Yes |
Mac Address MD5 | tt_mac_md5 | Use for send Taptica Mac Address in MD5 format (upper case with colon) | tt_mac_md5=80efe2256d548c85ca2f2d18de241a80 | Yes |
IDFA | tt_idfa | Use for send Taptica Plain IDFA or when you don’t know what is the format of IDFA you have. | tt_idfa=771468523E3346ABAA04E207BBAF094B | Yes |
IDFA SHA1 | tt_idfa_sha1 | Use for send Taptica IDFA in SHA1 format | tt_idfa_sha1=ee5c19f8cf370b5978f4b9f33343a5e79c58df9a | Yes |
IDFA MD5 | tt_idfa_md5 | Use for send Taptica IDFA in MD5 format | tt_idfa_md5=bb1e0285fbb97ba83fdb4e72514d62f5 | Yes |
UDID | tt_udid | Use for send Taptica Plain UDID or when you don’t know what is the format of UDID you have. | tt_udid=dc1816eac806878e8d1d5a8ee9406a3f71452c80 | Yes |
UDID SHA1 | tt_udid_sha1 | Use for send Taptica UDID in SHA1 format | tt_udid_sha1=1ddfad5e4377b8694b5fea2a4c4556e2add9605b | Yes |
UDID MD5 | tt_udid_md5 | Use for send Taptica IMEI in MD5 format | tt_udid_md5=20fbe500c99939adabb4d06600eb4ee7 | No |
Category List
The optional categories names are:
Games |
Communications |
Entertainment |
Financial Services |
Health and Fitness |
Shopping and Retail |
Social |
Sports |
Travel and Local |
Multimedia |
Automotive |
Books and Reference |
Lifestyle |
Kids |
Gambling |
Education |
News and weather |
Error messages
Error Code | Error Text | Error description |
0 | OK | Success |
100 | Not Modified. | There was no data to return |
200 | Bad Request. | Bad Request for parameter + the bad parameter for example platform with value iPhtone |
300 | Unauthorized. | Authorization error. Authentication credential are missing or incorrect. |
301 | Invalid Token. | The token that was delivered is invalid |
400 | General Error. | Any other error that does not fall under the above errors |
Sample MXL Response
<BulkApi> <error>OK</error> <errorCode>0</errorCode> <Offer> <OfferName>Slotomania- iPad US</OfferName> <OfferDescription> Play Slotomania, the #1 slot machine game on iPhone, iPad, and Facebook! Enjoyed by millions worldwide; Slotomania is the favorite social slots game online providing unlimited FREE entertainment, top-tier graphics, and high-quality sound effects. Players love Slotomania’s: *Huge variety of themed slot machines *Unique new games added all the timefrom bonus rounds, free spins, gifts, and mini games *Free gifts you can send and receive from friends *Many ways to quickly unlock games *Instant accessib </OfferDescription> <SupportedPlatform>ipad</SupportedPlatform> <MinimumOSVersion>4.9</MinimumOSVersion> <SupportedPlatform/> <MinimumOSVersion>Unavailable</MinimumOSVersion> <MarketAppId>483165745</MarketAppId> <PreviewLink>https://itunes.apple.com/app/id483165745?mt=8</PreviewLink> <TrackingLink>http://tracking.taptica.com/aff_c?offer_id=3914&aff_id=2004&tt_appid=483165745&tt_bannerid= </TrackingLink> <DeviceIdMandatory>false</DeviceIdMandatory> <UniqueDeviceId>tt_idfa</UniqueDeviceId> <UniqueDeviceId>tt_idfa_sha1</UniqueDeviceId> <UniqueDeviceId>tt_idfa_md5</UniqueDeviceId> <UniqueDeviceId>tt_mac</UniqueDeviceId> <UniqueDeviceId>tt_mac_sha1</UniqueDeviceId> <UniqueDeviceId>tt_mac_md5</UniqueDeviceId> <UniqueDeviceId>tt_udid</UniqueDeviceId> <UniqueDeviceId>tt_udid_sha1</UniqueDeviceId> <UniqueDeviceId>tt_udid_md5</UniqueDeviceId> <SupportedCountry>US</SupportedCountry> <SupportedCountry>UK</SupportedCountry> <Network>Unavailable</Network> <DailyBudget>Unlimited</DailyBudget> <PayoutType>CPA</PayoutType> <Payout>1.2</Payout> <DailyBudget>500.000</DailyBudget> <Category>Entertainment</Category> <Category>Gambling</Category> <CreativeData> <Id>49544</Id> <Name>DJ_Tira_animated_Banner_168X28.gif</Name> <CreativeLink>http://media.go2speed.org/brand/files/taptica/3530/DJ_Tira_animated_Banner_168X28.gif </CreativeLink> <CreativeType>banner</CreativeType> <CreativeSize>168x28</CreativeSize> </CreativeData> <CreativeData> <Id>49546</Id> <Name>DJ_Tira_animated_Banner_216X36.gif</Name> <CreativeLink>http://media.go2speed.org/brand/files/taptica/3530/DJ_Tira_animated_Banner_216X36.gif </CreativeLink> <CreativeType>banner</CreativeType> <CreativeSize>216x36</CreativeSize> </CreativeData> <BlockedSubAffiliate>Unavailable</BlockedSubAffiliate> <BannerText>Unavailable</BannerText> <AppIconURL> http://a2.mzstatic.com/us/r30/Purple4/v4/7b/62/bd/7b62bd85-dc63-ab21-dff5-341c7a1c4e82/mzl.ikgtlknp.175x175-75.jpg </AppIconURL> <AppProviderName>Playtika LTD</AppProviderName> <AppName>Slotomania HD - FREE Slots</AppName> </Offer> </BulkApi>