Vserv.

mobi Android AppWrapper

Vserv.mobi Android AppWrapper

Contents
Introduction.......................................................................................................................... 3 Prerequisites ......................................................................................................................... 3 Wrapping Steps .................................................................................................................... 3 Appendix A ............................................................................................................................ 6 Appendix B .......................................................................................................................... 11

Page | 2

Vserv.mobi Android AppWrapper

Introduction
The Vserv AppWrapper enables you to wrap your Android Apps with Vserv Premium Ads in One Click without any coding.

Prerequisites
Ensure that Java Development Kit (JDK) 1.6 or higher is installed on the PC and the PATH environment variable is properly set for JDK. You can find more details on Java path setup from below download link. http://vserv.mobi/docs/extras/JavaPathSetup.pdf

Wrapping Steps
1. Place all the application APK files to be wrapped in the RawApps folder. 2. Modify config.txt in conf folder as required. You can find all the configuration parameters listed in the next section. 3. Run VservAppWrapper.exe This will wrap the apk files and place processed apk files in the WrappedApps folder. Configuration Options

Option
zoneId
Required

Description
A zone defines the type of ads, targeting etc that will be used to shown Ads in your app. A default zoneId is generated at time of registration. This is available in the registration email, as well as in the Vserv.mobi online interface (Inventory > Zones). Values for both should be same, unless you need different targeting for start & end. In most cases the value for both is same Specifies at what stage the ad is to be shown

Values
<string>

Default

zoneId_end
Required

showAt

<string> start/end/both <string> true [cannot] false[can] <string>

both

viewMandatory

Specifies if the user can or cannot proceed with the application in case of non-availability of data connection to fetch the ad Enables caching for post app advertisement

false

cache

true

Page | 3

Vserv.mobi Android AppWrapper

Advanced Option
startAfterCount startAfterCount_end* screenOrientation

Description
Specifies if ad is to be shown only after specified counts of session. Specifies the orientation of the Ad Screen. If its not specified then the launcher orientation will be considered (if available) else the Ad orientation would default to portrait Used to block ads after certain event. For eg. You may want to block ads once end users have upgraded their application from free to paid version. To block both pre and post ads you need to create SharedPreferences with name specified in preferenceName and set flags specified in preAdFlagName and postAdFlagName with data type as mentioned in flagDataType Indicates Shared preference name in which flags are set Indicates name of flag to check for blocking pre ads Indicates name of flag to check for blocking post ads Indicates data types of flags mentioned in preAdFlagName and postAdFlagName Flag value to compare for blocking ads. Whether to show ads in case no flags are available in shared preference Indicates whether location based ads are allowed Specifies if Vserv Premium ads are need and should be wrapped. Specifies the internal version number. The value must be set as an integer.

Values
<integer > landscape/portrait/re verseLandscape/rever sePortrait/sensorLand scape/sensorPortrait <string>

Default
portrait

blockAds

false

preferenceName preAdFlagName postAdFlagName flagDataType flagValueToCompare showAdsOnNoFlags locationAds

wrapAd versionCode

versionName

You can modify the version number shown to the user by modifying this attribute.

<string> NA If blockAds=false <string> NA If blockAds=false <string> NA If blockAds=false <string> NA If blockAds=false <string> NA If blockAds=false <string> NA If blockAds=false <string> true [Allowed] false [Not Allowed] <string> true/false <integer > NA If versionIncrement=fal se <string> NA If versionIncrement=fal se

showAds stopPreAd stopPostAd boolean true true true

true

versionIncrement mccExclusionList

testMode partnerId sfId

Indicates whether version increment should be done post wrapping Specifies comma separated list of Mobile Country Codes (MCC) for which ads would be disabled. Appendix A enlists the required MCCs Specifies whether test mode should be enabled Sets the partner id Sets the id for the storefront on which app

false <string>

<string> <string>

false

Page | 4

Vserv.mobi Android AppWrapper

will be deployed. For the list of valid store front Ids refer Appendix B

Analytics related parameters Option

wrapAnalytics analyticsKey
(Mandatory)

Description
Specifies if google analytics are needed and should be wrapped. This will be your Web Property Id from google analytics account. Specifies the display name under which you can find your analytics data.

Values
<string> true/false <string> <string>

Default
false

analyticsName

Midlet Name

First Launch Notification related parameters Option

wrapFirstLaunchNotifier

Description
Specifies if first launch notifier are to be wrapped Specifies url to be hit when the app is started for the first time. Also on response code 200(HTTP OK) launch will be recorded on client side

Values
<string> true/false <string>

Default
false

firstLaunchUrl
(Mandatory)

Code Signing related parameters Option

codeSigning

Description
Specifies whether/how code signing should be done after wrapping. You have option to sign with your certificate or Vserv certificate. For codeSigning=self , you need to put your keystore file inside CodeSigning folder and also fill in relevant details inside conf.txt For codeSigning=vserv ,wrapper tool will give vserv signed binaries as output For codeSigning=none , wrapper tool will give unsigned apk as output Specifies your key store file name Specifies your alias name Specifies your store password Specifies your key password

Values
<string> none/vserv/self

Default
none

keyStoreName Required aliasName Required storePassword Required keyPassword Required

<string> <string> <string> <string>

Page | 5

Vserv.mobi Android AppWrapper

Other parameters Option

deleteRawAppsOnSuccess moveNonApkResources

