1. Development Process

2. Pre-development Procedure

1.If you do not have a HUAWEI ID, register one on Huawei Developer and complete real-name authentication. For details, see Registering as a Developer.

2.Sign in to AppGallery Connect using the applied Huawei ID and create an app. Ensure that Package type is set to APK (Android app). For details, see Creating an App.

3.Enable HUAWEI Analytics Kit:

a. Sign in to AppGallery Connect, and click Analytics. Select the app you created, and click the Advanced Analysis tab. On the page that is displayed, click Enable Analytics service.

b. Select an app for which you need to view analytics data.

c. Enable HUAWEI Analytics Kit. For details, please refer to Enabling Services.

d. On the Project access settings page, set the data storage location, time zone, currency, user data storage time, and calendar week, and click Finish.

3. Integrating the Android SDK

The React-Native SDK depends on the Android SDK. Therefore, the Android SDK must be integrated first.

3.1 Integrating the Android SDK into Android Studio

1.Import the android directory in the root directory of the React-Native project to Android Studio. Android Studio automatically identifies the directory as an Android project.Add the AppGallery Connect configuration file of the current app to your Android Studio project.

a. Sign in to AppGallery Connect and select My apps.
b. Find your app from the list, and click the link under Android App in the Mobile phone column.

c. Go to Develop > Overview.

d. In the App information area, Click agconnect-services.json to download the configuration file.

e. In your Android Studio project, switch to the Project view and move the agconnect-services.json file obtained from AppGallery Connect to the app directory.

2.Add the Maven repository address and AppGallery Connect service dependencies in the build.gradle file of your project.

maven {url 'https://developer.huawei.com/repo/'}
classpath 'com.huawei.agconnect:agcp:1.2.1.301'

3.Add the plug-in configuration and SDK version in the build.gradle file in the app directory.

apply plugin: 'com.huawei.agconnect'
implementation 'com.huawei.hms:hianalytics:4.0.1.300'

4.Click Sync now or Sync Project with Gradle Files to build a project.

3.2 Integrating the Android SDK into Eclipse

Please refer to Integrating the SDK into Your App Project in the Eclipse IDE for the Eclipse configuration.

4.Integrating the React-Native SDK

1. Download the React-Native HA SDK package.

2. Copy the downloaded software package to the node-modules directory in the React-Native project directory.

3. Run the following command in the root directory of the React-Native project:

yarn add {project_path}/node_modules/react-native-ha-interface

In the command, {project_path} is the path of the React-Native project.

4. Check whether the SDK is successfully added to the package.json file in the root directory of the React-Native project file.

5. Automatically Collected Event:

Run the React-Native app and check whether the automatically collected event can be properly reported in the Real-time analysis menu on the Advanced analysis page in HUAWEI Developer.

6. Custom Events:

①Import the Reactive-Native HA SDK to the app.js file in the root directory of the Reactive-Native project file, compile the haOnEvent function to call the onEvent API of the SDK, and call the function.

import haSDK from 'react-native-ha-interface';
function haOnEvent(){
  const eventObj={
    testString:'StrContent',
    testInt:20,
    testDouble:2.2,
    testBoolean:false
  }
  haSDK.onEvent('newTestEvent',eventObj);
}
……
componentDidMount(){
  haSDK.onEvent();
}

②Run the React-Native app and check whether the custom event can be properly reported in the Real-time analysis menu on the Advanced analysis page in HUAWEI Developer.

5. SDK Permissions

HUAWEI Analytics Kit requires the following permissions, which have been preset in HUAWEI Analytics Kit. You do not need to apply for permissions.

    <!--Network permission -->
    <uses-permission android:name="android.permission.INTERNET" />
    ＜!-- Check the network status. --＞
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!--AppGallery channel number query permission. -->
    <uses-permission android:name="com.huawei.appmarket.service.commondata.permission.GET_COMMON_DATA" />

6. Configuring Obfuscation Scripts

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

The configuration file in Android Studio is proguard-rules.pro, and that in Eclipse is proguard-project.txt.

1.Open the obfuscation configuration file of the Android project.

2.Add configurations to exclude HUAWEI Analytics Kit from obfuscation.

-keep class com.hianalytics.android.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}
-keep interface com.huawei.hms.analytics.type.HAEventType{*;}
-keep interface com.huawei.hms.analytics.type.HAParamType{*;}
-keep class com.huawei.hianalytics.CommonUtil{*;}
-keep class com.huawei.hianalytics.HaInterfaceModule{*;}
-keep class com.huawei.hianalytics.HaInterfacePackage{*;}
-keep class com.huawei.hianalytics.HaSdkInitProvider{*;}
-keep class com.huawei.hianalytics.LifeCycleListener{*;}

