目录

This section describes the preparation procedures for integrating HUAWEI Drive Kit into your app.

The mandatory procedures include:

  1. Register as a developer.

  2. Create an app.

  3. Generate a signing certificate fingerprint.

  4.  Configure the signing certificate fingerprint.

  5. Enable HUAWEI Drive Kit.

Preparations on the client side:

  1. Integrate the Drive SDK and HMS SDK.

  2. Configure obfuscation scripts.

Preparations on the server side:

  1. Integrate the HMS SDK.

  2. Configure obfuscation scripts.

1 Configuring App Information in AppGallery Connect

Before you start developing an app, configure app information in AppGallery Connect.

1.1 Registering as a Developer

Before you get started, you must register as a HUAWEI developer and complete identity verification on the HUAWEI Developer website. For details, please refer to Register a HUAWEI ID.

1.2 Creating an App

Create an app by referring to Creating a Project and Creating an App in the Project. Special configurations for a game app are as follows:

l   Platform: Select Android.

l   Device: Select Mobile phone.

l   App category: Select App.

NOTICE：

AppGallery Connect reads the temporary APK to obtain the app package name. Therefore, the temporary APK name must be the same as the released APK name.

1.3 Generating a Signing Certificate Fingerprint

A signing certificate fingerprint is used to verify the authenticity of an app when it attempts to access an HMS Core through the HMS SDK. Before using the HMS Core, you must locally generate a signing certificate fingerprint and configure it in AppGallery Connect.

Please ensure that the following conditions are met:

l   You have created the app's signature file.

l   The JDK has been installed on your PC.

Perform the following steps:

1. Open the command line tool (using the cmd command) and run the cd command to go to the directory where keytool.exe is located. In the following example, the Java program is installed in Program Files (x86) in the C drive.

2. Run keytool -list -v -keystore <keystore-file> and respond as prompted.

In the preceding command, <keystore-file> is the complete path to the app's signature file.

Example:

C:\Program Files (x86)\Java\jdk1.7.0_25\bin>keytool -list -v -keystore
E:\HMS_SDK_2.5.1.300\Sample\HMSSdkSample_2.5.1.300_AS\HmsSample\android.keystore.jks

3. Obtain the SHA-256 fingerprint from the result.

1.4 Configuring the Signing Certificate Fingerprint

1.  Sign in to AppGallery Connect and select My projects.

2.  Find your project from the project list and click the app on the project card.

3.  On the Project Setting page, set SHA-256 certificate fingerprint to the SHA-256 fingerprint that is generated from the preceding section of Generating a Signing Certificate Fingerprint.

4.  After completing configuration, click .

1.5 Enabling Required Services

l   To use the Drive service, you must also enable the Account and Push services. 

For details, please refer to Enabling Services.

2 Preparing for Client Development

2.1 SDK Description

To integrate HUAWEI Drive Kit into your app, you will need to integrate both the HMS SDK and the Drive SDK. The HMS SDK provides sign-in and authentication information, while the Drive SDK provides the capability of managing users' files in Drive.

Version

Development Environment

Path

Drive SDK4.0.3.300

IDE: Android Studio

Integration mode: Gradle + Maven

Maven repository: https://developer.huawei.com/repo/

Note: This is the link to the Maven   repository, rather than the link for downloading the SDK. After downloading the SDK by using the Maven repository, integrate it into your project. For details, please refer to Integrating the Drive SDK and HMS SDK.

Open source software notice: For details, please refer to the HuaweiDriveSDK 4.0.3.300 Open Source Software Notice.

HMS SDK 4.0.1.300

IDE: Android Studio

Integration mode: Gradle + Maven

Maven repository: https://developer.huawei.com/repo/

Note: This is the link to the Maven repository, rather than the link for downloading the SDK. After downloading the SDK by using the Maven repository, integrate it into your project. For details, please refer to Integrating the Drive SDK and HMS SDK.

2.2 Integrating the Drive SDK and HMS SDK

If you are using Android Studio, you can integrate your Drive SDK and HMS SDK by using the Maven repository. Before you start developing an app, integrate both the Drive SDK and HMS SDK into your Android Studio first.

1.  Add the AppGallery Connect configuration file of the app to your Android Studio.

a.  Sign in to AppGallery Connect and select My projects.

b.  Find your project from the project list and click the app on the project card.

c.  On the Project Setting page, click agconnect-services.json to download the configuration file.

