Vserv.mobi Android AppWrapper
description
Transcript of Vserv.mobi Android AppWrapper
Vserv.mobi Android
AppWrapper
Vserv.mobi Android AppWrapper
Page | 2
Contents Introduction .......................................................................................................................... 3
Prerequisites ......................................................................................................................... 3
Wrapping Steps .................................................................................................................... 3
Appendix A ............................................................................................................................ 6
Appendix B .......................................................................................................................... 11
Vserv.mobi Android AppWrapper
Page | 3
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 Description Values Default zoneId Required zoneId_end Required
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
<string>
showAt Specifies at what stage the ad is to be shown <string> start/end/both
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
<string> true [cannot] false[can]
false
cache Enables caching for post app advertisement <string>
true
Vserv.mobi Android AppWrapper
Page | 4
Advanced
Option Description Values Default startAfterCount startAfterCount_end*
Specifies if ad is to be shown only after specified counts of session.
<integer >
screenOrientation Specifies the orientation of the Ad Screen. If it’s not specified then the launcher orientation will be considered (if available) else the Ad orientation would default to portrait
landscape/portrait/reverseLandscape/reversePortrait/sensorLandscape/sensorPortrait
portrait
blockAds 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
<string>
false
preferenceName Indicates Shared preference name in which flags are set
<string> NA If blockAds=false
showAds
preAdFlagName Indicates name of flag to check for blocking pre ads
<string> NA If blockAds=false
stopPreAd
postAdFlagName Indicates name of flag to check for blocking post ads
<string> NA If blockAds=false
stopPostAd
flagDataType Indicates data types of flags mentioned in preAdFlagName and postAdFlagName
<string> NA If blockAds=false
boolean
flagValueToCompare Flag value to compare for blocking ads. <string> NA If blockAds=false
true
showAdsOnNoFlags Whether to show ads in case no flags are available in shared preference
<string> NA If blockAds=false
true
locationAds Indicates whether location based ads are allowed
<string> true [Allowed] false [Not Allowed]
true
wrapAd Specifies if Vserv Premium ads are need and should be wrapped.
<string> true/false
true
versionCode Specifies the internal version number. The value must be set as an integer.
<integer > NA If versionIncrement=false
versionName You can modify the version number shown to the user by modifying this attribute.
<string> NA If versionIncrement=false
versionIncrement Indicates whether version increment should be done post wrapping
false
mccExclusionList Specifies comma separated list of Mobile Country Codes (MCC) for which ads would be disabled. Appendix A enlists the required MCC’s
<string>
testMode Specifies whether test mode should be enabled
<string>
false
partnerId Sets the partner id <string>
sfId Sets the id for the storefront on which app
Vserv.mobi Android AppWrapper
Page | 5
will be deployed. For the list of valid store
front Ids refer Appendix B
Analytics related parameters
Option Description Values Default
wrapAnalytics Specifies if google analytics are needed and should be wrapped.
<string> true/false
false
analyticsKey
(Mandatory)
This will be your Web Property Id from google analytics account.
<string>
analyticsName Specifies the display name under which you can find your analytics
data.
<string> Midlet Name
First Launch Notification related parameters
Option Description Values Default
wrapFirstLaunchNotifier
Specifies if first launch notifier are to be wrapped
<string> true/false
false
firstLaunchUrl (Mandatory)
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
<string>
Code Signing related parameters
Option Description Values Default codeSigning 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
<string> none/vserv/self
none
keyStoreName Required
Specifies your key store file name <string>
aliasName Required
Specifies your alias name <string>
storePassword Required
Specifies your store password <string>
keyPassword Required
Specifies your key password <string>
Vserv.mobi Android AppWrapper
Page | 6
Other parameters
Option Description Values Default deleteRawAppsOnSuccess Specifies if raw apps to be
deleted after successful wrapping <string> true / false
false
moveNonApkResources
Specifies if non apk resources such as screenshots, game material if present inside RawApps folder to be moved to output folder WrappedApps
<string> true / false
false
Appendix A Country Name Code MCC
Afghanistan AF 412
Albania AL 276
Algeria DZ 603
American Samoa AS 544
Andorra AD 213
Angola AO 631
Anguilla AI 365
Antigua and Barbuda AG 344
Argentina AR 722
Armenia AM 283
Aruba AW 363
Australia AU 505
Austria AT 232
Azerbaijan AZ 400
Bahamas BS 364
Bahrain BH 426
Bangladesh BD 470
Barbados BB 342
Belarus BY 257
Belgium BE 206
Belize BZ 702
Benin BJ 616
Bermuda BM 350
Bhutan BT 402
Bolivia BO 736
Bosnia and Herzegovina BA 218
Botswana BW 652
Brazil BR 724
Vserv.mobi Android AppWrapper
Page | 7
Virgin Islands, British VG 348
Brunei Darussalam BN 528
Bulgaria BG 284
Burkina Faso BF 613
Burundi BI 642
Cambodia KH 456
Cameroon CM 624
Canada CA 302
Cape Verde CV 625
Cayman Islands KY 346
Central African Republic CF 623
Chad TD 622
Chile CL 730
China CN 460
Colombia CO 732
Comoros KM 654
Cook Islands CK 548
Costa Rica CR 712
Cote DIvoire CI 612
Croatia HR 219
Cuba CU 368
Cyprus CY 280
Czech Republic CZ 230
Congo, the Democratic Republic of the Congo CD 630
Denmark DK 238
Djibouti DJ 638
Dominica DM 366
Dominican Republic DO 370
Ecuador EC 740
Egypt EG 602
El Salvador SV 706
Equatorial Guinea GQ 627
Estonia EE 248
Ethiopia ET 636
Falkland Islands (Malvinas) FK 750
Faroe Islands FO 288
Fiji FJ 542
Finland FI 244
France FR 208
French Guiana GF 742
French Polynesia PF 547
Gabon GA 628
Gambia GM 607
Georgia GE 282
Germany DE 262
Vserv.mobi Android AppWrapper
Page | 8
Ghana GH 620
Gibraltar GI 266
Greece GR 202
Greenland GL 290
Grenada GD 352
Guam GU 535
Guatemala GT 704
Guinea GN 611
Guinea-Bissau GW 632
Guyana GY 738
Haiti HT 372
Honduras HN 708
Hong Kong HK 454
Hungary HU 216
Iceland IS 274
India IN 404
India IN 405
Indonesia ID 510
Iran, Islamic Republic of IR 432
Iraq IQ 418
Ireland IE 272
Israel IL 425
Italy IT 222
Jamaica JM 338
Japan JP 441
Japan JP 440
Jordan JO 416
Kazakhstan KZ 401
Kenya KE 639
Kiribati KI 545
Korea, Democratic Peoples Republic of KP 467
Korea, Republic of KR 450
Kuwait KW 419
Kyrgyzstan KG 437
Lao Peoples Democratic Republic LA 457
Latvia LV 247
Lebanon LB 415
Lesotho LS 651
Liberia LR 618
Libyan Arab Jamahiriya LY 606
Liechtenstein LI 295
Lithuania LT 246
Luxembourg LU 270
China CN 455
Macedonia MK 294
Vserv.mobi Android AppWrapper
Page | 9
Madagascar MG 646
Malawi MW 650
Malaysia MY 502
Maldives MV 472
Mali ML 610
Malta MT 278
Guadeloupe GP 340
Mauritania MR 609
Mauritius MU 617
Mexico MX 334
Micronesia, Federated States of FM 550
Moldova, Republic of MD 259
Monaco MC 212
Mongolia MN 428
Montenegro ME 297
Montserrat MS 354
Morocco MA 604
Mozambique MZ 643
Myanmar MM 414
Namibia NA 649
Nepal NP 429
Netherlands NL 204
Netherlands Antilles AN 362
New Caledonia NC 546
New Zealand NZ 530
Nicaragua NI 710
Niger NE 614
Nigeria NG 621
Norway NO 242
Oman OM 422
Pakistan PK 410
Palau PW 552
Palestinian Territory, Occupied PS 423
Panama PA 714
Papua New Guinea PG 537
Paraguay PY 744
Peru PE 716
Philippines PH 515
Poland PL 260
Portugal PT 268
Puerto Rico PR 330
Qatar QA 427
Congo CG 629
Reunion RE 647
Romania RO 226
Vserv.mobi Android AppWrapper
Page | 10
Russian Federation RU 250
Rwanda RW 635
Saint Kitts and Nevis KN 356
Saint Lucia LC 358
Saint Pierre and Miquelon PM 308
Saint Vincent and the Grenadines VC 360
Samoa WS 549
Sao Tome and Principe ST 626
Saudi Arabia SA 420
Senegal SN 608
Serbia RS 220
Seychelles SC 633
Sierra Leone SL 619
Singapore SG 525
Slovakia SK 231
Slovenia SI 293
Solomon Islands SB 540
Somalia SO 637
South Africa ZA 655
Spain ES 214
Sri Lanka LK 413
Sudan SD 634
Suriname SR 746
Swaziland SZ 653
Sweden SE 240
Switzerland CH 228
Syrian Arab Republic SY 417
Taiwan TW 466
Tajikistan TJ 436
Tanzania, United Republic of TZ 640
Thailand TH 520
Timor-Leste TL 514
Togo TG 615
Tonga TO 539
Trinidad and Tobago TT 374
Tunisia TN 605
Turkey TR 286
Turkmenistan TM 438
Turks and Caicos Islands TC 376
Uganda UG 641
Ukraine UA 255
United Arab Emirates AE 424
United States US 310
United States US 316
United States US 311
Vserv.mobi Android AppWrapper
Page | 11
Uruguay UY 748
Uzbekistan UZ 434
Vanuatu VU 541
Venezuela VE 734
Vietnam VN 452
Yemen YE 421
Zambia ZM 645
Zimbabwe ZW 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 ID
Getjar 51
Djuzz 52
Mobango 54
Nokia Ovi 55
Appia 57
Opera 58
Mobango Paid 59
Appia paid 60
Google Play 61
Opera Paid 62
ChinaMobile 63
UC Browser 64
CanvasM 65
tekciz.com 66
Zapak 67
Ibibo 68
Amazon 69
Mobilerated 70
appzmob 71
Slideme 72
Samsung 73
Flypp 74