Bulk API

Revision as of 08:29, 15 January 2015

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.

Important!

Since there are frequent changes in the production offers list 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 "Get request" to the following URL: https://api.taptica.com/v2/bulk?

• The body of the POST contains URL encoded key/value pairs separated by "&".

Example: Get to https://api.taptica.com/v2/bulk?token=4rxhjspwWQDZscvPgC6jqw%3d%3d&platforms=iPhone&countries=IL,US&payoutType=&minPayout=&categories=games&format=XML&version=1

Request parameters

Response

Request parameters

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

• The tracking link should be a combination of the response you get in the "TrackingLink" + Bannerid + "DeviceIds" for example:

Make sure you send the banner_id in the click url

http://tracking.taptica.com/aff_c?tt_ls=b&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

• Taptica supports 4 parameters for publisher use.

In order to use them the publisher need to add them to the TrackingLink as in the above example.

Taptica Device Keys

Category List

The optional categories names are:

Error messages

Sample MXL Response

<BulkApi>

 <error>OK</error>
 <errorCode>0</errorCode>
<Offer>
 <OfferId>14943</OfferId>
 <OfferName>Test Offer Black - iPhone</OfferName>
 <OfferDescription>Test Offer Black - iPhone</OfferDescription>
 <SupportedPlatform>IPhone</SupportedPlatform>
 <SupportedPlatform>IPod</SupportedPlatform>
 <MinimumOSVersion>4</MinimumOSVersion>
 <MarketAppId>Test Offer Black</MarketAppId>
 <PreviewLink>
  https://itunes.apple.com/us/app/candy-crush-saga/id553834731?mt=8
 </PreviewLink>
 <TrackingLink>
  http://tracking.taptica.com/aff_c?tt_ls=b&offer_id=14943&aff_id=3125018&tt_appid=Test_Offer_Black&tt_bannerid=
 </TrackingLink>
 <DeviceIdMandatory>false</DeviceIdMandatory>
  <BlockedSubAffiliate>Unavailable</BlockedSubAffiliate>
  <SupportedCountry>US</SupportedCountry>
  <SupportedCountry>GB</SupportedCountry>
  <SupportedCountry>AE</SupportedCountry>
  <SupportedCountry>IL</SupportedCountry>
 <Network>WIFI</Network>
  <Network>3G</Network>
 <PayoutType>CPA</PayoutType>
 <Payout>0.00000</Payout>
 <DailyBudget>Unlimited</DailyBudget>
 <Category>games</Category>
 <Category>multimedia</Category>
 <Category>automotive</Category>
 <Category>books and reference</Category>
 <Category>lifestyle</Category>
 <Category>kids</Category>
 <Category>gambling</Category>
 <Category>education</Category>
 <Category>news and weather</Category>
 <Category>communications</Category>
 <Category>entertainment</Category>
 <Category>financial services</Category>
 <Category>health and fitness</Category>
 <Category>shopping and retail</Category>
 <Category>social</Category>
 <Category>sports</Category>
 <Category>travel and local</Category>
 <Creative>
  <Id>177192</Id>
  <Name>300X250_black_animated.gif</Name>
  <CreativeLink>
   http://76b3ceeab4c855fb9953-3bebc903fd41a20c171fdfefdfe53008.r84.cf2.rackcdn.com/14943/20140616/d1a2268bb8504e8481acaf6678affbe2_300X250_black_animated.gif
  </CreativeLink>
  <CreativeType>FullScreen</CreativeType>
  <CreativeSize>300x250</CreativeSize>
 </Creative>
 <Creative>
  <Id>106245</Id>
  <Name>Dragon1.mp4</Name>
  <CreativeLink>
   http://76b3ceeab4c855fb9953-3bebc903fd41a20c171fdfefdfe53008.r84.cf2.rackcdn.com/14943_da8e34ec13d14419b5dca863fad45657_Dragon1.mp4
  </CreativeLink>
  <CreativeType>Video</CreativeType>
  <CreativeSize>320x480</CreativeSize>
 </Creative>
</Offer>

</BulkApi>