d.  Copy the agconnect-services.json file to the app root directory.

2.  Configure the Maven repository address for the HMS SDK.

a.  Open the build.gradle file in the root directory of your Android Studio project.

b.  Go to allprojects > repositories and configure the Maven repository address for the HMS SDK.

  1. allprojects{
  2.     repositories {
  3.           maven {url 'https://developer.huawei.com/repo/'}
  4.      }
  5. }

c.         Go to buildscript > repositories and configure the Maven repository address for the HMS SDK.

  1. buildscript{
  2.      repositories {
  3.           maven {url 'https://developer.huawei.com/repo/'}
  4.      }
  5. }

d.         Go to buildscript > dependencies and add dependency configurations.

  1. buildscript {
  2.     dependencies {
  3.         classpath 'com.huawei.agconnect:agcp:1.2.1.301'
  4.     }
  5. }
NOTE：
The Maven repository address cannot be accessed from a browser. It can only be configured in the IDE.

3.  Add build dependencies.

a.  Open the build.gradle file in the app directory.

b.  Add the AppGallery Connect plug-in dependency to the end of the file header.

  1. apply plugin: 'com.huawei.agconnect'

c.  Configure build dependencies.

  1. dependencies {
  2.     implementation 'com.huawei.hms:drive:{version}'
  3.     implementation 'com.huawei.hms:hwid:{version}'
  4.     implementation 'com.huawei.hms:push:{version}'
  5. }

Note: Replace {version} with the actual SDK version number, for example:

  1. implementation 'com.huawei.hms:drive:4.0.3.300'
  2. implementation 'com.huawei.hms:hwid:4.0.1.300'
  3. implementation 'com.huawei.hms:push:4.0.1.300'
NOTE：
To use HUAWEI Drive Kit, you must also integrate HUAWEI Account Kit and HUAWEI Push Kit.

4.  Open the modified build.gradle file. You will find a Sync Now link in the upper right corner of the page. Click Sync Now and wait until synchronization is complete.

NOTE：
If an error occurs, check the network connection and the configurations in the gradle file.

5.  Define multi-language settings.

● By default, your app supports all languages provided by the HMS SDK.If your app uses all these languages, skip the operation procedure in this section.

● If your app uses only some of these languages, follow the operation procedure in this section to complete the required configuration.

Open the build.gradle file in the app directory of your project.

Go to android > defaultConfig and add the resConfigs configuration. en (English) and zh-rCN (Simplified Chinese) are mandatory languages. If your app only supports English and Simplified Chinese, the configuration is as follows:

  1. android {
  2.     defaultConfig {
  3.         ...
  4.         resConfigs "en", "zh-rCN"
  5.     }
  6. }  

For details about the languages supported by the HMS SDK, please refer to Languages Supported by the HMS SDK.

2.3 Configuring Obfuscation Scripts

Before building the APK, configure obfuscation scripts to prevent the HMS SDK from being obfuscated. If obfuscation arises, the HMS SDK may not function properly.

1.  Open the obfuscation script file of your project.

2.  Add configurations to exclude the HMS SDK from obfuscation.

  1. -ignorewarnings
  2. -keepattributes *Annotation*
  3. -keepattributes Exceptions
  4. -keepattributes InnerClasses
  5. -keepattributes Signature
  6. -keepattributes SourceFile,LineNumberTable
  7. -keep class com.hianalytics.android.**{*;}
  8. -keep class com.huawei.updatesdk.**{*;}
  9. -keep class com.huawei.hms.**{*;}
  10. -keep class com.huawei.cloud.services.drive.**{*;}

3.  If you have used AndResGuard, add it to the whitelist in the obfuscation script file.

  1. "R.string.hms*",
  2. "R.string.connect_server_fail_prompt_toast",
  3. "R.string.getting_message_fail_prompt_toast",
  4. "R.string.no_available_network_prompt_toast",
  5. "R.string.third_app_*",
  6. "R.string.upsdk_*",
  7. "R.layout.hms*",
  8. "R.layout.upsdk_*",
  9. "R.drawable.upsdk*",
  10. "R.color.upsdk*",
  11. "R.dimen.upsdk*",
  12. "R.style.upsdk*",
  13. "R.string.agc*"

3 Preparing for Server Development

3.1 Integrating the HMS SDK

If you are using Android Studio, you can integrate your HMS SDK by using the Maven repository. Before you start developing an app, integrate the HMS SDK into your Android Studio first.

