Huawei AppGallery In-App Purchases
Huawei AppGallery is Huawei official Android Application store.
Huawei In-App Purchases (IAP) aggregates multiple payment methods for global payments, and can be easily integrated into your app to help you increase revenue. Using IAP, you can sell a variety of products or services, including digital goods and subscriptions, directly within your app.
Huawei devices use a variant of Android. Some may include both Google Play and the Huawei AppGallery so you may need to support both.
This section describes how to setup your AIR application to use Huawei In-App Purchases with this extension.
Install
The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (apm
). We highly recommend using apm
, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).
However you can choose to install it manually, as you would have done in the past.
- APM
- Manual
Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.
If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.
Setup APM
Install APM
If you haven't installed apm
follow the install guide on airsdk.dev.
Setup an APM project
You will need an APM project for your application.
There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:
apm init
Check your github token
We use github to secure our extensions so you must have created a github personal access token and configured apm
to use it.
To do this create a token using this guide from github and then set it in your apm config using:
apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX
If you don't do this correctly you may find the install will fail.
Install the extension
Install the package by running:
apm install com.distriqt.InAppBilling-AppGallery
This will download and install the extension, required assets, and all dependencies.
Once complete apm
will have created something like the following file structure:
.
|____ assets
| |____ android
| | |____ grs_sdk_global_route_config_apptouchupdatesdk.json
| | |____ grs_sdk_global_route_config_hmscoreInstallerSDK.json
| | |____ grs_sdk_global_route_config_opensdkService.json
| | |____ grs_sdk_global_route_config_updatesdk.json
| | |____ grs_sdk_server_config.json
| | |____ grs_sp.bks
| | |____ hmsincas.bks
| | |____ hmsrootcas.bks
|____ ane
| |____ com.distriqt.InAppBilling.AppGallery.ane # InAppBilling Huawei extension
| |____ [dependencies]
|____ apm_packages # cache directory - ignore
|____ project.apm # apm project file
Add the
ane
directory to your IDE. See the tutorials located here on adding an extension to your IDE.You will have an
assets
directory that contains required assets for the installed extensions. You must add the files in theassets/android
folder to the root of your Android application package. (It contains a series of files that Huawei services require to correctly operate). You do not need to add this to your iOS application package.These assets are required by the Huawei SDK and if not included an error will be dispatched when calling
setup()
.
We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using apm
that these updates will be pulled into your build automatically.
Only install one variant of an package. The base variant is installed when no variant is specified and cannot be included alongside another variant. You will likely get an error if you attempt to install multiple variants with apm
The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using apm
. Using apm
will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.
To add the extension to your development environment. Download the com.distriqt.InAppBilling.AppGallery.ane
extension from the repository and then follow the tutorial located here to add the extension to your development environment.
Assets
Along with the agconnect-services.json
there are a series of assets that need to be packaged with your application.
These assets are required by the Huawei SDK and if not included an error will be dispatched when calling setup()
.
Copy all the files in the assets
folder (alongside the extensions):
com.huawei.hms.base
:grs_sdk_global_route_config_apptouchupdatesdk.json
grs_sdk_global_route_config_hmscoreInstallerSDK.json
grs_sdk_global_route_config_updatesdk.json
com.huawei.hms.coreinstaller
:grs_sdk_global_route_config_opensdkService.json
grs_sdk_server_config.json
grs_sp.bks
hmsincas.bks
hmsrootcas.bks
These need to be added at the root level of your application and packaged with your application. You will find these assets in the HMS repository under lib/assets/android
alongside the HMS extensions.
Dependencies
Many of our extensions use some common libraries, for example, the Android Support libraries.
We have to separate these libraries into separate extensions in order to avoid multiple versions of the libraries being included in your application and causing packaging conflicts. This means that you need to include some additional extensions in your application along with the main extension file.
You will add these extensions as you do with any other extension, and you need to ensure it is packaged with your application.
Core
The Core extension is required by this extension. You must include this extension in your application.
The Core extension doesn't provide any functionality in itself but provides support libraries and frameworks used by our extensions. It also includes some centralised code for some common actions that can cause issues if they are implemented in each individual extension.
This extension requires you call the init()
function at some point early in your application, generally at the same time as the initialisation of this extension. If you are using other extensions that also require the Core extension, you only need to initialise it once, before initialising the other extensions.
Core.init();
You can access this extension here: https://github.com/distriqt/ANE-Core.
Huawei Mobile Services
This extension requires usage of certain aspects of the Huawei Mobile Services (HMS) SDK.
The HMS SDK is available as a series of extensions that you add into your applications packaging options. Each separate extension provides a component(s) from the HMS SDK and are used by different extensions. These client libraries aren't packaged with this extension as they are used by multiple extensions and separating them will avoid conflicts, allowing you to use multiple extensions in the one application.
This extension requires the following HMS extensions:
You must include the above native extensions in your application along with this extension, and you need to ensure they are packaged with your application.
You can access the Huawei Mobile Services SDK extensions here: https://github.com/distriqt/ANE-HuaweiMobileServices.
Application Descriptor
- APM
- Manual
Updating your application descriptor will insert the required extensionID
's and generate the manifest and info additions for your application.
You update your application descriptor by running:
apm generate app-descriptor src/MyApp-app.xml
Change the path (src/MyApp-app.xml
) to point to your application descriptor.
This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from apm
.
You should backup your application descriptor before running this command to ensure you don't lose any information.
If you need to insert custom data into these sections see the guides for Android and iOS
Extension IDs
The following should be added to your extensions
node in your application descriptor to identify all the required ANEs in your application:
<extensions>
<extensionID>com.distriqt.InAppBilling</extensionID>
<extensionID>com.distriqt.Core</extensionID>
<extensionID>com.huawei.hms.base</extensionID>
<extensionID>com.huawei.hms.coreinstaller</extensionID>
<extensionID>com.huawei.hms.game</extensionID>
</extensions>
Android
Manifest Additions
Add the following permissions to your manifest additions, these permissions are used by the Huawei SDK to access certain configuration data and request installation of packages if found missing from the device:
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="com.android.vending.BILLING" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<uses-permission android:name="android.permission.GET_TASKS" />
<uses-permission android:name="android.permission.REAL_GET_TASKS" />
<uses-permission android:name="com.huawei.hwid.permission.gameservice.archive.access.provider" />
<uses-permission android:name="com.huawei.appmarket.service.commondata.permission.GET_COMMON_DATA" />
Add the following queries section:
<queries>
<intent>
<action android:name="com.apptouch.intent.action.update_hms" />
</intent>
<intent>
<action android:name="com.huawei.appmarket.intent.action.AppDetail" />
</intent>
<package android:name="com.huawei.works" />
<package android:name="com.hisilicon.android.hiRMService" />
<intent>
<action android:name="com.huawei.hms.core.aidlservice" />
</intent>
<intent>
<action android:name="com.huawei.hms.core" />
</intent>
<intent>
<action android:name="com.huawei.appmarket.intent.action.ThirdUpdateAction" />
</intent>
</queries>
These should be added to the application
node in your manifest additions. Replace any occurances of APPLICATION_PACKAGE
with the Android java package name of your application.
<activity
android:name="com.distriqt.extension.inappbilling.activities.ProductViewActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar">
</activity>
<!-- HUAWEI APP GALLERY -->
<meta-data
android:name="com.huawei.hms.client.service.name:iap"
android:value="iap:6.10.0.300" />
<meta-data
android:name="com.huawei.hms.min_api_level:iap:iap"
android:value="1" />
<!-- HUAWEI BASE -->
<provider
android:name="com.huawei.agconnect.core.provider.AGConnectInitializeProvider"
android:authorities="APPLICATION_PACKAGE.AGCInitializeProvider"
android:exported="false" />
<service
android:name="com.huawei.agconnect.core.ServiceDiscovery"
android:exported="false" />
<meta-data
android:name="availableLoaded"
android:value="yes" />
<meta-data
android:name="com.huawei.hms.client.service.name:base"
android:value="base:6.11.0.301" />
<meta-data
android:name="com.huawei.hms.min_api_level:base:hmscore"
android:value="1" />
<activity
android:name="com.huawei.hms.hwid.internal.ui.activity.HwIdSignInHubActivity"
android:configChanges="fontScale|uiMode"
android:excludeFromRecents="true"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
<activity
android:name="com.huawei.hms.account.internal.ui.activity.AccountSignInHubActivity"
android:excludeFromRecents="true"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
<meta-data
android:name="com.huawei.hms.client.service.name:hwid"
android:value="hwid:6.11.0.300" />
<meta-data
android:name="com.huawei.hms.min_api_level:hwid:hwid"
android:value="1" />
<meta-data
android:name="com.huawei.hms.min_api_level:hwid:account"
android:value="13" />
<activity
android:name="com.huawei.hms.activity.BridgeActivity"
android:configChanges="orientation|locale|layoutDirection|fontScale|screenSize|smallestScreenSize|screenLayout|uiMode"
android:excludeFromRecents="true"
android:exported="false"
android:hardwareAccelerated="true"
android:screenOrientation="behind"
android:theme="@style/Base_Translucent" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
</activity>
<activity
android:name="com.huawei.hms.activity.EnableServiceActivity"
android:configChanges="orientation|keyboardHidden|screenSize|smallestScreenSize|screenLayout"
android:exported="false" >
</activity>
<!-- HUAWEI CORE INSTALLER -->
<meta-data
android:name="componentverify_ag_cbg_root"
android:value="@string/ag_sdk_cbg_root" />
<meta-data
android:name="availableHMSCoreInstaller"
android:value="yes" />
<provider
android:name="com.huawei.hms.update.provider.UpdateProvider"
android:authorities="APPLICATION_PACKAGE.hms.update.provider"
android:exported="false"
android:grantUriPermissions="true" >
</provider>
<activity
android:name="com.huawei.updatesdk.service.otaupdate.AppUpdateActivity"
android:configChanges="orientation|screenSize"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent.NoTitleBar" />
<meta-data
android:name="hnc-theme"
android:value="androidhnext:style/Theme.Magic.Translucent.NoTitleBar" />
</activity>
<activity
android:name="com.huawei.updatesdk.support.pm.PackageInstallerActivity"
android:configChanges="orientation|keyboardHidden|screenSize"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
<meta-data
android:name="hnc-theme"
android:value="androidhnext:style/Theme.Magic.Translucent" />
</activity>
<provider
android:name="com.huawei.updatesdk.fileprovider.UpdateSdkFileProvider"
android:authorities="APPLICATION_PACKAGE.updateSdk.fileProvider"
android:exported="false"
android:grantUriPermissions="true" />
<!-- HUAWEI GAME -->
<meta-data
android:name="com.huawei.hms.client.service.name:game"
android:value="game:6.10.0.300" />
<service
android:name="com.huawei.hms.jos.games.service.GameService"
android:exported="true" >
<intent-filter>
<action android:name="com.huawei.hms.games.service" />
</intent-filter>
</service>
<provider
android:name="com.huawei.hms.jos.games.archive.ArchiveRemoteAccessProvider"
android:authorities="APPLICATION_PACKAGE.hmssdk.jos.archive"
android:exported="true" >
</provider>
<activity
android:name="com.huawei.appmarket.component.buoycircle.impl.delegete.BuoyBridgeActivity"
android:configChanges="orientation|locale|screenSize|layoutDirection|fontScale"
android:excludeFromRecents="true"
android:exported="false"
android:hardwareAccelerated="true"
android:theme="@android:style/Theme.Translucent" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
</activity>
<meta-data
android:name="com.huawei.hms.jos.versioncode"
android:value="61000300" />
Manifest Example
The following example uses our test applicaiton id air.com.distriqt.test
:
<android>
<manifestAdditions><![CDATA[
<manifest android:installLocation="auto">
<uses-sdk android:targetSdkVersion="31" />
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="com.android.vending.BILLING" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<uses-permission android:name="android.permission.GET_TASKS" />
<uses-permission android:name="android.permission.REAL_GET_TASKS" />
<uses-permission android:name="com.huawei.hwid.permission.gameservice.archive.access.provider" />
<uses-permission android:name="com.huawei.appmarket.service.commondata.permission.GET_COMMON_DATA" />
<queries>
<intent>
<action android:name="com.apptouch.intent.action.update_hms" />
</intent>
<intent>
<action android:name="com.huawei.appmarket.intent.action.AppDetail" />
</intent>
<package android:name="com.huawei.works" />
<package android:name="com.hisilicon.android.hiRMService" />
<intent>
<action android:name="com.huawei.hms.core.aidlservice" />
</intent>
<intent>
<action android:name="com.huawei.hms.core" />
</intent>
<intent>
<action android:name="com.huawei.appmarket.intent.action.ThirdUpdateAction" />
</intent>
</queries>
<application android:allowBackup="false">
<meta-data android:name="android.max_aspect" android:value="2.5" />
<activity
android:name="com.distriqt.extension.inappbilling.activities.ProductViewActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar">
</activity>
<!-- HUAWEI APP GALLERY -->
<meta-data
android:name="com.huawei.hms.client.service.name:iap"
android:value="iap:6.10.0.300" />
<meta-data
android:name="com.huawei.hms.min_api_level:iap:iap"
android:value="1" />
<!-- HUAWEI BASE -->
<provider
android:name="com.huawei.agconnect.core.provider.AGConnectInitializeProvider"
android:authorities="air.com.distriqt.test.AGCInitializeProvider"
android:exported="false" />
<service
android:name="com.huawei.agconnect.core.ServiceDiscovery"
android:exported="false" />
<meta-data
android:name="availableLoaded"
android:value="yes" />
<meta-data
android:name="com.huawei.hms.client.service.name:base"
android:value="base:6.11.0.301" />
<meta-data
android:name="com.huawei.hms.min_api_level:base:hmscore"
android:value="1" />
<activity
android:name="com.huawei.hms.hwid.internal.ui.activity.HwIdSignInHubActivity"
android:configChanges="fontScale|uiMode"
android:excludeFromRecents="true"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
<activity
android:name="com.huawei.hms.account.internal.ui.activity.AccountSignInHubActivity"
android:excludeFromRecents="true"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
<meta-data
android:name="com.huawei.hms.client.service.name:hwid"
android:value="hwid:6.11.0.300" />
<meta-data
android:name="com.huawei.hms.min_api_level:hwid:hwid"
android:value="1" />
<meta-data
android:name="com.huawei.hms.min_api_level:hwid:account"
android:value="13" />
<activity
android:name="com.huawei.hms.activity.BridgeActivity"
android:configChanges="orientation|locale|layoutDirection|fontScale|screenSize|smallestScreenSize|screenLayout|uiMode"
android:excludeFromRecents="true"
android:exported="false"
android:hardwareAccelerated="true"
android:screenOrientation="behind"
android:theme="@style/Base_Translucent" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
</activity>
<activity
android:name="com.huawei.hms.activity.EnableServiceActivity"
android:configChanges="orientation|keyboardHidden|screenSize|smallestScreenSize|screenLayout"
android:exported="false" >
</activity>
<!-- HUAWEI CORE INSTALLER -->
<meta-data
android:name="componentverify_ag_cbg_root"
android:value="@string/ag_sdk_cbg_root" />
<meta-data
android:name="availableHMSCoreInstaller"
android:value="yes" />
<provider
android:name="com.huawei.hms.update.provider.UpdateProvider"
android:authorities="air.com.distriqt.test.hms.update.provider"
android:exported="false"
android:grantUriPermissions="true" >
</provider>
<activity
android:name="com.huawei.updatesdk.service.otaupdate.AppUpdateActivity"
android:configChanges="orientation|screenSize"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent.NoTitleBar" />
<meta-data
android:name="hnc-theme"
android:value="androidhnext:style/Theme.Magic.Translucent.NoTitleBar" />
</activity>
<activity
android:name="com.huawei.updatesdk.support.pm.PackageInstallerActivity"
android:configChanges="orientation|keyboardHidden|screenSize"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
<meta-data
android:name="hnc-theme"
android:value="androidhnext:style/Theme.Magic.Translucent" />
</activity>
<provider
android:name="com.huawei.updatesdk.fileprovider.UpdateSdkFileProvider"
android:authorities="air.com.distriqt.test.updateSdk.fileProvider"
android:exported="false"
android:grantUriPermissions="true" />
<!-- HUAWEI GAME -->
<meta-data
android:name="com.huawei.hms.client.service.name:game"
android:value="game:6.10.0.300" />
<service
android:name="com.huawei.hms.jos.games.service.GameService"
android:exported="true" >
<intent-filter>
<action android:name="com.huawei.hms.games.service" />
</intent-filter>
</service>
<provider
android:name="com.huawei.hms.jos.games.archive.ArchiveRemoteAccessProvider"
android:authorities="air.com.distriqt.test.hmssdk.jos.archive"
android:exported="true" >
</provider>
<activity
android:name="com.huawei.appmarket.component.buoycircle.impl.delegete.BuoyBridgeActivity"
android:configChanges="orientation|locale|screenSize|layoutDirection|fontScale"
android:excludeFromRecents="true"
android:exported="false"
android:hardwareAccelerated="true"
android:theme="@android:style/Theme.Translucent" >
<meta-data
android:name="hwc-theme"
android:value="androidhwext:style/Theme.Emui.Translucent" />
</activity>
<meta-data
android:name="com.huawei.hms.jos.versioncode"
android:value="61000300" />
</application>
</manifest>
]]></manifestAdditions>
</android>
iOS
InfoAdditions
There are no required iOS additions to the application descriptor.
Checking for Support
You can use the isSupported
flag to determine if this extension is supported on the current platform and device.
This allows you to react to whether the functionality is available on the device and provide an alternative solution if not.
if (InAppBilling.isSupported)
{
// Functionality here
}
This only checks if there is some functionality supported, not whether a particular billing service is available.