Description
Specifies if raw apps to be deleted after successful wrapping Specifies if non apk resources such as screenshots, game material if present inside RawApps folder to be moved to output folder WrappedApps

Values
<string> true / false <string> true / false

Default
false false

Appendix A
Country Name Afghanistan Albania Algeria American Samoa Andorra Angola Anguilla Antigua and Barbuda Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Belarus Belgium Belize Benin Bermuda Bhutan Bolivia Bosnia and Herzegovina Botswana Brazil Code AF AL DZ AS AD AO AI AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BR MCC 412 276 603 544 213 631 365 344 722 283 363 505 232 400 364 426 470 342 257 206 702 616 350 402 736 218 652 724

Page | 6

Vserv.mobi Android AppWrapper

Virgin Islands, British Brunei Darussalam Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic Chad Chile China Colombia Comoros Cook Islands Costa Rica Cote DIvoire Croatia Cuba Cyprus Czech Republic Congo, the Democratic Republic of the Congo Denmark Djibouti Dominica Dominican Republic Ecuador Egypt El Salvador Equatorial Guinea Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands Fiji Finland France French Guiana French Polynesia Gabon Gambia Georgia Germany VG BN BG BF BI KH CM CA CV KY CF TD CL CN CO KM CK CR CI HR CU CY CZ CD DK DJ DM DO EC EG SV GQ EE ET FK FO FJ FI FR GF PF GA GM GE DE 348 528 284 613 642 456 624 302 625 346 623 622 730 460 732 654 548 712 612 219 368 280 230 630 238 638 366 370 740 602 706 627 248 636 750 288 542 244 208 742 547 628 607 282 262

Page | 7

Vserv.mobi Android AppWrapper

Ghana Gibraltar Greece Greenland Grenada Guam Guatemala Guinea Guinea-Bissau Guyana Haiti Honduras Hong Kong Hungary Iceland India India Indonesia Iran, Islamic Republic of Iraq Ireland Israel Italy Jamaica Japan Japan Jordan Kazakhstan Kenya Kiribati Korea, Democratic Peoples Republic of Korea, Republic of Kuwait Kyrgyzstan Lao Peoples Democratic Republic Latvia Lebanon Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg China Macedonia GH GI GR GL GD GU GT GN GW GY HT HN HK HU IS IN IN ID IR IQ IE IL IT JM JP JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU CN MK 620 266 202 290 352 535 704 611 632 738 372 708 454 216 274 404 405 510 432 418 272 425 222 338 441 440 416 401 639 545 467 450 419 437 457 247 415 651 618 606 295 246 270 455 294

Page | 8

Vserv.mobi Android AppWrapper

Madagascar Malawi Malaysia Maldives Mali Malta Guadeloupe Mauritania Mauritius Mexico Micronesia, Federated States of Moldova, Republic of Monaco Mongolia Montenegro Montserrat Morocco Mozambique Myanmar Namibia Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Norway Oman Pakistan Palau Palestinian Territory, Occupied Panama Papua New Guinea Paraguay Peru Philippines Poland Portugal Puerto Rico Qatar Congo Reunion Romania MG MW MY MV ML MT GP MR MU MX FM MD MC MN ME MS MA MZ MM NA NP NL AN NC NZ NI NE NG NO OM PK PW PS PA PG PY PE PH PL PT PR QA CG RE RO 646 650 502 472 610 278 340 609 617 334 550 259 212 428 297 354 604 643 414 649 429 204 362 546 530 710 614 621 242 422 410 552 423 714 537 744 716 515 260 268 330 427 629 647 226

Page | 9

Vserv.mobi Android AppWrapper

Russian Federation Rwanda Saint Kitts and Nevis Saint Lucia Saint Pierre and Miquelon Saint Vincent and the Grenadines Samoa Sao Tome and Principe Saudi Arabia Senegal Serbia Seychelles Sierra Leone Singapore Slovakia Slovenia Solomon Islands Somalia South Africa Spain Sri Lanka Sudan Suriname Swaziland Sweden Switzerland Syrian Arab Republic Taiwan Tajikistan Tanzania, United Republic of Thailand Timor-Leste Togo Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Uganda Ukraine United Arab Emirates United States United States United States RU RW KN LC PM VC WS ST SA SN RS SC SL SG SK SI SB SO ZA ES LK SD SR SZ SE CH SY TW TJ TZ TH TL TG TO TT TN TR TM TC UG UA AE US US US 250 635 356 358 308 360 549 626 420 608 220 633 619 525 231 293 540 637 655 214 413 634 746 653 240 228 417 466 436 640 520 514 615 539 374 605 286 438 376 641 255 424 310 316 311

Page | 10

Vserv.mobi Android AppWrapper

Uruguay Uzbekistan Vanuatu Venezuela Vietnam Yemen Zambia Zimbabwe UY UZ VU VE VN YE ZM ZW 748 434 541 734 452 421 645 648

Appendix B
Storefront ID allows you to segregate your reporting by the various stores you have uploaded your app to. To use this feature you need to make individual builds for each store with the respective StoreFront IDs specified.
Store Getjar Djuzz Mobango Nokia Ovi Appia Opera Mobango Paid Appia paid Google Play Opera Paid ChinaMobile UC Browser CanvasM tekciz.com Zapak Ibibo Amazon Mobilerated appzmob Slideme Samsung Flypp ID 51 52 54 55 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

Page | 11