1.  Add the AppGallery Connect configuration file of the app to your Android Studio.

a.  Sign in to AppGallery Connect and select My projects.

b.  Find your project from the project list and click the app on the project card.

d.  On the Project Setting page, click agconnect-services.json to download the configuration file.

e.  Copy the agconnect-services.json file to the app root directory.

2.  Configure the Maven repository address for the HMS SDK.

a.  Open the build.gradle file in the root directory of your Android Studio project.

b.  Go to allprojects > repositories and configure the Maven repository address for the HMS SDK.

  1. allprojects{
  2.     repositories {
  3.           maven {url 'https://developer.huawei.com/repo/'}
  4.      }
  5. }

c.  Go to buildscript > repositories and configure the Maven repository address for the HMS SDK.

  1. buildscript{
  2.      repositories {
  3.           maven {url 'https://developer.huawei.com/repo/'}
  4.      }
  5. }

d.  Go to buildscript > dependencies and add dependency configurations.

  1. buildscript {
  2.     dependencies {
  3.         classpath 'com.huawei.agconnect:agcp:1.2.1.301'
  4.     }
  5. }

NOTE：
The Maven repository address cannot be accessed from a browser. It can only be configured in the IDE.

3.  Add build dependencies.

a.  Open the build.gradle file in the app directory.

b.  Add the AppGallery Connect plug-in dependency to the end of the file header.

  1. apply plugin: 'com.huawei.agconnect'

c.  Configure build dependencies.

  1. dependencies {
  2.     implementation 'com.huawei.hms:hwid:{version}'
  3.     implementation 'com.huawei.hms:push:{version}'
  4. }

Note: Replace {version} with the actual SDK version number, for example:

  1. implementation 'com.huawei.hms:hwid:4.0.1.300'
  2. implementation 'com.huawei.hms:push:4.0.1.300'

NOTE：
To use HUAWEI Drive Kit, you must also integrate HUAWEI Account Kit and HUAWEI Push Kit.

4.  Open the modified build.gradle file again. You will find a Sync Now link in the upper right corner of the page. Click Sync Now and wait until synchronization is complete.

NOTE：
If an error occurs, check the network connection and the configurations in the gradle file.

5.  Define multi-language settings.

● By default, your app supports all languages provided by the HMS SDK.If your app uses all these languages, skip the operation procedure in this section.

● If your app uses only some of these languages, follow the operation procedure in this section to complete the required configuration.

Open the build.gradle file in the app directory of your project.

Go to android > defaultConfig and add the resConfigs configuration. en (English) and zh-rCN (Simplified Chinese) are mandatory languages. If your app only supports English and Simplified Chinese, the configuration is as follows:

  1. android {
  2.     defaultConfig {
  3.         ...
  4.         resConfigs "en", "zh-rCN"
  5.     }
  6. }

For details about the languages supported by the HMS SDK, please refer to Languages Supported by the HMS SDK.

3.2 Configuring Obfuscation Scripts

Before building the APK, configure obfuscation scripts to prevent the HMS SDK from being obfuscated. If obfuscation arises, the HMS SDK may not function properly.

1.  Open the obfuscation script file of your project.

2.  Add configurations to exclude the HMS SDK from obfuscation.

  1. -ignorewarnings
  2. -keepattributes *Annotation*
  3. -keepattributes Exceptions
  4. -keepattributes InnerClasses
  5. -keepattributes Signature
  6. -keepattributes SourceFile,LineNumberTable
  7. -keep class com.hianalytics.android.**{*;}
  8. -keep class com.huawei.updatesdk.**{*;}
  9. -keep class com.huawei.hms.**{*;}
  10. -keep class com.huawei.cloud.base.** {*;}
  11. -keep class com.huawei.cloud.client.** {*;}

3.  If you have used AndResGuard, add it to the whitelist in the obfuscation script file.

  1. "R.string.hms*",
  2. "R.string.connect_server_fail_prompt_toast",
  3. "R.string.getting_message_fail_prompt_toast",
  4. "R.string.no_available_network_prompt_toast",
  5. "R.string.third_app_*",
  6. "R.string.upsdk_*",
  7. "R.layout.hms*",
  8. "R.layout.upsdk_*",
  9. "R.drawable.upsdk*",
  10. "R.color.upsdk*",
  11. "R.dimen.upsdk*",
  12. "R.style.upsdk*", 
  13. "R.string.agc*"