You are looking at the HTML representation of the XML format.
HTML is good for debugging, but probably is not suitable for your application.
See complete documentation, or
API help for more information.
<?xml version="1.0"?>
<api>
<query-continue>
<allpages gapfrom="Retrieve Report By Appplication" />
</query-continue>
<query>
<pages>
<page pageid="7" ns="0" title="Retrieve Ads">
<revisions>
<rev xml:space="preserve">== Communications ==
The communication will be done using the HTTP protocol.
== End Point ==
Service end point:
'''POST:'''
http://ad.taptica.com/aff_ad
== Request ==
• The request is sent via an HTTP POST to the following URL: http://ad.taptica.com/aff_ad
• The content type of the request is application/x-www-form-urlencoded.
• The body of the POST contains URL encoded key/value pairs separated by "&".
Example:
Post to:
http://ad.taptica.com/aff_ad
Body:
w&t=2&aff_id=1740&tt_sub_aff=15472&r=320x50&i=50.57.113.223&u=Mozilla/5.0 (iPhone; U; CPU iPhone OS 4_0 like Mac OS X; en-us) AppleWebKit/532.9 (KHTML, like Gecko) Version/4.0.5 Mobile/8A293 Safari/6531.22.7&tt_aff_impid=wyts98247asda&tt_aff_clickid=123456asd
'''Request parameters'''
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|'''Parameter'''
|'''Name In Request'''
|'''Description'''
|'''Example'''
|'''Required?'''
|-
|User agent
|u
|The browser user agent of the device making the request
|u= Mozilla/5.0 (Linux;U; Android 2.1-update1;iw-il; HTC LegendBuild/ERE27)
|Yes
|-
|Application id
|a
|The id of the applications, as registered in Taptica's AdCore servers.
|a=C20DC50B-65B9-4B11-8F62-79F9286896B7
|Yes
|-
|Sub affiliate/publisher
|tt_sub_aff
|Represents lower level of the affiliate traffic source
|tt_sub_aff=123529
|No
|-
|IP Address
|i
|Client IP Address
|i=84.103.57.1
|Yes
|-
|Interval
|int
|set the refresh rate in milliseconds (minutemen value 10000)
|int=15000
|No
|-
|Localization
|loc
|The localization (Language & Country) that is currently chosen for the device ,following the standards of ISO 639-1,ISO 3166-1.
|loc=en-uk
|No
|-
|Network type
|nt
|The type of network the device is currently connected to ("wifi" or "carrier")
|nt=carrier
|No,
|-
|Marital status
|marital
|Marital status of the user. options are: "single", "divorced", "engaged", "relationship", or "swinger"
|marital=single
|No
|-
|Income
|income
|Annual income (in USD) , e.g. 10000.
|income=10000
|No
|-
|Interests
|interests
|a comma separated list of keywords denoting user's area of interests.
|interests=cars,sports,F1,stocks
|No
|-
|Education
|edu
|Education level of the user ("UG" or "PG")
|edu=UG
|No
|-
|Resolution
|r
|Resolution of the ad request
|r=320x50
|Yes
|-
|Ad Type
|t
|Ad type - Banner (2), Interstitial (3), Video (5)
|t=2
|Yes
|-
|Gender
|gender
|Gender, Male, Female, All
|gender=male
|No
|-
|Age
|age
|Age of the user
|age=27
|No
|-
|Date Of Birth
|dob
|User's Date of birth(Format: yyyyMMdd)
|dob=19820211
|No
|-
|Latitude
|lat
|Location by latitudes lines
|lat=40.714353
|No
|-
|Longitude
|lon
|Location by longitude lines
|lon=-74.005973
|No
|-
|Response Type
|rt
|JSON=0, XML=1, XHTML=2, types of response
|No
|rt=0
|-
|Pipeline_data
|pd
|A free parameter for the affiliate use (can be send back to affiliate with S2S postback)
|pd=Any Affiliate Data
|No
|-
|Affiliate impression id
|tt_aff_impid
|Used for impression id that the publisher may want to send and get back via S2S postback
|tt_aff_impid=asjhbasdk7832sa
|No
|-
|Affiliate click id
|tt_aff_clickid
|Used for click id that the publisher may want to send and get back via S2S postback
|tt_aff_clickid=qa143287w
|No
|-
|}
'''Taptica Device Keys'''
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|'''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
|-
|Android Advertising ID
|tt_advertising_id
|Use for send Taptica Android advertising plain ID
|tt_advertising_id=3ee0149b4ccef71bs85d24derg
|Yes
|-
|Android Advertising ID SHA1
|tt_advertising_id_sha1
|Use for send Taptica Android advertising ID in SHA1 format
|tt_advertising_id=32f2e52e8157fcb729d799d1ca69160df2edf8974
|Yes
|-
|Android Advertising ID MD5
|tt_advertising_id_md5
|Use for send Taptica Android advertising ID in MD5 format
|tt_advertising_id=2315w52e8157fcb729d799d1ca691608speofd2
|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=4A9B0CAB-FFA5-4190-8CC0-D974D98FC7DB
|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 Name, cat, Specified the offer category (spaces should be replace with %20), cat=Games,Travel%20and%20Local, No -->
== Testing application IDs ==
For the integration process ONLY please use the below application IDs:
appid iPhone = c82a818c-859b-4faa-bfee-4dde683b9ae5
appid iPad = fbb159b3-a494-4a5d-bd80-ae9899157556
appid Android = fced70bd-cf47-44f0-86ae-533443b8155b
<!-- == Category List ==
The optional categories names are:
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|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
|-
|}
-->
== Response ==
The data is returned in a JSON format.
• The JSON returned by Taptica AdCore servers is a single object, composed of simple fields of JSON Type String, described in the section below.
'''Banner response'''
{
adyxAdRequestGuid: "3b327792-f364-41b4-9f34-501f1acc3109"
adType: "banner"
imageUrl: "http://media.go2speed.org/brand/files/taptica/4278/Bingo_2tixanimated_Banner_320x50.gif"
imageAltText: null
adUrl: "http://tracking.taptica.com/aff_ic?
tt_cid=3b327792f36441b49f34501f1acc3109&el=GbtixRMFpAr%2boJEVHfprXTgVAQ3Ld8jjq6x3iEWyaxyyAB9XQaJ2hY1C%2bRbXby
CqSUxUNfry7uYwwqJoGMRB4DXDBgQXPm3cW0TjdSjP3GwU4L4c80snbxBqkCNTlGzYfeDOTGlIBc72p%2bKawW1NjSO
6o5imY%2fv08FTGqOkRkhtpsdYOVHKXY6dYrgs57S2lAlmQgY62z3717Io%2f82fSHB4vgiY9rovVowp65VpiBKbt3a6VLqOpERRikOp
S6NDRe4qtJFdK326mBMsVETyPW1Egv4eZAnn1baZ5OLwYf9TWP3x1OsgHBD9YV5V2hA%2btjAExs9A%2brj%2b5Tk2lGAGFpK%2bM%2bd3ttbG%2f
%2brE2WlbRVHfE3EtatWKJ0g2kh8p2uccF7N5FsRn9PvvRTwgM0pgmw9h5xjcFcG9PfLRrmZ6QXCq5hytHd4B3y7WU1pQUmjtQO8YHaj0wTd
Z2NJJtyfuIL78qSwgTqfYiAkg7%2bMDVjs%3d"
impUrl: "http://ad.taptica.com/aff_i?tt_cid=3b327792f36441b49f34501f1acc3109&el=GbtixRMFpAr%2boJEVHfprXTgVAQ3Ld8jjq6
x3iEWyaxyyAB9XQaJ2hY1C%2bRbXbyCqSUxUNfry7uYwwqJoGMRB4DXDBgQXPm3cW0TjdSjP3GwU4L4c80snbxBqkCNTlGzYfeDOTGlIBc72p%2bKawW1NjSO6o
5imY%2fv08FTGqOkRkhtpsdYOVHKXY6dYrgs57S2lAlmQgY62z3717Io%2f82fSHB4vgiY9rovVowp65VpiBKbt3a6VLqOpERRikOpS6NDRe
4qtJFdK326mBMsVETyPW1Egv4eZAnn1baZ5OLwYf9UTWP3x1OsgHBD9YV5V2hA%2btjAExs9A%2brj%2b5Tk2lGAGFpK
%2bM%2bd3ttbG%2f%2brE2WlbRVHfE3EtatWKJ0g2kh8p2uccF7N5FsRn9PvvRTwgM0pgmw9h5xjcFcG9PfLRrmZ6QXCq5hytHd4B3y7WU1pQUmjtQO8YHaj
0wTdZ2NJJtyfuIL78qSwgTqfYiAkg7%2bMDVjs%3d"
urlType: "web"
beacon: null
adInterval: "10"
advAppId: "542781249"
storeUrl: null
payout: "1.05000"
}
'''Full screen response'''
{
adyxAdRequestGuid: "16e3738a-d8de-42eb-b2b2-717f05439d20"
adType: "html"
adUrl: "http://tracking.taptica.com/aff_ic? tt_cid=16e3738ad8de42ebb2b2717f05439d20&el=GbtixRMFpAr%2boJEVHfprXTgVAQ3Ld8jjq6x3iEWya
xw0xNkGtmnnjJwNwe44qM0tjC81iuD%2fY2OP%2flWMG4HvDojnhFFTvD6GjipHEVRrNZoBeU5KegCKluTbYLTH1YVt51xNRO2ol6vDbQZ08GhGA
oaDDJVtOCueNjYpuRrvCKJuNZLMRlKjlfkUx%2fO6Rlqax5KBBEaOchzJ5CXUoXK2aw%2blgcWmhzU%2ftjQKs0nqY60AeJ%2f2Zi1ZJAKTgqii4exPXrSu4iHeo
Oh9w80a1wkFC0s%2bjcFHe0EaDyAyp3zhkV6yrmd0bK%2flHPvR7yDpjOHKXjcEyfhZ%2b5oVMSoFyPhs%2bmM3p%2b5QCuliYboOs4qCgrXlgS4s3BqS4ysSVMm7nteZ
7Xwc89OoX3l73UN2m09BeeQsEWipt6cJdkocIgZpXS7tnJQaP2T8utWEVUiD9v6z50O1ogVrMyCoKrTXGO2iBbYAOQUhhvqxtOKRymKAqHLWLMsTnTfqkkRDgAnL791q"
impUrl: "http://ad.taptica.com/aff_i?tt_cid=16e3738ad8de42ebb2b2717f05439d20&el=GbtixRMFpAr%2boJEVHfprXTgVAQ3Ld8jjq6x3iEWyaxw0
xNkGtmnnjJwNwe44qM0tjC81iuD%2fY2OP%2flWMG4HvDojnhFFTvD6GjipHEVRrNZoBeU5KegCKluTbYLTH1YVt51xNRO2ol6vDbQZ08Gh
GAoaDDJVtOCueNjYpuRrvCKJuNZLMRlKjlfkUx%2fO6Rlqax5KBBEaOchzJ5CXUoXK2aw%2blgcWmhzU%2ftjQKs0nqY60AeJ%2f2Zi1ZJAKTgqii4exPX
rSu4iHeoOh9w80a1wkFC0s%2bjcFHe0EaDyAyp3zhkV6yrmd0bK%2flHPvR7yDpjOHKXjcEyfhZ%2b5oVMSoFyPhs%2bmM3p%2b5QCuliYboOs4qCgrXlgS4s3BqS4ysSVMm7
nteZ7Xwc89OoX3l73UN2m09BeeQsEWipt6cJdkocIgZpXS7tnJQaP2T8utWEVUiD9v6z50O1ogVrMyCoKrTXGO2iBbYAOQUhhvqxtOKRymKAqHLWLMsTnTfqkkRDgAnL791q"
urlType: "web"
htmlUrl: "http://media.go2speed.org/brand/files/taptica/4328/CandyCrush_playnow_fullscreen_320x480.jpg"
adInterval: "10"
htmlAdType: 2
advAppId: "553834731"
storeUrl: null
payout: "2.60000"
}
'''Video response'''
{
adyxAdRequestGuid: "58188bd6-ed46-4f56-aac4-c16b485d4b6b"
adType: "video"
imageUrl: "http://e600e6c54b8c990f6738-c4afc8039c721ab8b1a8cb345a16e942.r90.cf2.rackcdn.com/iphone%20320x480.mov"
imageAltText: null
videoUrl: "http://e600e6c54b8c990f6738-c4afc8039c721ab8b1a8cb345a16e942.r90.cf2.rackcdn.com/iphone%20320x480.mov"
replayIcon: "http://e600e6c54b8c990f6738-c4afc8039c721ab8b1a8cb345a16e942.r90.cf2.rackcdn.com/replay.png"
downloadIcon: "http://e600e6c54b8c990f6738-c4afc8039c721ab8b1a8cb345a16e942.r90.cf2.rackcdn.com/continue.png"
continueIcon: "http://e600e6c54b8c990f6738-c4afc8039c721ab8b1a8cb345a16e942.r90.cf2.rackcdn.com/download.png"
adUrl: "http://tracking.taptica.com/aff_ic?tt_cid=58188bd6ed464f56aac4c16b485d4b6b&el=GbtixRMFpAr%2boJEVHfprXTgVAQ3
Ld8jjq6x3iEWyaxxI90tKwhYH8O2%2bNtl2DbVlpaq0uwf6qw81f%2fGyd7brqi8f6IUob547ToFQMI7SyOZbPkaMkObRLIzCDq2dibh0Te
uBG%2fk9pqNnC73C9ODN5pM50OIod0IH%2bK5fv%2fF5k%2fqZHoLxeN63xxgFbtkfq8E5Ut4T0oPsCDl%2fM%2fJ7mnsGie04os0%2bb%2
bRrL3BRC%2bvcwv%2fuYqfUjlvc7Pb6HlwsqQ7CaS8EH8bHcim%2f9uP%2be%2b4ZL%2ffpCzwNG7LMui35B%2fhjPD7F95rISd%2fkL483U2
a3pKqU2hnBWDWE7YrN5pMwvAKC7MNzsSBhv0e4%2bnQEVLGwlZpQusm0RVB%2bRyStSzhfWt%2fxNsOriI7dg6WbjQW0Q0kqCns4zN3eeLey%
2betP1bJM5aZFo8BVeW%2fr4v7uxYOi3tGKKhEqlLnAOhjbh6LT0PdZuuW6fdEeg%2fRp6YGVeURsP7QE3CSCExADh0R8QXWxlfj5"
impUrl: null
contUrl: "http://ad.taptica.com/aff_i?offer_id=3418&aff_id=1740&tt_cid=58188bd6ed464f56aac4c16b485d4b6b&cont=1"
urlType: "web"
beacon: null
adInterval: "10"
advAppId: "531275818"
storeUrl: null
payout: "1.40000"
}
==impUrl==
The goal of the ImpURL is to report Taptica that impression take place.
MAKE SURE YOU FIRE IT WITH THE DEVICE USER AGENT.
* The impurl response is depend on your affiliate setting in Taptica
== Error Message ==
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|'''Parameter'''
|'''Description'''
|'''Example'''
|-
|errorId
|The identifier of the error that occurred. If needed, extra text describing the error will be written into the errorText.
|"5"
|-
|errorText
|Contains additional information regarding the retrieved error.
|"The error had happened due to the following unexpected reason: unsupported client"
|-
|}
== List of errors ==
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|'''errorID'''
|'''Description'''
|-
| -1
|Unknown error. In this case, the errorText parameter will include the information that describes the error.
|-
|0
|Server overload
|-
|1
|Server could not find an appropriate ad (because of age restriction , for example)
|-
|2
|Application id is missing
|-
|3
|Application id wasn't found on database
|-
|4
|User agent is missing
|-
|5
|User agent is not supported
|-
|6
|Test mode value is not supported
|-
|7
|Resolution size and/or density are not supported
|-
|8
|Resolution size and/or density are in the wrong format
|-
|9
|Postal code is in wrong format
|-
|10
|Area code is in wrong format
|-
|11
|Location is in wrong format
|-
|12
|Birth date is in wrong format or is invalid
|-
|13
|Gender is in wrong format
|-
|14
|Unique Identifier is missing
|-
|15
|Unique Identifier value is in wrong format or is invalid
|-
|16
|Localization is missing
|-
|17
|Localization value is in wrong format or is invalid
|-
|18
|Net type value is in wrong format or is invalid
|-
|19
|Marital status value is not supported
|-
|20
|Income value is in wrong format or is invalid
|-
|}</rev>
</revisions>
</page>
<page pageid="14" ns="0" title="Retrieve Raw Data Report">
<revisions>
<rev xml:space="preserve">This method is used to send request to Taptica's AdCore servers for retrieving ads reports.
The method will pass to Taptica's AdCore servers unique IDs identifying the applications and a set of metadata describing the request.
Restriction:
* All data can be retrieved only day by day
* Maximum number of applications per request - 100
== End Point ==
Service end point:
[ Version 4 ]
'''Service:''' http://api.taptica.com/sts/v4/AdsReportsAPI
'''WSDL:''' http://api.taptica.com/sts/v4/AdsReportsAPI?wsdl
== Method Signatures ==
List<AdCoreReportRawData> RetrieveReportRawData(
Authentication auth,
string[] applicationIds,
DateTime start,
DateTime end,
Filter filter)
'''Return Value'''<br/>
Type: AdCoreReportRawData <br/>
Return value has the following properties:
{| border="1" cellspacing="0" cellpadding="2"
|'''Property'''
|'''Type'''
|'''Description'''
|-
|RowId
|Int
|Unique row Id
|-
|ApplicationId
|String
|Unique application Id.
|-
|EventType
|String
|Event type, Ex: Request, Impression, Click, Conversion
|-
|AdNetworkName
|String
|Ad network name
|-
|HitGuid
|String
|Unique session Id
|-
|ClientIP
|String
|User/Handset reported Client IP
|-
|Country
|String
|Country name, Ex: "UK"
|-
|Platform
|string
|Handset platform name, Ex: Android
|-
|Cost
|String
|Cost in USD, By Event Type, Ex: 0.015
|-
|CreatedAt
|DateTime
|Date and Time
|}
'''Parameters Description'''<br/>
{| border="1" cellspacing="0" cellpadding="2" valign="top"
|'''Parameter'''
|'''Description'''
|-
|auth
|Type: Authentication
Hold the authentication tokens for AdCore.
This object has these properties:
'''UserName'''
A string having the username for used to identify on AdCore.
'''Password'''
Password for above username.
|-
|applicationIds
|Type: string[], in UUID format with ID of application as provisioned by AdCore.
|-
|start
|Type: DateTime , start date to begin the report.
|-
|end
|Type: DateTime , end date to end the report.
|-
|Filter
|Type: Filter.
Platform, String - Handset platform name, Ex: "Android";
EventType, String - Event type, "Request", "Impression", "Click", "Conversion"
AdNetworkName, String - Network name, Ex: "inmobi";
Country, String - Country name, Ex: "UK";
|}</rev>
</revisions>
</page>
</pages>
</query>
</api>