7. Accessing HUAWEI Analytics Kit

HUAWEI Analytics Kit is based on the event analytics data model.

The analytics data model uses the Event-Param-User model to record data, describes events using parameters, and describes the characteristics of users.

HUAWEI Analytics Kit collects the AAID that is allocated by the HMS Instance ID to each app instance installed on the device. The AAID is used for connecting various Huawei services, such as HUAWEI PUSH Kit, HUAWEI Analytics Kit, and remote configurations.

The AAID will be reset in the following scenarios:

• The user uninstalls or reinstalls the app.

• The user restores the device to its factory settings.

• The user clears the app data.

• The app calls the clearCachedData API.

1.Import the HMS Core Analytics SDK.

2.Record defined events using the onEvent API. For definitions of the events, please refer to Appendix A: Event Description.

3.Implement analytics functions by calling the APIs described in API Indexes. For example, call the setUserProfile API to set user attributes.

7.1 Sample Code

1.After the agconnect-services.json file is successfully imported, import the SDK object to the app.js file. If the agconnect-services.json file is incorrect, data cannot be collected at specified tracing points.

import haSDK from 'react-native-ha-interface';

2.Insert tracing points in proper positions of the code.

// Compile the haOnEvent function to call the onEvent API in the SDK.
// eventObj is the parameter object contained in the custom event that you want to upload. The parameter can be of the string, number, and bool types.
function haOnEvent(){
  const eventObj={
    testString:'StrContent',
    testInt:20,
    testDouble:2.2,
    testBoolean:false
  }
  haSDK.onEvent('newTestEvent',eventObj);
}
export default class TestApp extends Component {
  componentDidMount(){
// Call the haOnEvent function in the code for event reporting.
      haOnEvent();
  }
  render() {
      return (
          <View>
          <Text>"Hello World"</Text>
          </View>
      );
  }
}

7.2 Access Debugging

During the development, you can enable the debug mode to view the event records in real time, observe the results, and adjust the event tracing scheme.

7.2.1  Enabling/Disabling the Debug Mode

1.Run the following command on an Android device to enable the debug mode:

adb shell setprop debug.huawei.hms.analytics.app <package_name>

After the debug mode is enabled, all events are reported in real time.

2.To disable the debug mode, run the following command:

adb shell setprop debug.huawei.hms.analytics.app .none.

Successfully reported data will be displayed in Huawei Developer, as shown in the following figure.

For details about how to view data on Huawei Developer, please refer to “App Debugging” in the Analytics Kit User Guide.

8. Appendix A: Event Description

8.1 Automatically Collected Event

Event IDs of automatically collected events are reserved by HUAWEI Analytics Kit and cannot be reused.

8.2 Preset Events

HUAWEI Analytics Kit predefines some event IDs based on common application scenarios. It is recommended that predefined constants be used for event tracing and analytics. Based on preset events, you can customize various insight reports.

Preset events and parameters are reserved for HUAWEI Analytics Kit. The ID of a custom event cannot be the same as that of a preset event. Otherwise, the custom event will be identified as a preset event.

8.2.1 Preset Event Example

The following is an example of reporting an Add To Wishlist event.

import haSDK from 'react-native-ha-interface';
const eventObj={
  PRODUCTID:'item_ID',
  PRODUCTNAME:'name',
  CATEGORY:'category',
  QUANTITY:100,
  PRICE:10.01,
  REVENUE:10,
  CURRNAME:'currency',
  PLACEID:'location_ID'
}
haSDK.onEvent(hasdk.ADDPRODUCT2WISHLIST,eventObj);

8.2.2 Preset Event ID List

8.2.3 Preset Event Parameter List

1. CREATEPAYMENTINFO

This event is reported when a user has added payment information but has not initiated payment during checkout. 

It can be used with STARTCHECKOUT and COMPLETEPURCHASE to construct funnel analysis for the checkout process.

2.  ADDPRODUCT2CART

This event is reported when a user adds a product to the shopping cart. 

It can be used with VIEWPRODUCT and STARTCHECKOUT to construct funnel analysis for product purchase. This event can also be used to analyze developers' products that users are interested in, enabling developers to promote the products to the users.

3. ADDPRODUCT2WISHLIST

This event is reported when a user adds a product to favorites. 

It can be used to analyze developers' products that users are interested in, enabling developers to promote the products to the users.

4. STARTAPP

This event is reported when a user opens the app. 

5. STARTCHECKOUT

This event is reported when a user taps the checkout button after placing an order. It can be used with events such as VIEWPRODUCt and COMPLETEPURCHASE to analyze the e-commerce purchase conversion rate.

6. VIEWCAMPAIGN

This event is reported when a user view details of a marketing activity. It can be used to analyze the conversion rate of a marketing activity.

