Notify New Application
From wiki.taptica.com
(Difference between revisions)
(Created page with "This method is used to send request to Taptica's AdCore servers for creating a new mobile ads profile for a new application. The method will pass to Taptica's AdCore servers a...") |
Latest revision as of 09:14, 16 August 2012
This method is used to send request to Taptica's AdCore servers for creating a new mobile ads profile for a new application. The method will pass to Taptica's AdCore servers a unique ID identifying the application and a set of metadata describing the application.
[edit] End Point
Service end point:
[ Version 4.0 ]
Service: http://api.taptica.com/sts/v4/NotifyApplicationAPI
WSDL: http://api.taptica.com/sts/v4/NotifyApplicationAPI?wsdl
JSON: http://api.taptica.com/sts/v4/NotifyApplicationAPI/json/NotifyNewApplication
[edit] Method Signature
AdCoreProfileResult NotifyNewApplication( Authentication auth, // Authentication Details ApplicationProfile profile // Profile )
Return Value
Type: AdCoreProfileResult
Return value has the following properties:
| Property | Type | Description |
| Result | OutcomeEnum | The Result is an enumeration, possible value: Fail, Success |
| ErrorCode | Int | Specific error code. AdCore can define these. |
| ResultDescription | string | The description of the method call result in case of error |
Parameters Description
| 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.
|
| profile | Type: ApplicationProfile
An object describing the application, it has these properties: ApplicationID String (36): in UUID format with ID of application as provisioned by AdCore. This ID will also be used on update calls and by 3rd party mobile application when it contact AdCore server for mobile ads content. ApplicationURL String : represent the application url. Name String (64) : Name of application Description String (120): a description of the application. DeveloperName String (64): Developer Name – developer of the application. AdsProviders List of string and weight (0..10) of Ads provider, Example: InMobi,5, MillennialMedia,4, Vexigo,3, Dealnet,2, TargetedMobi,10, JumpTap = 6, Mojiva = 6, AdFonic = 0 ContentTypes Array of Strings: each string describing one of the content types applicable to the application. Each string in the array has a max length of 64 chars. example: [‘Gambling Related’, ‘Advertising’] can be an empty array. Category Array of Strings: each string describing one of the categories applicable to the application. Each string max length is 64 chars. example: [‘Communications’, ‘Games’, ‘Lifestyle’] Category's List: * Communications * Entertainments * Financial Services * Games * Health & Fitness * News & Weather * Shopping / Retail * Social * Sports * Tools/utilities * Travel and Local * Lifestyle * Multimedia * Automotive * Books & Reference Tags Array of Strings: each string describing one of a user defined tag that the developer used to describe the application. Each tag has a max 64 chars. Can be empty. Platform String: Describing one of the supported platforms. Possible values: BlackBerry, J2ME, Android, Symbian, iPhone (iOS), WebApp ContentFilters Array of Strings: each string describing one of the exclude ads from categories. Each string max length is 64 chars. example: [‘Tools, ‘Books’, ‘Photos’] TextFilters Array of Strings: each string describing one of the exclude ads that contains text. Each string max length is 64 chars. example: [‘cats, ‘dogs’, ‘bats’] LanguageFilters Array of Strings: each string describing one of the exclude ads in these Language Filters. Each string max length is 64 chars. example: [‘Thai, ‘German, ‘French] Resolutions String of comma separator resolution types example: 320x50,120x20 EnableBannerAd Enable Banner Ad EnableTextAd Enable Text Ad EnableHtmlAd Enable Html Ad |
JSON
Request:
{
"auth":{
"Password":"somepassword!",
"UserName":"someusername!"
},
"profile":{
"AdsProviders":[
{
"Key":"TargetedMobi",
"Value":10
},
{
"Key":"InMobi",
"Value":1
}
],
"ApplicationId":"16101917-1c15-1515-1316-1a1a1a11f4b7",
"ApplicationURL":null,
"Category":[
"Games"
],
"ContentFilters":null,
"ContentTypes":null,
"Description":"Some Description",
"DeveloperName":"Some Developer Name",
"EnableBannerAd":false,
"EnableHtmlAd":false,
"EnableTextAd":false,
"LanguageFilters":null,
"Name":"Application/Site Name",
"Platform":"Android",
"Resolutions":null,
"Tags":null,
"TextFilters":null
}
}
Successful Response:
{
"NotifyNewApplicationResult":{
"ErrorCode":0,
"Result":0,
"ResultDescription":null
}
}
Error Response:
{
"NotifyNewApplicationResult":{
"ErrorCode":61,
"Result":1,
"ResultDescription":"the application id 56205967-5c65-4555-a396-0a3a1aa1f4b7 is already exist"
}
}
