Bulk API
From wiki.taptica.com
(Difference between revisions)
(→Response) |
(→Request) |
||
| Line 15: | Line 15: | ||
Example: Post to http://webapi.reports.taptica.com/v2/bulk? | Example: Post to http://webapi.reports.taptica.com/v2/bulk? | ||
| − | token=hSuz7l0OUjwVy4uGX2bfAw%3d%3d&platforms=iPhone&countries=IL,US&payoutType=&minPayout=0&categories=&format= | + | token=hSuz7l0OUjwVy4uGX2bfAw%3d%3d&platforms=iPhone&countries=IL,US&payoutType=&minPayout=0.5&categories=Game&format=XML |
'''Request parameters''' | '''Request parameters''' | ||
Revision as of 12:30, 19 August 2013
Taptica Bulk API allows you to get all the offers Meta data from your account. The offers you will get in the results will be attached from the offers that your account manager add to your offers list.
Contents |
Important!
Since there are frequent changes in the production offer lists The publisher responsible to generate the request every hours. In case offer that was returned in previews response is no longer in the response it's mean you have to Remove the offer from production.
Request
• The request is sent via an HTTP POST to the following URL: http://webapi.reports.taptica.com/v2/bulk?
• The body of the POST contains URL encoded key/value pairs separated by "&".
Example: Post to http://webapi.reports.taptica.com/v2/bulk? token=hSuz7l0OUjwVy4uGX2bfAw%3d%3d&platforms=iPhone&countries=IL,US&payoutType=&minPayout=0.5&categories=Game&format=XML
Request parameters
| Parameter | Name In Request | Description | Example | RMandatory |
| Token | token | Your Taptica private token | Token=hSuz7l0OUjwVy4uGX2bfAw%3d%3d&platforms | 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 request offers.can be multiple selection.Note some time you won't get response since Taptica don’t have offer for the specified country. | countries=US,UK | Yes |
| PayoutType | payoutType | specified the requested offer payout. Can be either CPA, CPC, CPM, Mostly Taptica support CPI offers | payoutType=cpi | Yes |
| MinPayout | minPayout | specified the minimume Payout offer you would like to get in the response | minPayout=1.2 | No |
| Categories | categories | specified the offers Categories you would like to get in the response | minPayout=Games,Travel and Local, | No |
| Format | format | specified the response type can be either JSON,XML,CSV | XML, CSV, Json | Yes |
Response
Request parameters
| Parameter | Description | Example |
| ID | Taptica internal offer ID | Underworld Empire- US- iPhone |
| 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 |
| AdvAppId | Google / Appstore application id. | 555150599 |
| PreviewLink | Link to the application in 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_appid=555150599&aff_id=2004 |
| IsDeviceIdMandatory | when set to ture its means that the application must get at least one of the device parameters that specified in the "DeviceIds" | false / true |
| DeviceIds | Indicate the offer supporeted device id, in case the IsDeviceIdMandatory is true Taptica mast 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 | Indicate the offer supported countries (returen as list) | US |
| PayoutType | Indicate the offer Payout Type, can be either CPA, CPC, CPM | CPA |
| Payout | Indicate the offer Payout | 1.2 |
| DailyBudget | returen the publisher budget in Dolars for the specific offer or unlimited when there is no limit | Unlimited / 1500 |
| Category | Show the offers categories as sets in Taptica system (returen as list) | Entertainment / Games |
| Creative | provied the creative data as Banner ID, banner name, creative link, Creative type, creative size. (returen 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 |
| BannerText | offer promotion text | Get Free Application Now! |
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 |
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 not fall under the above errors |