7. VIEWCHECKOUTSTEP

This event is reported after each step in the multi-step checkout process is completed. It can be used to analyze the conversion rate of each step in the checkout process, supporting product design optimization.

8. WINVIRTUALCOIN

This event is reported when a user obtains virtual currency. It can be used to analyze the difficulty for users to obtain virtual currency, supporting product design optimization.

9. COMPLETEPURCHASE

This event is reported after a user purchases a product. It can be used to analyze the products or contents that users are more interested in, supporting operations policy optimization.

10. OBTAINLEADS

This event is reported when a sales lead is obtained. For example, it can be reported after a user touches the ad placed by a developer and fills in and submits the contact information. In this case, the event is used to evaluate the possible revenue brought by the lead to developers. In addition, the event can also be used to evaluate the ROI of the placed ad.

11. JOINUSERGROUP

This event is reported when a user joins in a group, for example, joining in a group chart in a social app. It can be used to evaluate the attractiveness of a product's social features to users.

12. STARTLEVEL

This event is reported when a user starts a game level in a game app. It can be used with COMPLETELEVEL to analyze whether the game level design is optimal and make targeted optimization policies.

13. COMPLETELEVEL

This event is reported when a user completes a game level in a game app. It can be used with STARTLEVEL to analyze whether the game level design is optimal and make targeted optimization policies.

14. UPGRADELEVEL

This event is reported when a user levels up in a game app. It can be used to analyze whether the product's user level design is optimal and make targeted optimization policies.

15. SIGNIN

This event is reported when a user signs in to an app requiring sign-in. It can be used to analyze users' sign-in habits and make targeted operations policies.

16. SUBMITSCORE

This event is reported when a user submits the score in a game or education app. It can be used to analyze the difficulty of product content and make targeted optimization policies.

17. CREATEORDER

This event is reported when the order details are displayed before checkout. It can be used with events such as VIEWPRODUCT and COMPLETEPURCHASE to construct an analysis funnel for analyzing user churn in each phase and make optimization policies. 

18. REFUNDORDER

This event is reported when the refund is successful for a user. It can be used to analyze loss caused by the refund and make targeted optimization policies.

19. DELPRODUCTFROMCART

This event is reported when a user removes a product from the shopping cart. It can be used for marketing to the user.

20. SEARCH

This event is reported when a user searches for content in an app. It can be used with events such as VIEWSEARCHRESULT and VIEWPRODUCT to analyze the accuracy of search results.

21. VIEWCONTENT

This event is reported when a user touches a content, for example, touching a product in the product list in an e-commerce app to view the product details. It can be used to analyze the products that users are interested in.

22. UPDATECHECKOUTOPTION

This event is reported when a user sets some checkout options during checkout. It can be used to analyze checkout preferences of users.

23. SHARECONTENT

This event is reported when a user shares a product or content through a social channel. It can be used to analyze users' loyalty to the product.

24. REGISTERACCOUNT

This event is reported when a user registers an account. It can be used to analyze the user sources and optimize operations policies.

25. CONSUMEVIRTUALCOIN

This event is reported when a user consumes virtual currency. It can be used to analyze the products that users are interested in.

26. STARTTUTORIAL

This event is reported when a user starts to use the tutorial. It can be used with COMPLETETUTORIAL to evaluate the tutorial quality and formulate targeted optimization measures.

27. COMPLETETUTORIAL

This event is reported when a user completes the tutorial. It can be used with STARTTUTORIAL to evaluate the tutorial quality and formulate targeted optimization measures.

28. OBTAINAHIVEMENT

This event is reported when a user unlocks an achievement. It can be used to analyze whether the achievement level design is optimal and make targeted optimization policies.

29. VIEWPRODUCT

This event is reported when a user browses a product. It can be used to analyze the products that users are interested in, or used with other events for funnel analysis. 

30. VIEWPRODUCTLIST

This event is reported when a user browses a list of products, for example, browsing the list of products by category. It can be used to analyze the types of contents that users are more interested in.

31. VIEWSEARCHRESULT

This event is reported when a user views the search results. It can be used with VIEWPRODUCT and SEARCH to measure the accuracy of the search algorithm.

8.3 Custom Events 

Developers may need personalized events for tracing and analytics. HUAWEI Analytics Kit allows developers to customize events and extend event parameters, or add personalized parameters for predefined events.

For example, you can add custom event begin _examination to indicate the event of entering a new exam and add the exam_difficulty parameter to define the exam difficulty, to meet analysis requirements of specific service scenarios.

The following is an example of a custom event.

 const eventObj={
    begin_examination:'high',
    exam_level:'1-1',
    exam_time:'20190520-08'
  }
  haSDK.onEvent('begin_examination',eventObj);
  }