SDK Ads TAG

From wiki.taptica.com
(Difference between revisions)
Jump to: navigation, search
(Tag Example)
(Tag Example)
 
(9 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
Below you will find a base tag example, this example may be taken for integration within the publisher's application, just remember to change the appID in the "Please change me!" area
 +
 
== Tag Example ==  
 
== Tag Example ==  
 
<nowiki><script type="text/javascript" src="http://ad.taptica.com/sdk/js/TapticaWebAdSDK.v3.6.js"></script>
 
<nowiki><script type="text/javascript" src="http://ad.taptica.com/sdk/js/TapticaWebAdSDK.v3.6.js"></script>
Line 14: Line 16:
 
     </script></nowiki>
 
     </script></nowiki>
  
'''Return Value'''<br/>
+
 
Type:  AdCoreProfileResult<br/>
+
'''Tag Parameters'''<br/>
Return value has the following properties:
+
The tag may be filled with these parameters to set up a static field sent by the tag.
 +
 
  
 
{| border="1" cellspacing="0" cellpadding="2"
 
{| border="1" cellspacing="0" cellpadding="2"
  
|'''Property'''
+
|'''Parameter'''
|'''Type'''
+
|'''Content'''
|'''Description'''   
+
|'''Relevance''' 
 +
|'''Importance'''   
 
|-
 
|-
|Result
+
|"webSDKAdApplicationID"
|OutcomeEnum
+
|" F88AEC6E-CF1A-4D50-8761-76345D1A4968_64"
|The Result is an enumeration, possible value: Fail, Success
+
|Sets the application ID as provided by Taptica (Mandatory)
 +
|Identifies the app. to allow TapticaAd to select relevant ads and display them correctly
  
 
|-
 
|-
|ErrorCode
+
|"webSDKExtClickUrl"
|Int
+
|"${CLICKURL}"
|Specific error code. AdCore can define these.
+
|Sends a request to an additional URL provided by the publisher
 +
|In case you wish to track clicks via your own link in addition to what is provided by Taptica's services
  
 
|-
 
|-
|ResultDescription
+
|"webSDKAdDeviceId"
|string
+
|"xxxxxxxxxxxxxxx"
|The description of the method call result in case of error
+
|Identifies a machine via its unique ID
 +
|In case the agreed tracking solution is UDID/Android ID.
  
|}
+
|-
 +
|"webSDKAdPosition"
 +
|"right"
 +
|Sets the position of the ad
 +
|Default is set to right
  
 +
|-
 +
|"webSDKAdIp"
 +
|"xx.xx.xxx.xxx"
 +
|Sets the client IP
 +
|Relevant for test
 +
purposes and Geo targeting.
  
'''Parameters Description'''<br/>
+
|-
 +
|"webSDKAdType"
 +
|"x"
 +
|Sets the ad type
 +
|1=Text, 2=Banner, 3=HTML, 4=After Wall (default is 2)
  
{| border="1" cellspacing="0" cellpadding="2" valign="top"
+
|-
 +
|"webSDKAdUserAgent"
 +
|"Mozilla/5.0 (Linux; U;Android 2.1-update1; enus; Milestone Build/SHOLS_U2_02.27.C) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17"
 +
|User's agent.
 +
|User Agent supplies targeting information such as browser, OS, etc.
  
 +
|-
 +
|"webSDKAdResolution"
 +
|"320x50"
 +
|Asks the server to look for ads closest to these dimensions. Default is 320x50.
 +
|If no ad was found with the exact dimensions, will send back an ad with the closest dimensions/ratio.
  
|'''Parameter'''
 
|'''Description''' 
 
 
|-
 
|-
|auth
+
|"webSDKAdResolutionWidth"
|Type: Authentication
+
|"320"
 +
|Set image width Display on the device. If not inserted will use ad's default size.
 +
|Defines the client to display the ad with this width. (It is recommended to use the same dimensions defined in the "webSDKAdResolution" parameter)
  
Hold the authentication tokens for AdCore.
+
|-
This object has these properties:
+
|"webSDKAdResolutionHeight"
'''UserName'''
+
|"50"
A string having the username for used to identify on AdCore.
+
|Set image height Display on the device. If not inserted will use ad's default size.
'''Password'''
+
|Defines the client to display the ad with this height. (It is recommended to use the same dimensions defined in the "webSDKAdResolution" parameter)
Password for above username.
+
  
 +
|-
 +
|"webSDKAdPostalCode"
 +
|"xxxx"
 +
|Sets the User's zip code
 +
|
  
 
|-
 
|-
|profile
+
|"webSDKAdAreaCode"
|Type: ApplicationProfile
+
|"xxx"
 +
|Sets the User's area code
 +
|
  
An object describing the application, it has these properties:
+
|-
'''ApplicationID'''  
+
|"webSDKAdBirthdate"
String (36): in UUID format with ID of application as provisioned by AdCore.
+
|"yyymmdd"
This ID will also be used on update calls and by 3rd party mobile application when it contact AdCore server for mobile ads content.
+
|Sets the user's birthday
'''Name'''
+
|
String (64) : Name of application
+
 
'''Description'''  
+
|-
String (120): a description of the application.
+
|"webSDKAdMarital"
'''DeveloperName'''
+
|"x"
String (64):  Developer Name – developer of the application.
+
|Sets the user's marital status
'''ContentTypes''' 
+
|0=Unknown 1=Single 2=Divorced 3=Engaged 4=Relationship 5=Swinger
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’]
+
|"webSDKAdInterests"
can be an empty array.
+
|"xxxx, xxx, xxxx"
'''Category''' 
+
|Sets user's interests
Array of Strings: each string describing one of the categories applicable to the application. Each string max length is 64 chars.
+
|Divided by comma.
example: [‘Video’, ‘news’, ‘education’]
+
 
'''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
+
|"webSDKAdGender"
max 64 chars. Can be empty.
+
|"x"
'''Platform''' 
+
|Sets the user's gender
String: Describing one of the supported platforms.
+
|0=Unknown 1=Male 2=Female
Possible values: BlackBerry, J2ME, Android, Symbian, iOS
+
 
'''ContentFilters'''
+
|-
Array of Strings: each string describing one of the exclude ads from categories. Each string max length is 64 chars.
+
|"webSDKAdIntervalMillisec"
example: [‘Tools, ‘Books’, ‘Photos’]
+
|"xxxx"
'''TextFilters'''
+
|Time interval between requests.
Array of Strings: each string describing one of the exclude ads that contains text. Each string max length is 64 chars.
+
|Default is 10000 milliseconds (10 sec)
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.
+
|"WebSDKAdKeywords"
example: [‘Thai, ‘German, ‘French]
+
|"xxxxx, xxxx, xxxxx"
 +
|Sets Keywords to be sent to the server for each ad request
 +
|e.g. App for toddlers, its recommended to use keywords "Kids, Children toys" and so on
 +
 
 +
|-
 +
|"webSDKAdEducation"
 +
|"x"
 +
|Sets the user's education
 +
|0=Unknown 1=UG 2=PG
 +
 
 +
|-
 +
|"webSDKAdTestMode"
 +
|"x"
 +
|Sets the geographic location of the device to be as the specified location.
 +
|Supplies knowledge of the target audience- enables you to provide ads limited to a specific area
 +
 
 +
|-
 +
|"Web"SDKAdLatitude"
 +
|" xxxx.xxxx" (Double)
 +
|Sets the geographic location of the device to be as the specified location.
 +
|Supplies knowledge of the target audience- enables you to provide ads limited to a specific area
 +
 
 +
|-
 +
|"Web"SDKAdLatitude"
 +
|" xxxx.xxxx" (Double)
 +
|Sets the geographic location of the device to be as the specified location.
 +
|Supplies knowledge of the target audience- enables you to provide ads limited to a specific
  
 
|}
 
|}

Latest revision as of 07:54, 21 August 2012

Below you will find a base tag example, this example may be taken for integration within the publisher's application, just remember to change the appID in the "Please change me!" area

[edit] Tag Example

<script type="text/javascript" src="http://ad.taptica.com/sdk/js/TapticaWebAdSDK.v3.6.js"></script> <script type="text/javascript"> var flag = false; $(document).ready(function () { var paramsAuto = { "webSDKAdApplicationID": "Please change me!" } getAd(paramsAuto); }); </script>


Tag Parameters
The tag may be filled with these parameters to set up a static field sent by the tag.


Parameter Content Relevance Importance
"webSDKAdApplicationID" " F88AEC6E-CF1A-4D50-8761-76345D1A4968_64" Sets the application ID as provided by Taptica (Mandatory) Identifies the app. to allow TapticaAd to select relevant ads and display them correctly
"webSDKExtClickUrl" "${CLICKURL}" Sends a request to an additional URL provided by the publisher In case you wish to track clicks via your own link in addition to what is provided by Taptica's services
"webSDKAdDeviceId" "xxxxxxxxxxxxxxx" Identifies a machine via its unique ID In case the agreed tracking solution is UDID/Android ID.
"webSDKAdPosition" "right" Sets the position of the ad Default is set to right
"webSDKAdIp" "xx.xx.xxx.xxx" Sets the client IP Relevant for test

purposes and Geo targeting.

"webSDKAdType" "x" Sets the ad type 1=Text, 2=Banner, 3=HTML, 4=After Wall (default is 2)
"webSDKAdUserAgent" "Mozilla/5.0 (Linux; U;Android 2.1-update1; enus; Milestone Build/SHOLS_U2_02.27.C) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17" User's agent. User Agent supplies targeting information such as browser, OS, etc.
"webSDKAdResolution" "320x50" Asks the server to look for ads closest to these dimensions. Default is 320x50. If no ad was found with the exact dimensions, will send back an ad with the closest dimensions/ratio.
"webSDKAdResolutionWidth" "320" Set image width Display on the device. If not inserted will use ad's default size. Defines the client to display the ad with this width. (It is recommended to use the same dimensions defined in the "webSDKAdResolution" parameter)
"webSDKAdResolutionHeight" "50" Set image height Display on the device. If not inserted will use ad's default size. Defines the client to display the ad with this height. (It is recommended to use the same dimensions defined in the "webSDKAdResolution" parameter)
"webSDKAdPostalCode" "xxxx" Sets the User's zip code
"webSDKAdAreaCode" "xxx" Sets the User's area code
"webSDKAdBirthdate" "yyymmdd" Sets the user's birthday
"webSDKAdMarital" "x" Sets the user's marital status 0=Unknown 1=Single 2=Divorced 3=Engaged 4=Relationship 5=Swinger
"webSDKAdInterests" "xxxx, xxx, xxxx" Sets user's interests Divided by comma.
"webSDKAdGender" "x" Sets the user's gender 0=Unknown 1=Male 2=Female
"webSDKAdIntervalMillisec" "xxxx" Time interval between requests. Default is 10000 milliseconds (10 sec)
"WebSDKAdKeywords" "xxxxx, xxxx, xxxxx" Sets Keywords to be sent to the server for each ad request e.g. App for toddlers, its recommended to use keywords "Kids, Children toys" and so on
"webSDKAdEducation" "x" Sets the user's education 0=Unknown 1=UG 2=PG
"webSDKAdTestMode" "x" Sets the geographic location of the device to be as the specified location. Supplies knowledge of the target audience- enables you to provide ads limited to a specific area
"Web"SDKAdLatitude" " xxxx.xxxx" (Double) Sets the geographic location of the device to be as the specified location. Supplies knowledge of the target audience- enables you to provide ads limited to a specific area
"Web"SDKAdLatitude" " xxxx.xxxx" (Double) Sets the geographic location of the device to be as the specified location. Supplies knowledge of the target audience- enables you to provide ads limited to a specific
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox